AWS::VpcLattice::Service - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::VpcLattice::Service

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::VpcLattice::Service",
  "Properties" : {
      "AuthType" : String,
      "CertificateArn" : String,
      "CustomDomainName" : String,
      "DnsEntry" : DnsEntry,
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::VpcLattice::Service
Properties:
  AuthType: String
  CertificateArn: String
  CustomDomainName: String
  DnsEntry: 
    DnsEntry
  Name: String
  Tags: 
    - Tag

Properties

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.

Required: No

Type: String

Allowed values: NONE | AWS_IAM

Update requires: No interruption

CertificateArn

The Amazon Resource Name (ARN) of the certificate.

Required: No

Type: String

Pattern: ^(arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:certificate/[0-9a-z-]+)?$

Maximum: 2048

Update requires: No interruption

CustomDomainName

The custom domain name of the service.

Required: No

Type: String

Minimum: 3

Maximum: 255

Update requires: Replacement

DnsEntry

Describes the DNS information of the service. This field is read-only.

Required: No

Type: DnsEntry

Update requires: No interruption

Name

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.

If you don't specify a name, CloudFormation generates one. However, if you specify a name, and later want to replace the resource, you must specify a new name.

Required: No

Type: String

Pattern: ^(?!svc-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Minimum: 3

Maximum: 40

Update requires: Replacement

Tags

The tags for the service.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Resource Name (ARN) of the service.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the service.

CreatedAt

The date and time that the service was created, specified in ISO-8601 format.

DnsEntry.DomainName

The domain name of the service.

DnsEntry.HostedZoneId

The ID of the hosted zone.

Id

The ID of the service.

LastUpdatedAt

The date and time that the service was last updated, specified in ISO-8601 format.

Status

The status of the service.