ConfigService / Client / put_connector

put_connector¶

ConfigService.Client.put_connector(**kwargs)¶

Creates a connector that specifies the connection between a third-party cloud service provider and Config.

A connector is required to create a service-linked configuration recorder for a third-party cloud service provider using the PutThirdPartyServiceLinkedConfigurationRecorder operation.

This API creates a service-linked role AWSServiceRoleForConfigThirdParty in your account. The service-linked role is created only when the role does not exist in your account.

Note

Connectors cannot be updated

To update the connector configuration, you must delete all associated configuration recorders, delete the connector, and recreate it with the updated configuration.

Note

Tags are added at creation and cannot be updated with this operation

Use TagResource and UntagResource to update tags after creation.

Request Syntax

response = client.put_connector(
    ConnectorConfiguration={
        'azure': {
            'tenantIdentifier': 'string',
            'clientIdentifier': 'string'
        }
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

ConnectorConfiguration (dict) –
[REQUIRED]

The provider-specific configuration for connecting to the third-party cloud service provider.
- azure (dict) –
  
  The configuration for an Azure connector.
  - tenantIdentifier (string) – [REQUIRED]
    
    The Azure tenant identifier.
  - clientIdentifier (string) – [REQUIRED]
    
    The Azure client identifier.
Tags (list) –
The tags for the connector. Each tag consists of a key and an optional value, both of which you define.
- (dict) –
  
  The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
  - Key (string) –
    
    One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
  - Value (string) –
    
    The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string'
}

Response Structure

(dict) –
- Arn (string) –
  
  The Amazon Resource Name (ARN) of the connector.

Exceptions

ConfigService.Client.exceptions.ConflictException
ConfigService.Client.exceptions.InsufficientPermissionsException
ConfigService.Client.exceptions.MaxNumberOfConnectorsExceededException
ConfigService.Client.exceptions.ValidationException