Package software.amazon.awscdk.services.devopsagent

Class CfnAssociation

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.devopsagent.CfnAssociation

All Implemented Interfaces:

IInspectable, IAssociationRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)",
           date="2026-02-03T13:58:21.027Z")
@Stability(Stable)
public class CfnAssociation
extends CfnResource
implements IInspectable, IAssociationRef

The AWS::DevOpsAgent::Association resource specifies an association between an Agent Space and a service, defining how the Agent Space interacts with external services like GitHub, Slack, AWS accounts, and others.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.devopsagent.*;
 Object resourceMetadata;
 CfnAssociation cfnAssociation = CfnAssociation.Builder.create(this, "MyCfnAssociation")
         .agentSpaceId("agentSpaceId")
         .configuration(ServiceConfigurationProperty.builder()
                 .aws(AWSConfigurationProperty.builder()
                         .accountId("accountId")
                         .accountType("accountType")
                         .assumableRoleArn("assumableRoleArn")
                         // the properties below are optional
                         .resources(List.of(AWSResourceProperty.builder()
                                 .resourceArn("resourceArn")
                                 // the properties below are optional
                                 .resourceMetadata(resourceMetadata)
                                 .resourceType("resourceType")
                                 .build()))
                         .tags(List.of(KeyValuePairProperty.builder()
                                 .key("key")
                                 .value("value")
                                 .build()))
                         .build())
                 .dynatrace(DynatraceConfigurationProperty.builder()
                         .envId("envId")
                         // the properties below are optional
                         .enableWebhookUpdates(false)
                         .resources(List.of("resources"))
                         .build())
                 .eventChannel(EventChannelConfigurationProperty.builder()
                         .enableWebhookUpdates(false)
                         .build())
                 .gitHub(GitHubConfigurationProperty.builder()
                         .owner("owner")
                         .ownerType("ownerType")
                         .repoId("repoId")
                         .repoName("repoName")
                         .build())
                 .gitLab(GitLabConfigurationProperty.builder()
                         .projectId("projectId")
                         .projectPath("projectPath")
                         // the properties below are optional
                         .enableWebhookUpdates(false)
                         .instanceIdentifier("instanceIdentifier")
                         .build())
                 .mcpServer(MCPServerConfigurationProperty.builder()
                         .endpoint("endpoint")
                         .name("name")
                         .tools(List.of("tools"))
                         // the properties below are optional
                         .description("description")
                         .enableWebhookUpdates(false)
                         .build())
                 .mcpServerDatadog(MCPServerDatadogConfigurationProperty.builder()
                         .endpoint("endpoint")
                         .name("name")
                         // the properties below are optional
                         .description("description")
                         .enableWebhookUpdates(false)
                         .build())
                 .mcpServerNewRelic(MCPServerNewRelicConfigurationProperty.builder()
                         .accountId("accountId")
                         .endpoint("endpoint")
                         .build())
                 .mcpServerSplunk(MCPServerSplunkConfigurationProperty.builder()
                         .endpoint("endpoint")
                         .name("name")
                         // the properties below are optional
                         .description("description")
                         .enableWebhookUpdates(false)
                         .build())
                 .serviceNow(ServiceNowConfigurationProperty.builder()
                         .enableWebhookUpdates(false)
                         .instanceId("instanceId")
                         .build())
                 .slack(SlackConfigurationProperty.builder()
                         .transmissionTarget(SlackTransmissionTargetProperty.builder()
                                 .incidentResponseTarget(SlackChannelProperty.builder()
                                         .channelId("channelId")
                                         // the properties below are optional
                                         .channelName("channelName")
                                         .build())
                                 .build())
                         .workspaceId("workspaceId")
                         .workspaceName("workspaceName")
                         .build())
                 .sourceAws(SourceAwsConfigurationProperty.builder()
                         .accountId("accountId")
                         .accountType("accountType")
                         .assumableRoleArn("assumableRoleArn")
                         // the properties below are optional
                         .resources(List.of(AWSResourceProperty.builder()
                                 .resourceArn("resourceArn")
                                 // the properties below are optional
                                 .resourceMetadata(resourceMetadata)
                                 .resourceType("resourceType")
                                 .build()))
                         .tags(List.of(KeyValuePairProperty.builder()
                                 .key("key")
                                 .value("value")
                                 .build()))
                         .build())
                 .build())
         .serviceId("serviceId")
         // the properties below are optional
         .linkedAssociationIds(List.of("linkedAssociationIds"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsagent-association.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnAssociation.AWSConfigurationProperty	Configuration for AWS monitor account integration.
static interface	CfnAssociation.AWSResourceProperty	Defines an AWS resource to be monitored, including its type, ARN, and optional metadata.
static final class	CfnAssociation.Builder	A fluent builder for CfnAssociation.
static interface	CfnAssociation.DynatraceConfigurationProperty	Configuration for Dynatrace monitoring integration.
static interface	CfnAssociation.EventChannelConfigurationProperty	Configuration for Event Channel integration.
static interface	CfnAssociation.GitHubConfigurationProperty	Configuration for GitHub repository integration.
static interface	CfnAssociation.GitLabConfigurationProperty	Configuration for GitLab project integration.
static interface	CfnAssociation.KeyValuePairProperty	A key-value pair for tags.
static interface	CfnAssociation.MCPServerConfigurationProperty	Configuration for MCP (Model Context Protocol) server integration.
static interface	CfnAssociation.MCPServerDatadogConfigurationProperty	Configuration for Datadog MCP server integration.
static interface	CfnAssociation.MCPServerNewRelicConfigurationProperty	Configuration for New Relic MCP server integration.
static interface	CfnAssociation.MCPServerSplunkConfigurationProperty	Configuration for Splunk MCP server integration.
static interface	CfnAssociation.ServiceConfigurationProperty	The configuration that directs how Agent Space interacts with the given service.
static interface	CfnAssociation.ServiceNowConfigurationProperty	Configuration for ServiceNow integration.
static interface	CfnAssociation.SlackChannelProperty	Represents a Slack channel with its unique identifier and optional display name.
static interface	CfnAssociation.SlackConfigurationProperty	Configuration for Slack workspace integration.
static interface	CfnAssociation.SlackTransmissionTargetProperty	Defines the Slack channels where different types of agent notifications will be sent.
static interface	CfnAssociation.SourceAwsConfigurationProperty	Configuration for AWS source account integration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.devopsagent.IAssociationRef

IAssociationRef.Jsii$Default, IAssociationRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAssociation(software.amazon.jsii.JsiiObjectRef objRef)
	CfnAssociation(software.constructs.Construct scope, String id, CfnAssociationProps props)	Create a new AWS::DevOpsAgent::Association.

Method Summary

Modifier and Type	Method	Description
String	getAgentSpaceId()	The unique identifier of the Agent Space.
AssociationReference	getAssociationRef()	A reference to a Association resource.
String	getAttrAssociationId()	The unique identifier of the association.
String	getAttrCreatedAt()	The timestamp when the association was created.
String	getAttrUpdatedAt()	The timestamp when the association was last updated.
protected Map<String,Object>	getCfnProperties()
Object	getConfiguration()	The configuration that directs how the Agent Space interacts with the given service.
List<String>	getLinkedAssociationIds()	Set of linked association IDs for parent-child relationships.
String	getServiceId()	The identifier for the associated service.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnAssociation(Object x)	Checks whether the given object is a CfnAssociation.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAgentSpaceId(String value)	The unique identifier of the Agent Space.
void	setConfiguration(IResolvable value)	The configuration that directs how the Agent Space interacts with the given service.
void	setConfiguration(CfnAssociation.ServiceConfigurationProperty value)	The configuration that directs how the Agent Space interacts with the given service.
void	setLinkedAssociationIds(List<String> value)	Set of linked association IDs for parent-child relationships.
void	setServiceId(String value)	The identifier for the associated service.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnAssociation

protected CfnAssociation(software.amazon.jsii.JsiiObjectRef objRef)

CfnAssociation

protected CfnAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAssociation

@Stability(Stable)
public CfnAssociation(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnAssociationProps props)

Create a new AWS::DevOpsAgent::Association.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

isCfnAssociation

@Stability(Stable)
@NotNull
public static Boolean isCfnAssociation(@NotNull
 Object x)

Checks whether the given object is a CfnAssociation.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAssociationRef

@Stability(Stable)
@NotNull
public AssociationReference getAssociationRef()

A reference to a Association resource.

Specified by:

getAssociationRef in interface IAssociationRef

getAttrAssociationId

@Stability(Stable)
@NotNull
public String getAttrAssociationId()

The unique identifier of the association.

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

The timestamp when the association was created.

getAttrUpdatedAt

@Stability(Stable)
@NotNull
public String getAttrUpdatedAt()

The timestamp when the association was last updated.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAgentSpaceId

@Stability(Stable)
@NotNull
public String getAgentSpaceId()

The unique identifier of the Agent Space.

setAgentSpaceId

@Stability(Stable)
public void setAgentSpaceId(@NotNull
 String value)

The unique identifier of the Agent Space.

getConfiguration

@Stability(Stable)
@NotNull
public Object getConfiguration()

The configuration that directs how the Agent Space interacts with the given service.

Returns union: either IResolvable or CfnAssociation.ServiceConfigurationProperty

setConfiguration

@Stability(Stable)
public void setConfiguration(@NotNull
 IResolvable value)

The configuration that directs how the Agent Space interacts with the given service.

setConfiguration

@Stability(Stable)
public void setConfiguration(@NotNull
 CfnAssociation.ServiceConfigurationProperty value)

The configuration that directs how the Agent Space interacts with the given service.

getServiceId

@Stability(Stable)
@NotNull
public String getServiceId()

The identifier for the associated service.

setServiceId

@Stability(Stable)
public void setServiceId(@NotNull
 String value)

The identifier for the associated service.

getLinkedAssociationIds

@Stability(Stable)
@Nullable
public List<String> getLinkedAssociationIds()

Set of linked association IDs for parent-child relationships.

setLinkedAssociationIds

@Stability(Stable)
public void setLinkedAssociationIds(@Nullable
 List<String> value)

Set of linked association IDs for parent-child relationships.