AWS::CleanRooms::IdMappingTable - 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::CleanRooms::IdMappingTable

Describes information about the ID mapping table.

Syntax

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

JSON

{
  "Type" : "AWS::CleanRooms::IdMappingTable",
  "Properties" : {
      "Description" : String,
      "InputReferenceConfig" : IdMappingTableInputReferenceConfig,
      "KmsKeyArn" : String,
      "MembershipIdentifier" : String,
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::CleanRooms::IdMappingTable
Properties:
  Description: String
  InputReferenceConfig: 
    IdMappingTableInputReferenceConfig
  KmsKeyArn: String
  MembershipIdentifier: String
  Name: String
  Tags: 
    - Tag

Properties

Description

The description of the ID mapping table.

Required: No

Type: String

Pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*$

Maximum: 255

Update requires: No interruption

InputReferenceConfig

The input reference configuration for the ID mapping table.

Required: Yes

Type: IdMappingTableInputReferenceConfig

Update requires: Replacement

KmsKeyArn

The Amazon Resource Name (ARN) of the AWS KMS key.

Required: No

Type: String

Minimum: 4

Maximum: 2048

Update requires: No interruption

MembershipIdentifier

The unique identifier of the membership resource for the ID mapping table.

Required: Yes

Type: String

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Minimum: 36

Maximum: 36

Update requires: Replacement

Name

The name of the ID mapping table.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$

Maximum: 128

Update requires: Replacement

Tags

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource name. For example:

{"Ref": "MyIdMappingTable"}

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 ID mapping table.

CollaborationArn

The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.

CollaborationIdentifier

The unique identifier of the collaboration that contains this ID mapping table.

IdMappingTableIdentifier

The unique identifier of the ID mapping table identifier that you want to retrieve.

MembershipArn

The Amazon Resource Name (ARN) of the membership resource for the ID mapping table.