Skip to content

Create Service

vpclattice_create_service R Documentation

Creates a service

Description

Creates a service. A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).

For more information, see Services in the Amazon VPC Lattice User Guide.

Usage

vpclattice_create_service(authType, certificateArn, clientToken,
  customDomainName, name, tags)

Arguments

authType

The type of IAM policy.

  • NONE: The resource does not use an IAM policy. This is the default.

  • AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

certificateArn

The Amazon Resource Name (ARN) of the certificate.

clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

customDomainName

The custom domain name of the service.

name

[required] The name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

tags

The tags for the service.

Value

A list with the following syntax: 

list(
  arn = "string",
  authType = "NONE"|"AWS_IAM",
  certificateArn = "string",
  customDomainName = "string",
  dnsEntry = list(
    domainName = "string",
    hostedZoneId = "string"
  ),
  id = "string",
  name = "string",
  status = "ACTIVE"|"CREATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"CREATE_FAILED"|"DELETE_FAILED"
)

Request syntax

svc$create_service(
  authType = "NONE"|"AWS_IAM",
  certificateArn = "string",
  clientToken = "string",
  customDomainName = "string",
  name = "string",
  tags = list(
    "string"
  )
)