CfnIntegrationProps Struct Added in v2.275.0
Properties for defining a CfnIntegration.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudwatch as cloudwatch } from 'aws-cdk-lib';
const cfnIntegrationProps: cloudwatch.CfnIntegrationProps = {
integrationType: 'integrationType',
name: 'name',
// the properties below are optional
credential: {
apiKeyCredential: {
apiKeyValue: 'apiKeyValue',
},
},
integrationAttributes: {
integrationAttributesKey: 'integrationAttributes',
},
roleArn: 'roleArn',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
credentialoptionalIResolvable | CfnIntegration.IntegrationCredentialPropertycredentialoptionaltyping.Union[IResolvable, IntegrationCredentialProperty]credentialoptionalIResolvableCredentialoptionalIResolvableCredentialoptionalinterface{}#Write-only API-key credential material for the integration.
Stored encrypted and never returned on read.
integrationAttributesoptionalIResolvable | { [key: string]: string }integration_attributesoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]integrationAttributesoptionalIResolvableIntegrationAttributesoptionalIResolvableIntegrationAttributesoptionalinterface{}#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.
integrationTypestringintegration_typestrintegrationTypeStringIntegrationTypestringIntegrationType*stringrequired#The type of integration.
Immutable after creation.
The customer-supplied name of the integration.
Unique per account.
roleArnoptionalstringrole_arnoptionalstrroleArnoptionalStringRoleArnoptionalstringRoleArnoptional*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.
tagsoptionalCfnIntegration.TagsItemsProperty[]tagsoptionaltyping.List[TagsItemsProperty]tagsoptionalList<TagsItemsProperty>TagsoptionalTagsItemsProperty[]Tagsoptional*[]TagsItemsProperty#Tags associated with the integration.