CfnAssociation
- class aws_cdk.aws_devopsagent.CfnAssociation(scope, id, *, agent_space_id, configuration, service_id, linked_association_ids=None)
Bases:
CfnResourceThe
AWS::DevOpsAgent::Associationresource 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.- See:
- CloudformationResource:
AWS::DevOpsAgent::Association
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_devopsagent as devopsagent # resource_metadata: Any cfn_association = devopsagent.CfnAssociation(self, "MyCfnAssociation", agent_space_id="agentSpaceId", configuration=devopsagent.CfnAssociation.ServiceConfigurationProperty( aws=devopsagent.CfnAssociation.AWSConfigurationProperty( account_id="accountId", account_type="accountType", assumable_role_arn="assumableRoleArn", # the properties below are optional resources=[devopsagent.CfnAssociation.AWSResourceProperty( resource_arn="resourceArn", # the properties below are optional resource_metadata=resource_metadata, resource_type="resourceType" )], tags=[devopsagent.CfnAssociation.KeyValuePairProperty( key="key", value="value" )] ), dynatrace=devopsagent.CfnAssociation.DynatraceConfigurationProperty( env_id="envId", # the properties below are optional enable_webhook_updates=False, resources=["resources"] ), event_channel=devopsagent.CfnAssociation.EventChannelConfigurationProperty( enable_webhook_updates=False ), git_hub=devopsagent.CfnAssociation.GitHubConfigurationProperty( owner="owner", owner_type="ownerType", repo_id="repoId", repo_name="repoName" ), git_lab=devopsagent.CfnAssociation.GitLabConfigurationProperty( project_id="projectId", project_path="projectPath", # the properties below are optional enable_webhook_updates=False, instance_identifier="instanceIdentifier" ), mcp_server=devopsagent.CfnAssociation.MCPServerConfigurationProperty( endpoint="endpoint", name="name", tools=["tools"], # the properties below are optional description="description", enable_webhook_updates=False ), mcp_server_datadog=devopsagent.CfnAssociation.MCPServerDatadogConfigurationProperty( endpoint="endpoint", name="name", # the properties below are optional description="description", enable_webhook_updates=False ), mcp_server_new_relic=devopsagent.CfnAssociation.MCPServerNewRelicConfigurationProperty( account_id="accountId", endpoint="endpoint" ), mcp_server_splunk=devopsagent.CfnAssociation.MCPServerSplunkConfigurationProperty( endpoint="endpoint", name="name", # the properties below are optional description="description", enable_webhook_updates=False ), service_now=devopsagent.CfnAssociation.ServiceNowConfigurationProperty( enable_webhook_updates=False, instance_id="instanceId" ), slack=devopsagent.CfnAssociation.SlackConfigurationProperty( transmission_target=devopsagent.CfnAssociation.SlackTransmissionTargetProperty( incident_response_target=devopsagent.CfnAssociation.SlackChannelProperty( channel_id="channelId", # the properties below are optional channel_name="channelName" ) ), workspace_id="workspaceId", workspace_name="workspaceName" ), source_aws=devopsagent.CfnAssociation.SourceAwsConfigurationProperty( account_id="accountId", account_type="accountType", assumable_role_arn="assumableRoleArn", # the properties below are optional resources=[devopsagent.CfnAssociation.AWSResourceProperty( resource_arn="resourceArn", # the properties below are optional resource_metadata=resource_metadata, resource_type="resourceType" )], tags=[devopsagent.CfnAssociation.KeyValuePairProperty( key="key", value="value" )] ) ), service_id="serviceId", # the properties below are optional linked_association_ids=["linkedAssociationIds"] )
Create a new
AWS::DevOpsAgent::Association.- Parameters:
scope (
Construct) – Scope in which this resource is defined.id (
str) – Construct identifier for this resource (unique in its scope).agent_space_id (
str) – The unique identifier of the Agent Space.configuration (
Union[IResolvable,ServiceConfigurationProperty,Dict[str,Any]]) – The configuration that directs how the Agent Space interacts with the given service. You can specify only one configuration type per association. Allowed Values :SourceAws|Aws|GitHub|GitLab|Slack|Dynatrace|ServiceNow|MCPServer|MCPServerNewRelic|MCPServerDatadog|MCPServerSplunk|EventChannelservice_id (
str) – The identifier for the associated service. ForSourceAwsandAwsconfigurations, this must beaws. For all other service types, this is a UUID generated from the RegisterService command.linked_association_ids (
Optional[Sequence[str]]) – Set of linked association IDs for parent-child relationships.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource)- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource)- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str)value (
Any)
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional[RemovalPolicy])apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.type_hint (
Optional[ResolutionTypeHint])
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str)- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List[Union[Stack,CfnResource]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List[CfnResource]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource)- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource) – The dependency to replace.new_target (
CfnResource) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::DevOpsAgent::Association'
- agent_space_id
The unique identifier of the Agent Space.
- association_ref
A reference to a Association resource.
- attr_association_id
The unique identifier of the association.
- CloudformationAttribute:
AssociationId
- attr_created_at
The timestamp when the association was created.
- CloudformationAttribute:
CreatedAt
- attr_updated_at
The timestamp when the association was last updated.
- CloudformationAttribute:
UpdatedAt
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- configuration
The configuration that directs how the Agent Space interacts with the given service.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- env
- linked_association_ids
Set of linked association IDs for parent-child relationships.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- node
The tree node.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- service_id
The identifier for the associated service.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
Static Methods
- classmethod is_cfn_association(x)
Checks whether the given object is a CfnAssociation.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any)- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_construct(x)
Checks if
xis a construct.Use this method instead of
instanceofto properly detectConstructinstances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructslibrary on disk are seen as independent, completely different libraries. As a consequence, the classConstructin each copy of theconstructslibrary is seen as a different class, and an instance of one class will not test asinstanceofthe other class.npm installwill not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructslibrary can be accidentally installed, andinstanceofwill behave unpredictably. It is safest to avoid usinginstanceof, and using this type-testing method instead.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsConstruct.
AWSConfigurationProperty
- class CfnAssociation.AWSConfigurationProperty(*, account_id, account_type, assumable_role_arn, resources=None, tags=None)
Bases:
objectConfiguration for AWS monitor account integration.
Specifies the account ID, assumable role ARN, and resources to be monitored in the primary monitoring account.
- Parameters:
account_id (
str) – Account ID corresponding to the provided resources.account_type (
str) – Account Type ‘monitor’ for AWS DevOps Agent monitoring.assumable_role_arn (
str) – Role ARN used by AWS DevOps Agent to access resources in the primary account.resources (
Union[IResolvable,Sequence[Union[IResolvable,AWSResourceProperty,Dict[str,Any]]],None]) – List of resources to monitor.tags (
Optional[Sequence[Union[KeyValuePairProperty,Dict[str,Any]]]]) – List of tags as key-value pairs, used to identify resources for topology crawl.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_devopsagent as devopsagent # resource_metadata: Any a_wSConfiguration_property = devopsagent.CfnAssociation.AWSConfigurationProperty( account_id="accountId", account_type="accountType", assumable_role_arn="assumableRoleArn", # the properties below are optional resources=[devopsagent.CfnAssociation.AWSResourceProperty( resource_arn="resourceArn", # the properties below are optional resource_metadata=resource_metadata, resource_type="resourceType" )], tags=[devopsagent.CfnAssociation.KeyValuePairProperty( key="key", value="value" )] )
Attributes
- account_id
Account ID corresponding to the provided resources.
- account_type
Account Type ‘monitor’ for AWS DevOps Agent monitoring.
- assumable_role_arn
Role ARN used by AWS DevOps Agent to access resources in the primary account.
- resources
List of resources to monitor.
- tags
List of tags as key-value pairs, used to identify resources for topology crawl.
AWSResourceProperty
- class CfnAssociation.AWSResourceProperty(*, resource_arn, resource_metadata=None, resource_type=None)
Bases:
objectDefines an AWS resource to be monitored, including its type, ARN, and optional metadata.
- Parameters:
resource_arn (
str) – The Amazon Resource Name (ARN) of the resource.resource_metadata (
Any) – Additional metadata specific to the resource. This is an optional JSON object that can include resource-specific information to provide additional context for monitoring and management.resource_type (
Optional[str]) – Resource type.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_devopsagent as devopsagent # resource_metadata: Any a_wSResource_property = devopsagent.CfnAssociation.AWSResourceProperty( resource_arn="resourceArn", # the properties below are optional resource_metadata=resource_metadata, resource_type="resourceType" )
Attributes
- resource_arn
The Amazon Resource Name (ARN) of the resource.
- resource_metadata
Additional metadata specific to the resource.
This is an optional JSON object that can include resource-specific information to provide additional context for monitoring and management.
DynatraceConfigurationProperty
- class CfnAssociation.DynatraceConfigurationProperty(*, env_id, enable_webhook_updates=None, resources=None)
Bases:
objectConfiguration for Dynatrace monitoring integration.
Defines the Dynatrace environment ID, list of resources to monitor, and webhook update settings required for the Agent Space to access metrics, traces, and logs from Dynatrace.
- Parameters:
env_id (
str) – Dynatrace environment id.enable_webhook_updates (
Union[bool,IResolvable,None]) – When set to true, enables the Agent Space to create and update webhooks for receiving notifications and events from the service.resources (
Optional[Sequence[str]]) – List of Dynatrace resources to monitor.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_devopsagent as devopsagent dynatrace_configuration_property = devopsagent.CfnAssociation.DynatraceConfigurationProperty( env_id="envId", # the properties below are optional enable_webhook_updates=False, resources=["resources"] )
Attributes
- enable_webhook_updates
When set to true, enables the Agent Space to create and update webhooks for receiving notifications and events from the service.
- env_id
Dynatrace environment id.
- resources
List of Dynatrace resources to monitor.
EventChannelConfigurationProperty
- class CfnAssociation.EventChannelConfigurationProperty(*, enable_webhook_updates=None)
Bases:
objectConfiguration for Event Channel integration.
Defines webhook update settings to enable the Agent Space to receive real-time event notifications from event channel integrations.
- Parameters:
enable_webhook_updates (
Union[bool,IResolvable,None]) – When set to true, enables the Agent Space to create and update webhooks for receiving notifications and events from the service.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_devopsagent as devopsagent event_channel_configuration_property = devopsagent.CfnAssociation.EventChannelConfigurationProperty( enable_webhook_updates=False )
Attributes
- enable_webhook_updates
When set to true, enables the Agent Space to create and update webhooks for receiving notifications and events from the service.
GitHubConfigurationProperty
- class CfnAssociation.GitHubConfigurationProperty(*, owner, owner_type, repo_id, repo_name)
Bases:
objectConfiguration for GitHub repository integration.
Defines the repository name, numeric repository ID, owner name, and owner type (user or organization) required for the Agent Space to access and interact with the GitHub repository.
- Parameters:
owner (
str) – Repository owner.owner_type (
str) – Type of repository owner.repo_id (
str) – Associated Github repo ID.repo_name (
str) – Associated Github repo name.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_devopsagent as devopsagent git_hub_configuration_property = devopsagent.CfnAssociation.GitHubConfigurationProperty( owner="owner", owner_type="ownerType", repo_id="repoId", repo_name="repoName" )
Attributes
- owner
Repository owner.
- owner_type
Type of repository owner.
- repo_id
Associated Github repo ID.
GitLabConfigurationProperty
- class CfnAssociation.GitLabConfigurationProperty(*, project_id, project_path, enable_webhook_updates=None, instance_identifier=None)
Bases:
objectConfiguration for GitLab project integration.
Defines the numeric project ID, full project path (namespace/project-name), GitLab instance identifier, and webhook update settings required for the Agent Space to access and interact with the GitLab project.
- Parameters:
project_id (
str) – GitLab numeric project ID.project_path (
str) – Full GitLab project path (e.g., namespace/project-name).enable_webhook_updates (
Union[bool,IResolvable,None]) – When set to true, enables the Agent Space to create and update webhooks for receiving notifications and events from the service.instance_identifier (
Optional[str]) – GitLab instance identifier (e.g., gitlab.com).
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_devopsagent as devopsagent git_lab_configuration_property = devopsagent.CfnAssociation.GitLabConfigurationProperty( project_id="projectId", project_path="projectPath", # the properties below are optional enable_webhook_updates=False, instance_identifier="instanceIdentifier" )
Attributes
- enable_webhook_updates
When set to true, enables the Agent Space to create and update webhooks for receiving notifications and events from the service.
- instance_identifier
GitLab instance identifier (e.g., gitlab.com).
- project_id
GitLab numeric project ID.
- project_path
Full GitLab project path (e.g., namespace/project-name).
KeyValuePairProperty
- class CfnAssociation.KeyValuePairProperty(*, key, value)
Bases:
objectA key-value pair for tags.
- Parameters:
key (
str) – The key name of the tag.value (
str) – The value for the tag.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_devopsagent as devopsagent key_value_pair_property = devopsagent.CfnAssociation.KeyValuePairProperty( key="key", value="value" )
Attributes
- key
The key name of the tag.
MCPServerConfigurationProperty
- class CfnAssociation.MCPServerConfigurationProperty(*, endpoint, name, tools, description=None, enable_webhook_updates=None)
Bases:
objectConfiguration for MCP (Model Context Protocol) server integration.
Defines the server name, endpoint URL, available tools, optional description, and webhook update settings for custom MCP servers.
- Parameters:
endpoint (
str) – MCP server endpoint URL.name (
str) – The name of the MCP server.tools (
Sequence[str]) – List of MCP tools that can be used with the association.description (
Optional[str]) – The description of the MCP server.enable_webhook_updates (
Union[bool,IResolvable,None]) – When set to true, enables the Agent Space to create and update webhooks for receiving notifications and events from the service.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_devopsagent as devopsagent m_cPServer_configuration_property = devopsagent.CfnAssociation.MCPServerConfigurationProperty( endpoint="endpoint", name="name", tools=["tools"], # the properties below are optional description="description", enable_webhook_updates=False )
Attributes
- description
The description of the MCP server.
- enable_webhook_updates
When set to true, enables the Agent Space to create and update webhooks for receiving notifications and events from the service.
- endpoint
MCP server endpoint URL.
- name
The name of the MCP server.
- tools
List of MCP tools that can be used with the association.
MCPServerDatadogConfigurationProperty
- class CfnAssociation.MCPServerDatadogConfigurationProperty(*, endpoint, name, description=None, enable_webhook_updates=None)
Bases:
objectConfiguration for Datadog MCP server integration.
Defines the server name, endpoint URL, optional description, and webhook update settings.
- Parameters:
endpoint (
str) – MCP server endpoint URL.name (
str) – The name of the MCP server.description (
Optional[str]) – The description of the MCP server.enable_webhook_updates (
Union[bool,IResolvable,None]) – When set to true, enables the Agent Space to create and update webhooks for receiving notifications and events from the service.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_devopsagent as devopsagent m_cPServer_datadog_configuration_property = devopsagent.CfnAssociation.MCPServerDatadogConfigurationProperty( endpoint="endpoint", name="name", # the properties below are optional description="description", enable_webhook_updates=False )
Attributes
- description
The description of the MCP server.
- enable_webhook_updates
When set to true, enables the Agent Space to create and update webhooks for receiving notifications and events from the service.
- endpoint
MCP server endpoint URL.
MCPServerNewRelicConfigurationProperty
- class CfnAssociation.MCPServerNewRelicConfigurationProperty(*, account_id, endpoint)
Bases:
objectConfiguration for New Relic MCP server integration.
Defines the New Relic account ID and MCP server endpoint URL required for the Agent Space to authenticate and query observability data from New Relic.
- Parameters:
account_id (
str) – New Relic Account ID.endpoint (
str) – MCP server endpoint URL (e.g., https://mcp.newrelic.com/mcp/).
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_devopsagent as devopsagent m_cPServer_new_relic_configuration_property = devopsagent.CfnAssociation.MCPServerNewRelicConfigurationProperty( account_id="accountId", endpoint="endpoint" )
Attributes
- account_id
New Relic Account ID.
- endpoint
//mcp.newrelic.com/mcp/).
MCPServerSplunkConfigurationProperty
- class CfnAssociation.MCPServerSplunkConfigurationProperty(*, endpoint, name, description=None, enable_webhook_updates=None)
Bases:
objectConfiguration for Splunk MCP server integration.
Defines the server name, endpoint URL, optional description, and webhook update settings.
- Parameters:
endpoint (
str) – MCP server endpoint URL.name (
str) – The name of the MCP server.description (
Optional[str]) – The description of the MCP server.enable_webhook_updates (
Union[bool,IResolvable,None]) – When set to true, enables the Agent Space to create and update webhooks for receiving notifications and events from the service.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_devopsagent as devopsagent m_cPServer_splunk_configuration_property = devopsagent.CfnAssociation.MCPServerSplunkConfigurationProperty( endpoint="endpoint", name="name", # the properties below are optional description="description", enable_webhook_updates=False )
Attributes
- description
The description of the MCP server.
- enable_webhook_updates
When set to true, enables the Agent Space to create and update webhooks for receiving notifications and events from the service.
- endpoint
MCP server endpoint URL.
ServiceConfigurationProperty
- class CfnAssociation.ServiceConfigurationProperty(*, aws=None, dynatrace=None, event_channel=None, git_hub=None, git_lab=None, mcp_server=None, mcp_server_datadog=None, mcp_server_new_relic=None, mcp_server_splunk=None, service_now=None, slack=None, source_aws=None)
Bases:
objectThe configuration that directs how Agent Space interacts with the given service.
You can specify only one configuration type per association.
- Parameters:
aws (
Union[IResolvable,AWSConfigurationProperty,Dict[str,Any],None]) – Configuration for AWS monitor account integration. Specifies the account ID, assumable role ARN, and resources to be monitored in the primary monitoring account.dynatrace (
Union[IResolvable,DynatraceConfigurationProperty,Dict[str,Any],None]) – Configuration for Dynatrace monitoring integration. Specifies the environment ID, resources to monitor, and webhook settings to enable the Agent Space to access Dynatrace metrics, traces, and logs.event_channel (
Union[IResolvable,EventChannelConfigurationProperty,Dict[str,Any],None]) – Configuration for Event Channel integration. Specifies webhook settings to enable the Agent Space to receive and process real-time events from external systems.git_hub (
Union[IResolvable,GitHubConfigurationProperty,Dict[str,Any],None]) – Configuration for GitHub repository integration. Specifies the repository name, repository ID, owner, and owner type to enable the Agent Space to access code, pull requests, and issues.git_lab (
Union[IResolvable,GitLabConfigurationProperty,Dict[str,Any],None]) – Configuration for GitLab project integration. Specifies the project ID, project path, instance identifier, and webhook settings to enable the Agent Space to access code, merge requests, and issues.mcp_server (
Union[IResolvable,MCPServerConfigurationProperty,Dict[str,Any],None]) – Configuration for custom MCP (Model Context Protocol) server integration. Specifies the server name, endpoint URL, available tools, description, and webhook settings to enable the Agent Space to interact with custom MCP servers.mcp_server_datadog (
Union[IResolvable,MCPServerDatadogConfigurationProperty,Dict[str,Any],None]) – Configuration for Datadog MCP server integration. Specifies the server name, endpoint URL, optional description, and webhook settings to enable the Agent Space to query metrics, traces, and logs from Datadog.mcp_server_new_relic (
Union[IResolvable,MCPServerNewRelicConfigurationProperty,Dict[str,Any],None]) – Configuration for New Relic MCP server integration. Specifies the New Relic account ID and MCP endpoint URL to enable the Agent Space to query metrics, traces, and logs from New Relic.mcp_server_splunk (
Union[IResolvable,MCPServerSplunkConfigurationProperty,Dict[str,Any],None]) – Configuration for Splunk MCP server integration. Specifies the server name, endpoint URL, optional description, and webhook settings to enable the Agent Space to query logs, metrics, and events from Splunk.service_now (
Union[IResolvable,ServiceNowConfigurationProperty,Dict[str,Any],None]) – Configuration for ServiceNow instance integration. Specifies the instance URL, instance ID, and webhook settings to enable the Agent Space to create, update, and manage ServiceNow incidents and change requests.slack (
Union[IResolvable,SlackConfigurationProperty,Dict[str,Any],None]) – Configuration for Slack workspace integration. Specifies the workspace ID, workspace name, and transmission targets to enable the Agent Space to send notifications to designated Slack channels.source_aws (
Union[IResolvable,SourceAwsConfigurationProperty,Dict[str,Any],None]) – Configuration for AWS source account integration. Specifies the account ID, assumable role ARN, and resources to be monitored in the source account.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_devopsagent as devopsagent # resource_metadata: Any service_configuration_property = devopsagent.CfnAssociation.ServiceConfigurationProperty( aws=devopsagent.CfnAssociation.AWSConfigurationProperty( account_id="accountId", account_type="accountType", assumable_role_arn="assumableRoleArn", # the properties below are optional resources=[devopsagent.CfnAssociation.AWSResourceProperty( resource_arn="resourceArn", # the properties below are optional resource_metadata=resource_metadata, resource_type="resourceType" )], tags=[devopsagent.CfnAssociation.KeyValuePairProperty( key="key", value="value" )] ), dynatrace=devopsagent.CfnAssociation.DynatraceConfigurationProperty( env_id="envId", # the properties below are optional enable_webhook_updates=False, resources=["resources"] ), event_channel=devopsagent.CfnAssociation.EventChannelConfigurationProperty( enable_webhook_updates=False ), git_hub=devopsagent.CfnAssociation.GitHubConfigurationProperty( owner="owner", owner_type="ownerType", repo_id="repoId", repo_name="repoName" ), git_lab=devopsagent.CfnAssociation.GitLabConfigurationProperty( project_id="projectId", project_path="projectPath", # the properties below are optional enable_webhook_updates=False, instance_identifier="instanceIdentifier" ), mcp_server=devopsagent.CfnAssociation.MCPServerConfigurationProperty( endpoint="endpoint", name="name", tools=["tools"], # the properties below are optional description="description", enable_webhook_updates=False ), mcp_server_datadog=devopsagent.CfnAssociation.MCPServerDatadogConfigurationProperty( endpoint="endpoint", name="name", # the properties below are optional description="description", enable_webhook_updates=False ), mcp_server_new_relic=devopsagent.CfnAssociation.MCPServerNewRelicConfigurationProperty( account_id="accountId", endpoint="endpoint" ), mcp_server_splunk=devopsagent.CfnAssociation.MCPServerSplunkConfigurationProperty( endpoint="endpoint", name="name", # the properties below are optional description="description", enable_webhook_updates=False ), service_now=devopsagent.CfnAssociation.ServiceNowConfigurationProperty( enable_webhook_updates=False, instance_id="instanceId" ), slack=devopsagent.CfnAssociation.SlackConfigurationProperty( transmission_target=devopsagent.CfnAssociation.SlackTransmissionTargetProperty( incident_response_target=devopsagent.CfnAssociation.SlackChannelProperty( channel_id="channelId", # the properties below are optional channel_name="channelName" ) ), workspace_id="workspaceId", workspace_name="workspaceName" ), source_aws=devopsagent.CfnAssociation.SourceAwsConfigurationProperty( account_id="accountId", account_type="accountType", assumable_role_arn="assumableRoleArn", # the properties below are optional resources=[devopsagent.CfnAssociation.AWSResourceProperty( resource_arn="resourceArn", # the properties below are optional resource_metadata=resource_metadata, resource_type="resourceType" )], tags=[devopsagent.CfnAssociation.KeyValuePairProperty( key="key", value="value" )] ) )
Attributes
- aws
Configuration for AWS monitor account integration.
Specifies the account ID, assumable role ARN, and resources to be monitored in the primary monitoring account.
- dynatrace
Configuration for Dynatrace monitoring integration.
Specifies the environment ID, resources to monitor, and webhook settings to enable the Agent Space to access Dynatrace metrics, traces, and logs.
- event_channel
Configuration for Event Channel integration.
Specifies webhook settings to enable the Agent Space to receive and process real-time events from external systems.
- git_hub
Configuration for GitHub repository integration.
Specifies the repository name, repository ID, owner, and owner type to enable the Agent Space to access code, pull requests, and issues.
- git_lab
Configuration for GitLab project integration.
Specifies the project ID, project path, instance identifier, and webhook settings to enable the Agent Space to access code, merge requests, and issues.
- mcp_server
Configuration for custom MCP (Model Context Protocol) server integration.
Specifies the server name, endpoint URL, available tools, description, and webhook settings to enable the Agent Space to interact with custom MCP servers.
- mcp_server_datadog
Configuration for Datadog MCP server integration.
Specifies the server name, endpoint URL, optional description, and webhook settings to enable the Agent Space to query metrics, traces, and logs from Datadog.
- mcp_server_new_relic
Configuration for New Relic MCP server integration.
Specifies the New Relic account ID and MCP endpoint URL to enable the Agent Space to query metrics, traces, and logs from New Relic.
- mcp_server_splunk
Configuration for Splunk MCP server integration.
Specifies the server name, endpoint URL, optional description, and webhook settings to enable the Agent Space to query logs, metrics, and events from Splunk.
- service_now
Configuration for ServiceNow instance integration.
Specifies the instance URL, instance ID, and webhook settings to enable the Agent Space to create, update, and manage ServiceNow incidents and change requests.
- slack
Configuration for Slack workspace integration.
Specifies the workspace ID, workspace name, and transmission targets to enable the Agent Space to send notifications to designated Slack channels.
- source_aws
Configuration for AWS source account integration.
Specifies the account ID, assumable role ARN, and resources to be monitored in the source account.
ServiceNowConfigurationProperty
- class CfnAssociation.ServiceNowConfigurationProperty(*, enable_webhook_updates=None, instance_id=None)
Bases:
objectConfiguration for ServiceNow integration.
Defines the ServiceNow instance URL, instance ID, and webhook update settings required for the Agent Space to create, update, and manage incidents and change requests.
- Parameters:
enable_webhook_updates (
Union[bool,IResolvable,None]) – When set to true, enables the Agent Space to create and update webhooks for receiving notifications and events from the service.instance_id (
Optional[str]) – ServiceNow instance ID.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_devopsagent as devopsagent service_now_configuration_property = devopsagent.CfnAssociation.ServiceNowConfigurationProperty( enable_webhook_updates=False, instance_id="instanceId" )
Attributes
- enable_webhook_updates
When set to true, enables the Agent Space to create and update webhooks for receiving notifications and events from the service.
SlackChannelProperty
- class CfnAssociation.SlackChannelProperty(*, channel_id, channel_name=None)
Bases:
objectRepresents a Slack channel with its unique identifier and optional display name.
- Parameters:
channel_id (
str) – Slack channel ID.channel_name (
Optional[str]) – Slack channel name.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_devopsagent as devopsagent slack_channel_property = devopsagent.CfnAssociation.SlackChannelProperty( channel_id="channelId", # the properties below are optional channel_name="channelName" )
Attributes
- channel_id
Slack channel ID.
SlackConfigurationProperty
- class CfnAssociation.SlackConfigurationProperty(*, transmission_target, workspace_id, workspace_name)
Bases:
objectConfiguration for Slack workspace integration.
Defines the workspace ID, workspace name, and transmission targets that specify which Slack channels receive notifications.
- Parameters:
transmission_target (
Union[IResolvable,SlackTransmissionTargetProperty,Dict[str,Any]]) – Transmission targets for agent notifications.workspace_id (
str) – Associated Slack workspace ID.workspace_name (
str) – Associated Slack workspace name.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_devopsagent as devopsagent slack_configuration_property = devopsagent.CfnAssociation.SlackConfigurationProperty( transmission_target=devopsagent.CfnAssociation.SlackTransmissionTargetProperty( incident_response_target=devopsagent.CfnAssociation.SlackChannelProperty( channel_id="channelId", # the properties below are optional channel_name="channelName" ) ), workspace_id="workspaceId", workspace_name="workspaceName" )
Attributes
- transmission_target
Transmission targets for agent notifications.
- workspace_id
Associated Slack workspace ID.
- workspace_name
Associated Slack workspace name.
SlackTransmissionTargetProperty
- class CfnAssociation.SlackTransmissionTargetProperty(*, incident_response_target)
Bases:
objectDefines the Slack channels where different types of agent notifications will be sent.
- Parameters:
incident_response_target (
Union[IResolvable,SlackChannelProperty,Dict[str,Any]]) – Destination for AWS DevOps Agent Incident Response.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_devopsagent as devopsagent slack_transmission_target_property = devopsagent.CfnAssociation.SlackTransmissionTargetProperty( incident_response_target=devopsagent.CfnAssociation.SlackChannelProperty( channel_id="channelId", # the properties below are optional channel_name="channelName" ) )
Attributes
- incident_response_target
Destination for AWS DevOps Agent Incident Response.
SourceAwsConfigurationProperty
- class CfnAssociation.SourceAwsConfigurationProperty(*, account_id, account_type, assumable_role_arn, resources=None, tags=None)
Bases:
objectConfiguration for AWS source account integration.
Specifies the account ID, assumable role ARN, and resources to be monitored in the source account.
- Parameters:
account_id (
str) – Account ID corresponding to the provided resources.account_type (
str) – Account Type ‘source’ for AWS DevOps Agent monitoring.assumable_role_arn (
str) – Role ARN to be assumed by AWS DevOps Agent to operate on behalf of customer.resources (
Union[IResolvable,Sequence[Union[IResolvable,AWSResourceProperty,Dict[str,Any]]],None]) – List of resources to monitor.tags (
Optional[Sequence[Union[KeyValuePairProperty,Dict[str,Any]]]]) – List of tags as key-value pairs, used to identify resources for topology crawl.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_devopsagent as devopsagent # resource_metadata: Any source_aws_configuration_property = devopsagent.CfnAssociation.SourceAwsConfigurationProperty( account_id="accountId", account_type="accountType", assumable_role_arn="assumableRoleArn", # the properties below are optional resources=[devopsagent.CfnAssociation.AWSResourceProperty( resource_arn="resourceArn", # the properties below are optional resource_metadata=resource_metadata, resource_type="resourceType" )], tags=[devopsagent.CfnAssociation.KeyValuePairProperty( key="key", value="value" )] )
Attributes
- account_id
Account ID corresponding to the provided resources.
- account_type
Account Type ‘source’ for AWS DevOps Agent monitoring.
- assumable_role_arn
Role ARN to be assumed by AWS DevOps Agent to operate on behalf of customer.
- resources
List of resources to monitor.
- tags
List of tags as key-value pairs, used to identify resources for topology crawl.