SSM / Client / update_cloud_connector

update_cloud_connector

SSM.Client.update_cloud_connector(**kwargs)

Updates an existing cloud connector with new configuration details.

See also: AWS API Documentation

Request Syntax

response = client.update_cloud_connector(
    CloudConnectorId='string',
    DisplayName='string',
    Configuration={
        'AzureConfiguration': {
            'TenantId': 'string',
            'TenantDisplayName': 'string',
            'ApplicationId': 'string',
            'ApplicationDisplayName': 'string',
            'Targets': {
                'Subscriptions': [
                    {
                        'Id': 'string',
                        'DisplayName': 'string'
                    },
                ]
            }
        }
    },
    Description='string'
)
Parameters:

  • CloudConnectorId (string) –

    [REQUIRED]

    The ID of the cloud connector to update.

  • DisplayName (string) – A new friendly name for the cloud connector.

  • Configuration (dict) –

    The updated 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.

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

Return type:

dict

Returns:

Response Syntax

{
    'CloudConnectorId': 'string'
}

Response Structure

  • (dict) –

    • CloudConnectorId (string) –

      The ID of the cloud connector that was updated.

Exceptions