1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. cloudwatch
  6. Integration

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
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:

    IntegrationType Pulumi.AwsNative.CloudWatch.IntegrationType
    The type of integration. Immutable after creation.
    Credential Pulumi.AwsNative.CloudWatch.Inputs.IntegrationCredential
    IntegrationAttributes 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.
    RoleArn 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.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Tags associated with the integration.
    IntegrationType IntegrationType
    The type of integration. Immutable after creation.
    Credential IntegrationCredentialArgs
    IntegrationAttributes 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.
    RoleArn 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.
    Tags TagArgs
    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.
    tags list(object)
    Tags associated with the integration.
    integrationType IntegrationType
    The type of integration. Immutable after creation.
    credential IntegrationCredential
    integrationAttributes 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.
    roleArn 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.
    tags List<Tag>
    Tags associated with the integration.
    integrationType IntegrationType
    The type of integration. Immutable after creation.
    credential IntegrationCredential
    integrationAttributes {[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.
    roleArn 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.
    tags Tag[]
    Tags associated with the integration.
    integration_type IntegrationType
    The type of integration. Immutable after creation.
    credential IntegrationCredentialArgs
    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.
    tags Sequence[TagArgs]
    Tags associated with the integration.
    integrationType "AWS_CONFIG_SLREC" | "AWS_INTEGRATION" | "EXTERNAL_AGENT"
    The type of integration. Immutable after creation.
    credential Property Map
    integrationAttributes 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.
    roleArn 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.
    tags 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:

    CreatedAt string
    The time at which the integration was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    IntegrationArn string
    The ARN of the integration. arn:aws:cloudwatch:{region}:{account}:integration/{integrationId}.
    IntegrationId string
    The service-generated unique identifier (UUID) of the integration.
    Status Pulumi.AwsNative.CloudWatch.IntegrationStatus
    Lifecycle status of the integration.
    UpdatedAt string
    The time at which the integration was last updated.
    CreatedAt string
    The time at which the integration was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    IntegrationArn string
    The ARN of the integration. arn:aws:cloudwatch:{region}:{account}:integration/{integrationId}.
    IntegrationId string
    The service-generated unique identifier (UUID) of the integration.
    Status IntegrationStatus
    Lifecycle status of the integration.
    UpdatedAt 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.
    createdAt String
    The time at which the integration was created.
    id String
    The provider-assigned unique ID for this managed resource.
    integrationArn String
    The ARN of the integration. arn:aws:cloudwatch:{region}:{account}:integration/{integrationId}.
    integrationId String
    The service-generated unique identifier (UUID) of the integration.
    status IntegrationStatus
    Lifecycle status of the integration.
    updatedAt String
    The time at which the integration was last updated.
    createdAt string
    The time at which the integration was created.
    id string
    The provider-assigned unique ID for this managed resource.
    integrationArn string
    The ARN of the integration. arn:aws:cloudwatch:{region}:{account}:integration/{integrationId}.
    integrationId string
    The service-generated unique identifier (UUID) of the integration.
    status IntegrationStatus
    Lifecycle status of the integration.
    updatedAt 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 IntegrationStatus
    Lifecycle status of the integration.
    updated_at str
    The time at which the integration was last updated.
    createdAt String
    The time at which the integration was created.
    id String
    The provider-assigned unique ID for this managed resource.
    integrationArn String
    The ARN of the integration. arn:aws:cloudwatch:{region}:{account}:integration/{integrationId}.
    integrationId String
    The service-generated unique identifier (UUID) of the integration.
    status "PENDING" | "PENDING_OAUTH" | "ACTIVE" | "ERROR" | "FAILED" | "DELETED"
    Lifecycle status of the integration.
    updatedAt 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) -> Integration
    func 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.

    ApiKeyCredential Pulumi.AwsNative.CloudWatch.Inputs.IntegrationCredentialApiKeyCredentialProperties
    API-key credential material that can be rotated in place on update.
    ApiKeyCredential IntegrationCredentialApiKeyCredentialProperties
    API-key credential material that can be rotated in place on update.
    api_key_credential object
    API-key credential material that can be rotated in place on update.
    apiKeyCredential IntegrationCredentialApiKeyCredentialProperties
    API-key credential material that can be rotated in place on update.
    apiKeyCredential IntegrationCredentialApiKeyCredentialProperties
    API-key credential material that can be rotated in place on update.
    api_key_credential IntegrationCredentialApiKeyCredentialProperties
    API-key credential material that can be rotated in place on update.
    apiKeyCredential Property Map
    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.

    IntegrationStatus

    Lifecycle status of the integration.

    NameValue
    PendingPENDING
    PendingOauthPENDING_OAUTH
    ActiveACTIVE
    ErrorERROR
    FailedFAILED
    DeletedDELETED
    NameValue
    IntegrationStatusPendingPENDING
    IntegrationStatusPendingOauthPENDING_OAUTH
    IntegrationStatusActiveACTIVE
    IntegrationStatusErrorERROR
    IntegrationStatusFailedFAILED
    IntegrationStatusDeletedDELETED
    Value
    PENDING
    PENDING_OAUTH
    ACTIVE
    ERROR
    FAILED
    DELETED
    NameValue
    PendingPENDING
    PendingOauthPENDING_OAUTH
    ActiveACTIVE
    ErrorERROR
    FailedFAILED
    DeletedDELETED
    NameValue
    PendingPENDING
    PendingOauthPENDING_OAUTH
    ActiveACTIVE
    ErrorERROR
    FailedFAILED
    DeletedDELETED
    NameValue
    PENDINGPENDING
    PENDING_OAUTHPENDING_OAUTH
    ACTIVEACTIVE
    ERRORERROR
    FAILEDFAILED
    DELETEDDELETED
    Value
    PENDING
    PENDING_OAUTH
    ACTIVE
    ERROR
    FAILED
    DELETED

    IntegrationType

    The type of integration. Immutable after creation.

    NameValue
    AwsConfigSlrecAWS_CONFIG_SLREC
    AwsIntegrationAWS_INTEGRATION
    ExternalAgentEXTERNAL_AGENT
    NameValue
    IntegrationTypeAwsConfigSlrecAWS_CONFIG_SLREC
    IntegrationTypeAwsIntegrationAWS_INTEGRATION
    IntegrationTypeExternalAgentEXTERNAL_AGENT
    Value
    AWS_CONFIG_SLREC
    AWS_INTEGRATION
    EXTERNAL_AGENT
    NameValue
    AwsConfigSlrecAWS_CONFIG_SLREC
    AwsIntegrationAWS_INTEGRATION
    ExternalAgentEXTERNAL_AGENT
    NameValue
    AwsConfigSlrecAWS_CONFIG_SLREC
    AwsIntegrationAWS_INTEGRATION
    ExternalAgentEXTERNAL_AGENT
    NameValue
    AWS_CONFIG_SLRECAWS_CONFIG_SLREC
    AWS_INTEGRATIONAWS_INTEGRATION
    EXTERNAL_AGENTEXTERNAL_AGENT
    Value
    AWS_CONFIG_SLREC
    AWS_INTEGRATION
    EXTERNAL_AGENT

    Tag, TagArgs

    A set of tags to apply to the resource.

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial