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

This is the new AWS 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 AWS CloudFormation template, use the following syntax:

JSON

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

YAML

Type: AWS::DataZone::Connection
Properties:
  AwsLocation: 
    AwsLocation
  Description: String
  DomainIdentifier: String
  EnvironmentIdentifier: String
  Name: String
  Props: 
    ConnectionPropertiesInput

Properties

AwsLocation

The location where the connection is created.

Required: No

Type: AwsLocation

Update requires: No interruption

Description

Connection description.

Required: No

Type: String

Pattern: ^[\S\s]*$

Maximum: 128

Update requires: No interruption

DomainIdentifier

The ID of the domain where the connection is created.

Required: Yes

Type: String

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

Update requires: Replacement

EnvironmentIdentifier

The ID of the environment where the connection is created.

Required: Yes

Type: String

Update requires: Replacement

Name

The name of the connection.

Required: Yes

Type: String

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

Maximum: 64

Update requires: Replacement

Props

Connection props.

Required: No

Type: ConnectionPropertiesInput

Update requires: No interruption

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 the connection.

DomainId

The domain ID of the connection.

DomainUnitId

The domain unit ID of the connection.

EnvironmentId

The ID of the environment.

EnvironmentUserRole

The environment user role.

ProjectId

The ID of the project.

Type

The type of the connection.