AWS::CleanRooms::ConfiguredTableAssociation - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

AWS::CleanRooms::ConfiguredTableAssociation

Creates a configured table association. A configured table association links a configured table with a collaboration.

Syntax

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

JSON

{
  "Type" : "AWS::CleanRooms::ConfiguredTableAssociation",
  "Properties" : {
      "ConfiguredTableIdentifier" : String,
      "Description" : String,
      "MembershipIdentifier" : String,
      "Name" : String,
      "RoleArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::CleanRooms::ConfiguredTableAssociation
Properties:
  ConfiguredTableIdentifier: String
  Description: String
  MembershipIdentifier: String
  Name: String
  RoleArn: String
  Tags: 
    - Tag

Properties

ConfiguredTableIdentifier

A unique identifier for the configured table to be associated to. Currently accepts a configured table ID.

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

Description

A description of the configured table association.

Required: No

Type: String

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

Maximum: 255

Update requires: No interruption

MembershipIdentifier

The unique ID for the membership this configured table association belongs to.

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 configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data.

Required: Yes

Type: String

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

Maximum: 128

Update requires: Replacement

RoleArn

The service will assume this role to access catalog metadata and query the table.

Required: Yes

Type: String

Minimum: 32

Maximum: 512

Update requires: No interruption

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 ConfiguredTableAssociation and the ID of the Membership. For example: c1baf760-935e-4b2d-b36e-af8daaeb6e48|81a97460-2c40-46ce-a2fd-4ccda7398b2c

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

Returns the Amazon Resource Name (ARN) of the specified configured table association.

Example: arn:aws:cleanrooms:us-east-1:111122223333:configuredtable/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

ConfiguredTableAssociationIdentifier

Returns the unique identifier of the specified configured table association.

Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

Examples

A configured table association

The following is an example of a configured table association which associates a configured table to a collaboration.

JSON

"ExampleAssociation": {
  "Type" : "AWS::CleanRooms::ConfiguredTableAssociation",
  "Properties" : {
    "Name" : "Example Table",
    "Description" : "Example associated configured table",
    "ConfiguredTableIdentifier" : "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
    "MembershipIdentifier" : "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
    "RoleArn" : "arn:aws:iam::123456789012:role/service-role/cleanrooms-association-example"
  }
}

YAML

ExampleAssociation:
  Type: AWS::CleanRooms::ConfiguredTableAssociation
  Properties:
    Name: Example Table
    Description: Example associated configured table
    ConfiguredTableIdentifier: a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
    MembershipIdentifier: a1b2c3d4-5678-90ab-cdef-EXAMPLE33333
    RoleArn: arn:aws:iam::123456789012:role/service-role/cleanrooms-association-example