Integration
A connection between CloudWatch and an external system — such as a source of telemetry or configuration data, a messaging destination, or a model provider.
Contents
- integrationId
-
The unique identifier of the integration.
Type: String
Required: Yes
- integrationType
-
The type of external system that an integration connects to, such as a source of configuration data, a messaging destination, or a model provider.
Type: String
Valid Values:
AWS_CONFIG_SLREC | SLACK | EXTERNAL_AGENT | AWS_INTEGRATIONRequired: Yes
- name
-
The customer-provided name of the integration.
Type: String
Required: Yes
- status
-
The current lifecycle state of an integration.
Type: String
Valid Values:
ACTIVE | DELETED | PENDING | PENDING_OAUTH | ERROR | FAILEDRequired: Yes
-
The URL the customer visits to authorize the integration. Present while an OAuth authorization is pending.
Type: String
Required: No
- authType
-
The authentication method that an integration uses to connect to its external system.
Type: String
Valid Values:
NONE | OAUTH2 | API_KEYRequired: No
- createdAt
-
The time at which the integration was created.
Type: Timestamp
Required: No
- credentialArn
-
The Amazon Resource Name (ARN) of the secret that stores the integration's credentials.
Type: String
Required: No
- errorMessage
-
A human-readable description of why the integration is in an ERROR or FAILED state. Present only when the integration has failed.
Type: String
Required: No
- integrationArn
-
The Amazon Resource Name (ARN) of the integration.
Type: String
Required: No
- integrationAttributes
-
Provider-specific key/value attributes that configure the integration.
Type: String to string map
Key Length Constraints: Minimum length of 0. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 4096.
Required: No
- roleArn
-
The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to access the external system.
Type: String
Required: No
- scope
-
Whether this integration is account-scoped (ACCOUNT, customer-created) or organization-scoped (ORGANIZATION, created by an org-enablement rule). Absent on legacy records is treated as ACCOUNT.
Type: String
Valid Values:
ACCOUNT | ORGANIZATIONRequired: No
- updatedAt
-
The time at which the integration was last updated.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: