AWS::VpcLattice::ResourceConfiguration - AWS CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

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

AWS::VpcLattice::ResourceConfiguration

Creates a resource configuration. A resource configuration defines a specific resource. You can associate a resource configuration with a service network or a VPC endpoint.

Syntax

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

JSON

{
  "Type" : "AWS::VpcLattice::ResourceConfiguration",
  "Properties" : {
      "AllowAssociationToSharableServiceNetwork" : Boolean,
      "CustomDomainName" : String,
      "DomainVerificationId" : String,
      "GroupDomain" : String,
      "Name" : String,
      "PortRanges" : [ String, ... ],
      "ProtocolType" : String,
      "ResourceConfigurationAuthType" : String,
      "ResourceConfigurationDefinition" : ResourceConfigurationDefinition,
      "ResourceConfigurationGroupId" : String,
      "ResourceConfigurationType" : String,
      "ResourceGatewayId" : String,
      "Tags" : [ Tag, ... ]
    }
}

Properties

AllowAssociationToSharableServiceNetwork

Specifies whether the resource configuration can be associated with a sharable service network.

Required: No

Type: Boolean

Update requires: No interruption

CustomDomainName

The custom domain name.

Required: No

Type: String

Minimum: 3

Maximum: 255

Update requires: Replacement

DomainVerificationId

The domain verification ID.

Required: No

Type: String

Pattern: ^dv-[a-fA-F0-9]{17}$

Minimum: 20

Maximum: 20

Update requires: Replacement

GroupDomain

(GROUP) The group domain for a group resource configuration. Any domains that you create for the child resource are subdomains of the group domain. Child resources inherit the verification status of the domain.

Required: No

Type: String

Minimum: 3

Maximum: 255

Update requires: Replacement

Name

The name of the resource configuration.

Required: Yes

Type: String

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

Minimum: 3

Maximum: 40

Update requires: No interruption

PortRanges

(SINGLE, GROUP, CHILD, CIDR) The port ranges that a consumer can use to access a resource configuration (for example: 1-65535). You can separate port ranges using commas (for example: 1,2,22-30). To resolve DNS through a CIDR resource configuration, include port 53 in the port ranges.

Required: No

Type: Array of String

Update requires: No interruption

ProtocolType

(SINGLE, GROUP, CIDR) The protocol accepted by the resource configuration. The default is TCP. TCP_UDP is supported only for CIDR resource configurations; specify it for a CIDR resource configuration to allow DNS resolution, which uses UDP.

Required: No

Type: String

Allowed values: TCP

Update requires: Replacement

ResourceConfigurationAuthType

The auth type for the resource configuration.

Required: No

Type: String

Allowed values: NONE | AWS_IAM

Update requires: Replacement

ResourceConfigurationDefinition

Identifies the resource configuration in one of the following ways:

  • Amazon Resource Name (ARN) - Supported resource-types that are provisioned by AWS services, such as RDS databases, can be identified by their ARN.

  • Domain name - Any domain name that is publicly resolvable.

  • IP address - For IPv4 and IPv6, only IP addresses in the VPC are supported.

  • CIDR range - For a resource configuration of type CIDR, specify a cidrResource with one or more cidrRanges (for example, 10.0.0.0/16) that cover the IP addresses of the resources you want to make accessible. You can specify up to 10 ranges, using IPv4, IPv6, or both, and each range must include a prefix length. To represent your entire network, specify 0.0.0.0/0 (IPv4) or ::/0 (IPv6) as the only range. You can't use reserved ranges such as 169.254.0.0/16, 100.64.0.0/10, 224.0.0.0/4, fe80::/10, or ff00::/8.

Required: No

Type: ResourceConfigurationDefinition

Update requires: No interruption

ResourceConfigurationGroupId

The ID of the group resource configuration.

Required: No

Type: String

Pattern: ^rcfg-[0-9a-z]{17}$

Minimum: 22

Maximum: 22

Update requires: No interruption

ResourceConfigurationType

The type of resource configuration. A resource configuration can be one of the following types:

  • SINGLE - A single resource.

  • GROUP - A group of resources. You must create a group resource configuration before you create a child resource configuration.

  • CHILD - A single resource that is part of a group resource configuration.

  • ARN - An AWS resource.

  • CIDR - A network segment, expressed as a range of IP addresses (a CIDR block). Use this type to share a portion of your network rather than an individual resource. A consumer accesses the resources within the CIDR range through a Tunnel VPC endpoint. You can't add a CIDR resource configuration to a service network. A CIDR resource configuration must be associated with a resource gateway whose DNS resolution is set to IN_VPC.

Required: Yes

Type: String

Allowed values: GROUP | CHILD | SINGLE | ARN | CIDR

Update requires: Replacement

ResourceGatewayId

The ID of the resource gateway.

Required: No

Type: String

Update requires: Replacement

Tags

The tags for the resource configuration.

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 resource configuration.

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 resource configuration.

Id

The ID of the resource configuration.