AWS::VpcLattice::ServiceNetworkServiceAssociation
Associates the specified service with the specified service network. For more information, see Manage service associations in the Amazon VPC Lattice User Guide.
You can't use this operation if the service and service network are already associated or if there is a disassociation or deletion in progress. If the association fails, you can retry the operation by deleting the association and recreating it.
You cannot associate a service and service network that are shared with a caller. The caller must own either the service or the service network.
As a result of this operation, the association is created in the service network account and the association owner account.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::VpcLattice::ServiceNetworkServiceAssociation", "Properties" : { "DnsEntry" :
DnsEntry
, "ServiceIdentifier" :String
, "ServiceNetworkIdentifier" :String
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::VpcLattice::ServiceNetworkServiceAssociation Properties: DnsEntry:
DnsEntry
ServiceIdentifier:String
ServiceNetworkIdentifier:String
Tags:- Tag
Properties
DnsEntry
-
The DNS information of the service.
Required: No
Type: DnsEntry
Update requires: No interruption
ServiceIdentifier
-
The ID or ARN of the service.
Required: No
Type: String
Pattern:
^((svc-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}))$
Minimum:
20
Maximum:
2048
Update requires: Replacement
ServiceNetworkIdentifier
-
The ID or ARN of the service network. You must use an ARN if the resources are in different accounts.
Required: No
Type: String
Pattern:
^((sn-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetwork/sn-[0-9a-z]{17}))$
Minimum:
20
Maximum:
2048
Update requires: Replacement
-
The tags for the association.
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 association.
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 association between the service network and the service.
CreatedAt
-
The date and time that the association 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 of the association between the service network and the service.
ServiceArn
-
The Amazon Resource Name (ARN) of the service.
ServiceId
-
The ID of the service.
ServiceName
-
The name of the service.
ServiceNetworkArn
-
The Amazon Resource Name (ARN) of the service network
ServiceNetworkId
-
The ID of the service network.
ServiceNetworkName
-
The name of the service network.
Status
-
The status of the association between the service network and the service.