Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

CreateCloudConnector

Creates a cloud connector that establishes a connection between Systems Manager and a third-party cloud environment.

Request Syntax


{
   "ConfigConnectorArn": "string",
   "Configuration": { ... },
   "Description": "string",
   "DisplayName": "string",
   "RoleArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ConfigConnectorArn

The ARN of the AWS Config connector associated with this cloud connector.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

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

Required: Yes

Configuration

The configuration details for connecting to the third-party cloud environment.

Type: CloudConnectorConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

Description

A description for the cloud connector.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

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

Required: No

DisplayName

A friendly name for the cloud connector.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

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

Required: Yes

RoleArn

The Amazon Resource Name (ARN) of the IAM role that the cloud connector uses to communicate with the third-party cloud environment.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

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

Required: Yes

Tags

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.

Type: Array of Tag objects

Array Members: Maximum number of 1000 items.

Required: No

Response Syntax


{
   "CloudConnectorId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CloudConnectorId

The ID of the cloud connector that was created.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Errors

For information about the errors that are common to all actions, see Common Error Types.

ConflictException

An error occurred because of a conflict with a concurrent request or the current state of the resource. Retry your request.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

ServiceQuotaExceededException

The request exceeds the service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your AWS account.

QuotaCode: The quota code recognized by the AWS Service Quotas service.
ResourceId: The unique ID of the resource referenced in the failed request.
ResourceType: The resource type of the resource referenced in the failed request.
ServiceCode: The code for the AWS service that owns the quota.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of CreateCloudConnector.

Sample Request


POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.CreateCloudConnector
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240220T232503Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240220/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 560

{
    "DisplayName": "MyAzureConnector",
    "Description": "Azure connector for production workloads",
    "RoleArn": "arn:aws:iam::123456789012:role/SSMAzureConnectorRole",
    "ConfigConnectorArn": "arn:aws:config:us-east-2:123456789012:connector/azure/263dd747-5cc8-4e18-abf2-a25d8e374f66/061a61b6-5954-4b72-b6a2-458c62d046d9",
    "Configuration": {
        "AzureConfiguration": {
            "TenantId": "263dd747-5cc8-4e18-abf2-a25d8e374f66",
            "TenantDisplayName": "MyAzureTenant",
            "ApplicationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "ApplicationDisplayName": "SSMAdminApp",
            "Targets": {
                "Subscriptions": [
                    {
                        "Id": "14724fea-7bad-4c32-8af0-ebde38f42a46",
                        "DisplayName": "ProductionSubscription"
                    }
                ]
            }
        }
    }
}

Sample Response


{
    "CloudConnectorId": "8077bdca-72e6-4cda-8fd9-09bae51454f6"
}