AWS::CloudWatch::Integration

CloudWatch Integration

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.

Properties

6 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`IntegrationType`	`string`	RequiredCreate-only
`Name`	`string`	RequiredCreate-only
`Credential`	`IntegrationCredential`	Write-only
`IntegrationAttributes`	`object`
`RoleArn`	`string`
`Tags`	`Array<object>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`CreatedAt`	`string`	The time at which the integration was created.
`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`	`string`	Lifecycle status of the integration.
`UpdatedAt`	`string`	The time at which the integration was last updated.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::CloudWatch::Integration

Resources:
  MyResource:
    Type: AWS::CloudWatch::Integration
    Properties:
      IntegrationType: "AWS_CONFIG_SLREC"
      Name: "my-name"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

cloudwatch:CreateIntegrationcloudwatch:GetIntegrationcloudwatch:TagResourcecloudwatch:ListTagsForResourceiam:PassRole

read

cloudwatch:GetIntegrationcloudwatch:ListTagsForResource

update

cloudwatch:UpdateIntegrationcloudwatch:GetIntegrationcloudwatch:TagResourcecloudwatch:UntagResourcecloudwatch:ListTagsForResourceiam:PassRole

delete

cloudwatch:DeleteIntegrationcloudwatch:GetIntegrationcloudwatch:ListTagsForResource

list

cloudwatch:ListIntegrations

Get the CloudWatch Cheat Sheet

Everything you need to know about CloudWatch on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceCloudWatch

Properties11

Required2

TaggingSupported

Primary IDIntegrationArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

IntegrationTypeName

Related Resources

External Links

AWS Documentation