AWS::DataZone::Connection - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::DataZone::Connection

In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

Syntax

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

JSON

{
  "Type" : "AWS::DataZone::Connection",
  "Properties" : {
      "AwsLocation" : AwsLocation,
      "Description" : String,
      "DomainIdentifier" : String,
      "EnableTrustedIdentityPropagation" : Boolean,
      "EnvironmentIdentifier" : String,
      "Name" : String,
      "ProjectIdentifier" : String,
      "Props" : ConnectionPropertiesInput,
      "Scope" : String
    }
}

YAML

Type: AWS::DataZone::Connection
Properties:
  AwsLocation: 
    AwsLocation
  Description: String
  DomainIdentifier: String
  EnableTrustedIdentityPropagation: Boolean
  EnvironmentIdentifier: String
  Name: String
  ProjectIdentifier: String
  Props: 
    ConnectionPropertiesInput
  Scope: String

Properties

AwsLocation

Property description not available.

Required: No

Type: AwsLocation

Update requires: No interruption

Description

The description of the AWS Glue connection.

Required: No

Type: String

Pattern: ^[\S\s]*$

Maximum: 128

Update requires: No interruption

DomainIdentifier

Property description not available.

Required: Yes

Type: String

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

Update requires: Replacement

EnableTrustedIdentityPropagation

Property description not available.

Required: No

Type: Boolean

Update requires: Replacement

EnvironmentIdentifier

Property description not available.

Required: No

Type: String

Update requires: Replacement

Name

The connection name.

Required: Yes

Type: String

Pattern: ^[\w][\w\.\-\_]*$

Maximum: 64

Update requires: Replacement

ProjectIdentifier

Property description not available.

Required: No

Type: String

Update requires: Replacement

Props

The connection props.

Required: No

Type: ConnectionPropertiesInput

Update requires: No interruption

Scope

The scope of the connection.

Required: No

Type: String

Allowed values: DOMAIN | PROJECT

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 and ConnectionId, which uniquely identifies a connection. For example: { "Ref": "MyConnection" } for the resource with the logical ID MyConnection, Ref returns DomainId|ConnectionId.

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.

ConnectionId

The ID of a connection.

DomainId

The domain ID of a connection.

DomainUnitId

The domain unit ID of a connection.

EnvironmentId

The environment ID of a connection.

EnvironmentUserRole

Property description not available.

ProjectId

The connection project ID.

Type

The connection type.