cloud_connectors

Creates, updates, deletes, gets or lists a cloud_connectors resource.

Overview

Name	cloud_connectors
Type	Resource
Id	aws.ssm.cloud_connectors

Fields

The following fields are returned by SELECT queries:

get_cloud_connector

Name	Datatype	Description
cloud_connector_arn	string	The ARN of the cloud connector. (pattern: <code>^arn:aws(-cn|-us-gov)?:ssm:([^:]+):\d{12}:cloud-connector/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
config_connector_arn	string	The ARN of the Amazon Web Services Config connector associated with this cloud connector. (pattern: <code>^arn:aws(-cn|-us-gov)?:config:([^:]+):\d{12}:connector/.+$</code>)
configuration	object	The configuration details for the third-party cloud environment connection.
created_at	string (date-time)	The date and time the cloud connector was created.
description	string	The description of the cloud connector. (pattern: <code>^([\p{L}\p{Z}\p{N}\p{P}\p{M}]*)$</code>)
display_name	string	The friendly name of the cloud connector. (pattern: <code>^([\p{L}\p{Z}\p{N}\p{P}\p{M}]*)$</code>)
role_arn	string	The ARN of the IAM role used by the cloud connector. (pattern: <code>^arn:aws[a-z0-9-]*:iam::\d{12}:role/[\w-/.@+=,]{1,1017}$</code>)
updated_at	string (date-time)	The date and time the cloud connector was last updated.

list_cloud_connectors

Name	Datatype	Description
cloud_connector_id	string	The ID of the cloud connector. (pattern: <code>^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
created_at	string (date-time)	The date and time the cloud connector was created.
description	string	The description of the cloud connector. (pattern: <code>^([\p{L}\p{Z}\p{N}\p{P}\p{M}]*)$</code>)
display_name	string	The friendly name of the cloud connector. (pattern: <code>^([\p{L}\p{Z}\p{N}\p{P}\p{M}]*)$</code>)
role_arn	string	The ARN of the IAM role used by the cloud connector. (pattern: <code>^arn:aws[a-z0-9-]*:iam::\d{12}:role/[\w-/.@+=,]{1,1017}$</code>)
updated_at	string (date-time)	The date and time the cloud connector was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_cloud_connector	select	region		Returns detailed information about a cloud connector.
list_cloud_connectors	select	region		Returns a list of cloud connectors in the current Amazon Web Services account and Amazon Web Services Region.
create_cloud_connector	insert	region, DisplayName, RoleArn, ConfigConnectorArn		Creates a cloud connector that establishes a connection between Systems Manager and a third-party cloud environment.
update_cloud_connector	update	region, CloudConnectorId		Updates an existing cloud connector with new configuration details.
delete_cloud_connector	delete	region		Deletes a cloud connector.
validate_cloud_connector	exec	region, CloudConnectorId		Validates the configuration and connectivity of a cloud connector.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_cloud_connector

Returns detailed information about a cloud connector.

SELECT
cloud_connector_arn,
config_connector_arn,
configuration,
created_at,
description,
display_name,
role_arn,
updated_at
FROM aws.ssm.cloud_connectors
WHERE region = '{{ region }}' -- required
;

list_cloud_connectors

Returns a list of cloud connectors in the current Amazon Web Services account and Amazon Web Services Region.

SELECT
cloud_connector_id,
created_at,
description,
display_name,
role_arn,
updated_at
FROM aws.ssm.cloud_connectors
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_cloud_connector

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

INSERT INTO aws.ssm.cloud_connectors (
DisplayName,
RoleArn,
Description,
Configuration,
ConfigConnectorArn,
Tags,
region
)
SELECT 
'{{ DisplayName }}' /* required */,
'{{ RoleArn }}' /* required */,
'{{ Description }}',
'{{ Configuration }}',
'{{ ConfigConnectorArn }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
cloud_connector_id
;

Manifest

# Description fields are for documentation purposes
- name: cloud_connectors
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the cloud_connectors resource.
  - name: DisplayName
    value: "{{ DisplayName }}"
    description: |
      A friendly name for the cloud connector.
  - name: RoleArn
    value: "{{ RoleArn }}"
    description: |
      The Amazon Resource Name (ARN) of the IAM role that the cloud connector uses to communicate with the third-party cloud environment.
  - name: Description
    value: "{{ Description }}"
    description: |
      A description for the cloud connector.
  - name: Configuration
    description: |
      The configuration details for connecting to the third-party cloud environment.
    value:
      AzureConfiguration:
        TenantId: "{{ TenantId }}"
        TenantDisplayName: "{{ TenantDisplayName }}"
        ApplicationId: "{{ ApplicationId }}"
        ApplicationDisplayName: "{{ ApplicationDisplayName }}"
        Targets:
          Subscriptions:
            - Id: "{{ Id }}"
              DisplayName: "{{ DisplayName }}"
  - name: ConfigConnectorArn
    value: "{{ ConfigConnectorArn }}"
    description: |
      The ARN of the Amazon Web Services Config connector associated with this cloud connector.
  - name: Tags
    description: |
      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.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_cloud_connector

Updates an existing cloud connector with new configuration details.

UPDATE aws.ssm.cloud_connectors
SET 
CloudConnectorId = '{{ CloudConnectorId }}',
DisplayName = '{{ DisplayName }}',
Configuration = '{{ Configuration }}',
Description = '{{ Description }}'
WHERE 
region = '{{ region }}' --required
AND CloudConnectorId = '{{ CloudConnectorId }}' --required
RETURNING
cloud_connector_id;

DELETE examples

delete_cloud_connector

Deletes a cloud connector.

DELETE FROM aws.ssm.cloud_connectors
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

validate_cloud_connector

Validates the configuration and connectivity of a cloud connector.

EXEC aws.ssm.cloud_connectors.validate_cloud_connector 
@region='{{ region }}' --required 
@@json=
'{
"CloudConnectorId": "{{ CloudConnectorId }}", 
"MaxResults": {{ MaxResults }}, 
"NextToken": "{{ NextToken }}"
}'
;