CreateConnector
Creates a connector to a third-party cloud provider. With a connector, you can discover resources in the provider and collect their telemetry. Currently, Microsoft Azure is the only supported provider.
Request Syntax
POST /CreateConnector HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"ConnectorConfiguration": { ... },
"Name": "string",
"RoleArn": "string",
"Tags": {
"string" : "string"
}
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- ClientToken
-
A unique, case-sensitive identifier that you provide to ensure the operation completes no more than one time. If you use an AWS SDK, the SDK generates this value and reuses it on retries. If this token matches a previous request with the same parameters, the service returns the connector from the first request without an error. If you use the same token with different parameters, including different tags, the service returns a
ValidationException. This operation is idempotent when you use the same token and parameters.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[!-~]+Required: No
- ConnectorConfiguration
-
The configuration for connecting to the third-party cloud provider.
Type: ConnectorConfiguration object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- Name
-
The name of the connector. The name must be unique in the account and Region (case-sensitive). If another connector already uses the name, the request fails with a
ConflictException.The name can contain letters, digits, hyphens (-), underscores (_) and periods (.), and must start with a letter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z][a-zA-Z0-9\-_.]*Required: Yes
- RoleArn
-
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that CloudWatch assumes to get credentials for the third-party cloud provider. The role must trust the Amazon CloudWatch Observability Admin service principal,
observabilityadmin.amazonaws.com. The role must also allowsts:GetWebIdentityTokenfor the provider's token exchange audience.Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern:
arn:aws([a-z0-9\-]+)?:([a-zA-Z0-9\-]+):([a-z0-9\-]+)?:([0-9]{12})?:(.+)Required: Yes
- Tags
-
The tags that you want to apply to the connector.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
([\p{L}\p{Z}\p{N}_.:/=+\-@]*)Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
([\p{L}\p{Z}\p{N}_.:/=+\-@]*)Required: No
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"Connector": {
"Arn": "string",
"ConnectorConfiguration": { ... },
"CreatedTimeStamp": number,
"Name": "string",
"Provider": "string",
"RoleArn": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- amznErrorType
-
The name of the exception.
HTTP Status Code: 400
- ConflictException
-
The requested operation conflicts with the current state of the specified resource or with another request.
- ResourceId
-
The identifier of the resource which is in conflict with the requested operation.
- ResourceType
-
The type of the resource which is in conflict with the requested operation.
HTTP Status Code: 409
- InternalServerException
-
Indicates the request has failed to process because of an unknown server error, exception, or failure.
- amznErrorType
-
The name of the exception.
- retryAfterSeconds
-
The number of seconds to wait before retrying the request.
HTTP Status Code: 500
- ServiceQuotaExceededException
-
The requested operation would exceed the allowed quota for the specified resource type.
- amznErrorType
-
The name of the exception.
- QuotaCode
-
The code for the exceeded service quota.
- ResourceId
-
The identifier of the resource which exceeds the service quota.
- ResourceType
-
The type of the resource which exceeds the service quota.
- ServiceCode
-
The code for the service of the exceeded quota.
HTTP Status Code: 402
- TooManyRequestsException
-
The request throughput limit was exceeded.
HTTP Status Code: 429
- ValidationException
-
Indicates input validation failed. Check your request parameters and retry the request.
- Errors
-
The errors in the input which caused the exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: