We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
Resource Type definition for AWS::CloudWatch::Integration. Manages a CloudWatch (Amazon CloudWatch Observability / Omni) account-scoped integration. V1 supports AWS_CONFIG_SLREC, AWS_INTEGRATION, and EXTERNAL_AGENT.
Create Integration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Integration(name: string, args: IntegrationArgs, opts?: CustomResourceOptions);@overload
def Integration(resource_name: str,
args: IntegrationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Integration(resource_name: str,
opts: Optional[ResourceOptions] = None,
integration_type: Optional[IntegrationType] = None,
credential: Optional[IntegrationCredentialArgs] = None,
integration_attributes: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
role_arn: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewIntegration(ctx *Context, name string, args IntegrationArgs, opts ...ResourceOption) (*Integration, error)public Integration(string name, IntegrationArgs args, CustomResourceOptions? opts = null)
public Integration(String name, IntegrationArgs args)
public Integration(String name, IntegrationArgs args, CustomResourceOptions options)
type: aws-native:cloudwatch:Integration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_cloudwatch_integration" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args IntegrationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args IntegrationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args IntegrationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IntegrationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IntegrationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Integration Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Integration resource accepts the following input properties:
- Integration
Type Pulumi.Aws Native. Cloud Watch. Integration Type - The type of integration. Immutable after creation.
- Credential
Pulumi.
Aws Native. Cloud Watch. Inputs. Integration Credential - Integration
Attributes Dictionary<string, string> - Type-specific configuration attributes (max 50 entries). EXTERNAL_AGENT requires 'catalogId'. On update, supplied attributes merge into the existing map; omitting a key does not remove it.
- Name string
- The customer-supplied name of the integration. Unique per account.
- Role
Arn string - IAM role ARN the integration assumes. Required for AWS_INTEGRATION (a valid, service-assumable IAM role ARN). Not used by AWS_CONFIG_SLREC or EXTERNAL_AGENT.
-
List<Pulumi.
Aws Native. Inputs. Tag> - Tags associated with the integration.
- Integration
Type IntegrationType - The type of integration. Immutable after creation.
- Credential
Integration
Credential Args - Integration
Attributes map[string]string - Type-specific configuration attributes (max 50 entries). EXTERNAL_AGENT requires 'catalogId'. On update, supplied attributes merge into the existing map; omitting a key does not remove it.
- Name string
- The customer-supplied name of the integration. Unique per account.
- Role
Arn string - IAM role ARN the integration assumes. Required for AWS_INTEGRATION (a valid, service-assumable IAM role ARN). Not used by AWS_CONFIG_SLREC or EXTERNAL_AGENT.
-
Tag
Args - Tags associated with the integration.
- integration_
type "AWS_CONFIG_SLREC" | "AWS_INTEGRATION" | "EXTERNAL_AGENT" - The type of integration. Immutable after creation.
- credential object
- integration_
attributes map(string) - Type-specific configuration attributes (max 50 entries). EXTERNAL_AGENT requires 'catalogId'. On update, supplied attributes merge into the existing map; omitting a key does not remove it.
- name string
- The customer-supplied name of the integration. Unique per account.
- role_
arn string - IAM role ARN the integration assumes. Required for AWS_INTEGRATION (a valid, service-assumable IAM role ARN). Not used by AWS_CONFIG_SLREC or EXTERNAL_AGENT.
- list(object)
- Tags associated with the integration.
- integration
Type IntegrationType - The type of integration. Immutable after creation.
- credential
Integration
Credential - integration
Attributes Map<String,String> - Type-specific configuration attributes (max 50 entries). EXTERNAL_AGENT requires 'catalogId'. On update, supplied attributes merge into the existing map; omitting a key does not remove it.
- name String
- The customer-supplied name of the integration. Unique per account.
- role
Arn String - IAM role ARN the integration assumes. Required for AWS_INTEGRATION (a valid, service-assumable IAM role ARN). Not used by AWS_CONFIG_SLREC or EXTERNAL_AGENT.
- List<Tag>
- Tags associated with the integration.
- integration
Type IntegrationType - The type of integration. Immutable after creation.
- credential
Integration
Credential - integration
Attributes {[key: string]: string} - Type-specific configuration attributes (max 50 entries). EXTERNAL_AGENT requires 'catalogId'. On update, supplied attributes merge into the existing map; omitting a key does not remove it.
- name string
- The customer-supplied name of the integration. Unique per account.
- role
Arn string - IAM role ARN the integration assumes. Required for AWS_INTEGRATION (a valid, service-assumable IAM role ARN). Not used by AWS_CONFIG_SLREC or EXTERNAL_AGENT.
- Tag[]
- Tags associated with the integration.
- integration_
type IntegrationType - The type of integration. Immutable after creation.
- credential
Integration
Credential Args - integration_
attributes Mapping[str, str] - Type-specific configuration attributes (max 50 entries). EXTERNAL_AGENT requires 'catalogId'. On update, supplied attributes merge into the existing map; omitting a key does not remove it.
- name str
- The customer-supplied name of the integration. Unique per account.
- role_
arn str - IAM role ARN the integration assumes. Required for AWS_INTEGRATION (a valid, service-assumable IAM role ARN). Not used by AWS_CONFIG_SLREC or EXTERNAL_AGENT.
-
Sequence[Tag
Args] - Tags associated with the integration.
- integration
Type "AWS_CONFIG_SLREC" | "AWS_INTEGRATION" | "EXTERNAL_AGENT" - The type of integration. Immutable after creation.
- credential Property Map
- integration
Attributes Map<String> - Type-specific configuration attributes (max 50 entries). EXTERNAL_AGENT requires 'catalogId'. On update, supplied attributes merge into the existing map; omitting a key does not remove it.
- name String
- The customer-supplied name of the integration. Unique per account.
- role
Arn String - IAM role ARN the integration assumes. Required for AWS_INTEGRATION (a valid, service-assumable IAM role ARN). Not used by AWS_CONFIG_SLREC or EXTERNAL_AGENT.
- List<Property Map>
- Tags associated with the integration.
Outputs
All input properties are implicitly available as output properties. Additionally, the Integration resource produces the following output properties:
- Created
At string - The time at which the integration was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Integration
Arn string - The ARN of the integration. arn:aws:cloudwatch:{region}:{account}:integration/{integrationId}.
- Integration
Id string - The service-generated unique identifier (UUID) of the integration.
- Status
Pulumi.
Aws Native. Cloud Watch. Integration Status - Lifecycle status of the integration.
- Updated
At string - The time at which the integration was last updated.
- Created
At string - The time at which the integration was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Integration
Arn string - The ARN of the integration. arn:aws:cloudwatch:{region}:{account}:integration/{integrationId}.
- Integration
Id string - The service-generated unique identifier (UUID) of the integration.
- Status
Integration
Status - Lifecycle status of the integration.
- Updated
At string - The time at which the integration was last updated.
- created_
at string - The time at which the integration was created.
- id string
- The provider-assigned unique ID for this managed resource.
- integration_
arn string - The ARN of the integration. arn:aws:cloudwatch:{region}:{account}:integration/{integrationId}.
- integration_
id string - The service-generated unique identifier (UUID) of the integration.
- status "PENDING" | "PENDING_OAUTH" | "ACTIVE" | "ERROR" | "FAILED" | "DELETED"
- Lifecycle status of the integration.
- updated_
at string - The time at which the integration was last updated.
- created
At String - The time at which the integration was created.
- id String
- The provider-assigned unique ID for this managed resource.
- integration
Arn String - The ARN of the integration. arn:aws:cloudwatch:{region}:{account}:integration/{integrationId}.
- integration
Id String - The service-generated unique identifier (UUID) of the integration.
- status
Integration
Status - Lifecycle status of the integration.
- updated
At String - The time at which the integration was last updated.
- created
At string - The time at which the integration was created.
- id string
- The provider-assigned unique ID for this managed resource.
- integration
Arn string - The ARN of the integration. arn:aws:cloudwatch:{region}:{account}:integration/{integrationId}.
- integration
Id string - The service-generated unique identifier (UUID) of the integration.
- status
Integration
Status - Lifecycle status of the integration.
- updated
At string - The time at which the integration was last updated.
- created_
at str - The time at which the integration was created.
- id str
- The provider-assigned unique ID for this managed resource.
- integration_
arn str - The ARN of the integration. arn:aws:cloudwatch:{region}:{account}:integration/{integrationId}.
- integration_
id str - The service-generated unique identifier (UUID) of the integration.
- status
Integration
Status - Lifecycle status of the integration.
- updated_
at str - The time at which the integration was last updated.
- created
At String - The time at which the integration was created.
- id String
- The provider-assigned unique ID for this managed resource.
- integration
Arn String - The ARN of the integration. arn:aws:cloudwatch:{region}:{account}:integration/{integrationId}.
- integration
Id String - The service-generated unique identifier (UUID) of the integration.
- status "PENDING" | "PENDING_OAUTH" | "ACTIVE" | "ERROR" | "FAILED" | "DELETED"
- Lifecycle status of the integration.
- updated
At String - The time at which the integration was last updated.
Look up Existing Integration Resource
Get an existing Integration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): Integration@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> Integrationfunc GetIntegration(ctx *Context, name string, id IDInput, state *IntegrationState, opts ...ResourceOption) (*Integration, error)public static Integration Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static Integration get(String name, Output<String> id, CustomResourceOptions options)resources: existingIntegration: type: aws-native:cloudwatch:Integration get: id: ${id}import {
to = aws-native_cloudwatch_integration.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state IntegrationState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
IntegrationCredential, IntegrationCredentialArgs
Write-only API-key credential material for the integration. Stored encrypted and never returned on read.
- Api
Key Pulumi.Credential Aws Native. Cloud Watch. Inputs. Integration Credential Api Key Credential Properties - API-key credential material that can be rotated in place on update.
- Api
Key IntegrationCredential Credential Api Key Credential Properties - API-key credential material that can be rotated in place on update.
- api_
key_ objectcredential - API-key credential material that can be rotated in place on update.
- api
Key IntegrationCredential Credential Api Key Credential Properties - API-key credential material that can be rotated in place on update.
- api
Key IntegrationCredential Credential Api Key Credential Properties - API-key credential material that can be rotated in place on update.
- api_
key_ Integrationcredential Credential Api Key Credential Properties - API-key credential material that can be rotated in place on update.
- api
Key Property MapCredential - API-key credential material that can be rotated in place on update.
IntegrationCredentialApiKeyCredentialProperties, IntegrationCredentialApiKeyCredentialPropertiesArgs
API-key credential material that can be rotated in place on update.
- Api
Key stringValue
- Api
Key stringValue
- api_
key_ stringvalue
- api
Key StringValue
- api
Key stringValue
- api_
key_ strvalue
- api
Key StringValue
IntegrationStatus
Lifecycle status of the integration.
| Name | Value |
|---|---|
| Pending | PENDING |
| Pending | PENDING_OAUTH |
| Active | ACTIVE |
| Error | ERROR |
| Failed | FAILED |
| Deleted | DELETED |
| Name | Value |
|---|---|
| Integration | PENDING |
| Integration | PENDING_OAUTH |
| Integration | ACTIVE |
| Integration | ERROR |
| Integration | FAILED |
| Integration | DELETED |
| Value |
|---|
PENDING |
PENDING_OAUTH |
ACTIVE |
ERROR |
FAILED |
DELETED |
| Name | Value |
|---|---|
| Pending | PENDING |
| Pending | PENDING_OAUTH |
| Active | ACTIVE |
| Error | ERROR |
| Failed | FAILED |
| Deleted | DELETED |
| Name | Value |
|---|---|
| Pending | PENDING |
| Pending | PENDING_OAUTH |
| Active | ACTIVE |
| Error | ERROR |
| Failed | FAILED |
| Deleted | DELETED |
| Name | Value |
|---|---|
| PENDING | PENDING |
| PENDING_OAUTH | PENDING_OAUTH |
| ACTIVE | ACTIVE |
| ERROR | ERROR |
| FAILED | FAILED |
| DELETED | DELETED |
| Value |
|---|
PENDING |
PENDING_OAUTH |
ACTIVE |
ERROR |
FAILED |
DELETED |
IntegrationType
The type of integration. Immutable after creation.
| Name | Value |
|---|---|
| Aws | AWS_CONFIG_SLREC |
| Aws | AWS_INTEGRATION |
| External | EXTERNAL_AGENT |
| Name | Value |
|---|---|
| Integration | AWS_CONFIG_SLREC |
| Integration | AWS_INTEGRATION |
| Integration | EXTERNAL_AGENT |
| Value |
|---|
AWS_CONFIG_SLREC |
AWS_INTEGRATION |
EXTERNAL_AGENT |
| Name | Value |
|---|---|
| Aws | AWS_CONFIG_SLREC |
| Aws | AWS_INTEGRATION |
| External | EXTERNAL_AGENT |
| Name | Value |
|---|---|
| Aws | AWS_CONFIG_SLREC |
| Aws | AWS_INTEGRATION |
| External | EXTERNAL_AGENT |
| Name | Value |
|---|---|
| AWS_CONFIG_SLREC | AWS_CONFIG_SLREC |
| AWS_INTEGRATION | AWS_INTEGRATION |
| EXTERNAL_AGENT | EXTERNAL_AGENT |
| Value |
|---|
AWS_CONFIG_SLREC |
AWS_INTEGRATION |
EXTERNAL_AGENT |
Tag, TagArgs
A set of tags to apply to the resource.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi