AWS::VpcLattice::ServiceNetwork - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::VpcLattice::ServiceNetwork

Creates a service network. A service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.

For more information, see Service networks 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::ServiceNetwork",
  "Properties" : {
      "AuthType" : String,
      "Name" : String,
      "SharingConfig" : SharingConfig,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::VpcLattice::ServiceNetwork
Properties:
  AuthType: String
  Name: String
  SharingConfig: 
    SharingConfig
  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

Name

The name of the service network. The name must be unique to 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: ^(?!servicenetwork-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$

Minimum: 3

Maximum: 63

Update requires: Replacement

SharingConfig

Specify if the service network should be enabled for sharing.

Required: No

Type: SharingConfig

Update requires: No interruption

Tags

The tags for the service network.

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 network.

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 network.

CreatedAt

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

Id

The ID of the service network.

LastUpdatedAt

The date and time of the last update, specified in ISO-8601 format.