AWS::Connect::DataLakeAssociation

Associates the specified dataset for a Amazon Connect Customer instance with the target account. You can associate only one dataset in a single resource.

Syntax

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

JSON

{
  "Type" : "AWS::Connect::DataLakeAssociation",
  "Properties" : {
      "DataSetId" : String,
      "InstanceId" : String,
      "TargetAccountId" : String
    }
}

YAML

Type: AWS::Connect::DataLakeAssociation
Properties:
  DataSetId: String
  InstanceId: String
  TargetAccountId: String

Properties

DataSetId

The identifier of the dataset to associate with the target account.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

InstanceId

The identifier of the Amazon Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Required: Yes

Type: String

Pattern: ^[-a-zA-Z0-9]*$

Minimum: 1

Maximum: 100

Update requires: Replacement

TargetAccountId

The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect Customer instance. If not specified, by default this value is the AWS account that has the Amazon Connect Customer instance.

Required: No

Type: String

Pattern: ^\d+$

Minimum: 12

Maximum: 12

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the composite identifier of the data lake association in the format InstanceId|DataSetId|TargetAccountId. 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.

ResourceShareArn

The Amazon Resource Name (ARN) of the AWS Resource Access Manager share.

ResourceShareId

The AWS Resource Access Manager share ID that is generated.