AWS::DataZone::SubscriptionTarget - AWS CloudFormation (original) (raw)

The AWS::DataZone::SubscriptionTargetresource specifies an Amazon DataZone subscription target. Subscription targets enable you to access the data to which you have subscribed in your projects. A subscription target specifies the location (for example, a database or a schema) and the required permissions (for example, an IAM role) that Amazon DataZone can use to establish a connection with the source data and to create the necessary grants so that members of the Amazon DataZone project can start querying the data to which they have subscribed.

Syntax

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

JSON

{
  "Type" : "AWS::DataZone::SubscriptionTarget",
  "Properties" : {
      "ApplicableAssetTypes" : [ String, ... ],
      "AuthorizedPrincipals" : [ String, ... ],
      "DomainIdentifier" : String,
      "EnvironmentIdentifier" : String,
      "ManageAccessRole" : String,
      "Name" : String,
      "Provider" : String,
      "SubscriptionTargetConfig" : [ SubscriptionTargetForm, ... ],
      "Type" : String
    }
}

Properties

ApplicableAssetTypes

The asset types included in the subscription target.

Required: Yes

Type: Array of String

Minimum: 1

Maximum: 256

Update requires: No interruption

The authorized principals included in the subscription target.

Required: Yes

Type: Array of String

Minimum: 1

Maximum: 10

Update requires: No interruption

DomainIdentifier

The ID of the Amazon DataZone domain in which subscription target is created.

Required: Yes

Type: String

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Update requires: Replacement

EnvironmentIdentifier

The ID of the environment in which subscription target is created.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Update requires: Replacement

ManageAccessRole

The manage access role that is used to create the subscription target.

Required: No

Type: String

Update requires: No interruption

Name

The name of the subscription target.

Required: Yes

Type: String

Minimum: 1

Maximum: 256

Update requires: No interruption

Provider

The provider of the subscription target.

Required: No

Type: String

Update requires: No interruption

SubscriptionTargetConfig

The configuration of the subscription target.

Required: Yes

Type: Array of SubscriptionTargetForm

Update requires: No interruption

Type

The type of the subscription target.

Required: Yes

Type: String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns a string containing pipe-separated DomainId,EnvironmentId and the SubscriptionTargetId that uniquely identify the subscription target. For example: { "Ref": "MySubscriptionTarget" } for the resource with the logical ID MySubscriptionTarget,Ref returns DomainId|EnvironmentId|SubscriptionTargetId.

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.

CreatedAt

The timestamp of when the subscription target was created.

CreatedBy

The Amazon DataZone user who created the subscription target.

DomainId

The identifier of the Amazon DataZone domain in which the subscription target exists.

EnvironmentId

The identifier of the environment of the subscription target.

Id

The identifier of the subscription target.

ProjectId

The identifier of the project specified in the subscription target.

UpdatedAt

The timestamp of when the subscription target was updated.

UpdatedBy

The Amazon DataZone user who updated the subscription target.