AWS::CloudWatch::Integration - AWS CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::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.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::CloudWatch::Integration",
  "Properties" : {
      "Credential" : IntegrationCredential,
      "IntegrationAttributes" : {Key: Value, ...},
      "IntegrationType" : String,
      "Name" : String,
      "RoleArn" : String,
      "Tags" : [ TagsItems, ... ]
    }
}

YAML

Type: AWS::CloudWatch::Integration
Properties:
  Credential: 
    IntegrationCredential
  IntegrationAttributes: 
    Key: Value
  IntegrationType: String
  Name: String
  RoleArn: String
  Tags: 
    - TagsItems

Properties

Credential

Property description not available.

Required: No

Type: IntegrationCredential

Update requires: No interruption

IntegrationAttributes

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.

Required: No

Type: Object of String

Pattern: ^.+$

Update requires: No interruption

IntegrationType

The type of integration. Immutable after creation.

Required: Yes

Type: String

Allowed values: AWS_CONFIG_SLREC | AWS_INTEGRATION | EXTERNAL_AGENT

Update requires: Replacement

Name

The customer-supplied name of the integration. Unique per account.

Required: Yes

Type: String

Minimum: 1

Maximum: 256

Update requires: Replacement

RoleArn

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.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Update requires: No interruption

Tags

Tags associated with the integration.

Required: No

Type: Array of TagsItems

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the value of the IntegrationArn property.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

The time at which the integration was created.

IntegrationArn

The ARN of the integration. arn:aws:cloudwatch:{region}:{account}:integration/{integrationId}.

IntegrationId

The service-generated unique identifier (UUID) of the integration.

Status

Lifecycle status of the integration.

UpdatedAt

The time at which the integration was last updated.