View a markdown version of this page

AWS::SSM::CloudConnector - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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

AWS::SSM::CloudConnector

The AWS::SSM::CloudConnector resource creates a cloud connector in Amazon Systems Manager. With a cloud connector, you can manage resources in external cloud providers such as Microsoft Azure.

Syntax

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

JSON

{ "Type" : "AWS::SSM::CloudConnector", "Properties" : { "ConfigConnectorArn" : String, "Configuration" : CloudConnectorConfiguration, "Description" : String, "DisplayName" : String, "RoleArn" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::SSM::CloudConnector Properties: ConfigConnectorArn: String Configuration: CloudConnectorConfiguration Description: String DisplayName: String RoleArn: String Tags: - Tag

Properties

ConfigConnectorArn

The ARN of the Amazon Config connector associated with the cloud connector.

Required: Yes

Type: String

Pattern: ^arn:aws(-cn|-us-gov)?:config:[a-z0-9-]+:\d{12}:connector/.+$

Minimum: 1

Maximum: 512

Update requires: Replacement

Configuration

The configuration for the cloud connector.

Required: Yes

Type: CloudConnectorConfiguration

Update requires: No interruption

Description

The description of the cloud connector.

Required: No

Type: String

Pattern: ^[\p{L}\p{Z}\p{N}\p{P}\p{M}]*$

Minimum: 1

Maximum: 1024

Update requires: No interruption

DisplayName

The display name of the cloud connector.

Required: Yes

Type: String

Pattern: ^[\p{L}\p{Z}\p{N}\p{P}\p{M}]*$

Minimum: 1

Maximum: 256

Update requires: No interruption

RoleArn

The ARN of the IAM role used by the cloud connector to access resources in your Amazon Web Services account.

Required: Yes

Type: String

Pattern: ^arn:aws[a-z0-9-]*:iam::\d{12}:role/[\w-/.@+=,]{1,1017}$

Minimum: 20

Maximum: 2048

Update requires: Replacement

Tags

The metadata that you assign to a resource. Use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the cloud connector. For example:

arn:aws:ssm:us-east-1:111122223333:cloud-connector/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

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.

CloudConnectorArn

The ARN of the cloud connector. For example: arn:aws:ssm:us-east-1:111122223333:cloud-connector/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

CloudConnectorId

The unique identifier of the cloud connector. For example: a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

CreatedAt

The timestamp when the cloud connector was created.

UpdatedAt

The timestamp when the cloud connector was last updated.

Examples

Create a cloud connector to Microsoft Azure

The following example creates a cloud connector that connects Amazon Systems Manager to a Microsoft Azure tenant, targeting a specific Azure subscription.

JSON

{ "Type": "AWS::SSM::CloudConnector", "Properties": { "DisplayName": "MyAzureCloudConnector", "Description": "Cloud connector for managing Azure resources", "RoleArn": "arn:aws:iam::111122223333:role/CloudConnectorRole", "ConfigConnectorArn": "arn:aws:config:us-east-1:111122223333:connector/my-connector", "Configuration": { "AzureConfiguration": { "TenantId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "ApplicationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "TenantDisplayName": "My Azure Tenant", "ApplicationDisplayName": "My Azure App", "Targets": { "Subscriptions": [ { "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "DisplayName": "Production Subscription" } ] } } }, "Tags": [ { "Key": "Environment", "Value": "Production" } ] } }

YAML

Type: AWS::SSM::CloudConnector Properties: DisplayName: MyAzureCloudConnector Description: Cloud connector for managing Azure resources RoleArn: arn:aws:iam::111122223333:role/CloudConnectorRole ConfigConnectorArn: arn:aws:config:us-east-1:111122223333:connector/my-connector Configuration: AzureConfiguration: TenantId: a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ApplicationId: a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 TenantDisplayName: My Azure Tenant ApplicationDisplayName: My Azure App Targets: Subscriptions: - Id: a1b2c3d4-5678-90ab-cdef-EXAMPLE33333 DisplayName: Production Subscription Tags: - Key: Environment Value: Production