SSM / Client / create_cloud_connector

create_cloud_connector

SSM.Client.create_cloud_connector(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_cloud_connector(
    DisplayName='string',
    RoleArn='string',
    Description='string',
    Configuration={
        'AzureConfiguration': {
            'TenantId': 'string',
            'TenantDisplayName': 'string',
            'ApplicationId': 'string',
            'ApplicationDisplayName': 'string',
            'Targets': {
                'Subscriptions': [
                    {
                        'Id': 'string',
                        'DisplayName': 'string'
                    },
                ]
            }
        }
    },
    ConfigConnectorArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • DisplayName (string) –

    [REQUIRED]

    A friendly name for the cloud connector.

  • RoleArn (string) –

    [REQUIRED]

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

  • Description (string) – A description for the cloud connector.

  • Configuration (dict) –

    [REQUIRED]

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

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: AzureConfiguration.

    • AzureConfiguration (dict) –

      The access details and targets for connecting to a Microsoft Azure environment.

      • TenantId (string) – [REQUIRED]

        The ID of the Azure tenant.

      • TenantDisplayName (string) –

        The display name of the Azure tenant.

      • ApplicationId (string) – [REQUIRED]

        The ID of the Azure application registration used for authentication.

      • ApplicationDisplayName (string) –

        The display name of the Azure application registration.

      • Targets (dict) –

        The target Azure subscriptions for the cloud connector.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: Subscriptions.

        • Subscriptions (list) –

          A list of Azure subscriptions to target.

          • (dict) –

            Information about an Azure subscription targeted by the cloud connector.

            • Id (string) – [REQUIRED]

              The ID of the Azure subscription.

            • DisplayName (string) –

              The display name of the Azure subscription.

  • ConfigConnectorArn (string) –

    [REQUIRED]

    The ARN of the Amazon Web Services Config connector associated with this cloud connector.

  • Tags (list) –

    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.

    • (dict) –

      Metadata that you assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Amazon Web Services Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata.

      • Key (string) – [REQUIRED]

        The name of the tag.

      • Value (string) – [REQUIRED]

        The value of the tag.

Return type:

dict

Returns:

Response Syntax

{
    'CloudConnectorId': 'string'
}

Response Structure

  • (dict) –

    • CloudConnectorId (string) –

      The ID of the cloud connector that was created.

Exceptions