AWS::CleanRooms::IdNamespaceAssociation

Provides information to create the ID namespace association.

Syntax

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

JSON

{
  "Type" : "AWS::CleanRooms::IdNamespaceAssociation",
  "Properties" : {
      "Description" : String,
      "IdMappingConfig" : IdMappingConfig,
      "InputReferenceConfig" : IdNamespaceAssociationInputReferenceConfig,
      "MembershipIdentifier" : String,
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::CleanRooms::IdNamespaceAssociation
Properties:
  Description: String
  IdMappingConfig: 
    IdMappingConfig
  InputReferenceConfig: 
    IdNamespaceAssociationInputReferenceConfig
  MembershipIdentifier: String
  Name: String
  Tags: 
    - Tag

Properties

Description

The description of the ID namespace association.

Required: No

Type: String

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

Maximum: 255

Update requires: No interruption

IdMappingConfig

The configuration settings for the ID mapping table.

Required: No

Type: IdMappingConfig

Update requires: No interruption

InputReferenceConfig

The input reference configuration for the ID namespace association.

Required: Yes

Type: IdNamespaceAssociationInputReferenceConfig

Update requires: Replacement

MembershipIdentifier

The unique identifier of the membership that contains the ID namespace association.

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 this ID namespace association.

Required: Yes

Type: String

Pattern: ^(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*$

Minimum: 1

Maximum: 100

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 resource name. For example:

{"Ref": "MyIdNamespaceAssociation"}

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 namespace association.

CollaborationArn

The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association.

CollaborationIdentifier

The unique identifier of the collaboration that contains this ID namespace association.

IdNamespaceAssociationIdentifier

The unique identifier of the ID namespace association that you want to retrieve.

MembershipArn

The Amazon Resource Name (ARN) of the membership resource for this ID namespace association.