Skip to content
v2.274.0

CfnAssociationProps Struct ​

Properties for defining a CfnAssociation.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_devopsagent as devopsagent } from 'aws-cdk-lib';

declare const resourceMetadata: any;
const cfnAssociationProps: devopsagent.CfnAssociationProps = {
  agentSpaceId: 'agentSpaceId',
  configuration: {
    aws: {
      accountId: 'accountId',
      accountType: 'accountType',
      assumableRoleArn: 'assumableRoleArn',

      // the properties below are optional
      agentElevatedRoleArn: 'agentElevatedRoleArn',
      resources: [{
        resourceArn: 'resourceArn',

        // the properties below are optional
        resourceMetadata: resourceMetadata,
        resourceType: 'resourceType',
      }],
      tags: [{
        key: 'key',
        value: 'value',
      }],
    },
    azure: {
      subscriptionId: 'subscriptionId',
    },
    dynatrace: {
      envId: 'envId',

      // the properties below are optional
      enableWebhookUpdates: false,
      resources: ['resources'],
    },
    eventChannel: {
      enableWebhookUpdates: false,
    },
    gitHub: {
      owner: 'owner',
      ownerType: 'ownerType',
      repoId: 'repoId',
      repoName: 'repoName',
    },
    gitLab: {
      projectId: 'projectId',
      projectPath: 'projectPath',

      // the properties below are optional
      enableWebhookUpdates: false,
      instanceIdentifier: 'instanceIdentifier',
    },
    mcpServer: {
      tools: ['tools'],

      // the properties below are optional
      description: 'description',
      enableWebhookUpdates: false,
      endpoint: 'endpoint',
      name: 'name',
    },
    mcpServerDatadog: {
      description: 'description',
      enabledElevatedTools: ['enabledElevatedTools'],
      enableWebhookUpdates: false,
      endpoint: 'endpoint',
      name: 'name',
    },
    mcpServerGrafana: {
      endpoint: 'endpoint',

      // the properties below are optional
      enabledElevatedTools: ['enabledElevatedTools'],
      enableWebhookUpdates: false,
      tools: ['tools'],
    },
    mcpServerNewRelic: {
      accountId: 'accountId',
      endpoint: 'endpoint',
    },
    mcpServerSigV4: {
      tools: ['tools'],
    },
    mcpServerSplunk: {
      description: 'description',
      enableWebhookUpdates: false,
      endpoint: 'endpoint',
      name: 'name',
    },
    pagerDuty: {
      customerEmail: 'customerEmail',
      services: ['services'],

      // the properties below are optional
      enableWebhookUpdates: false,
    },
    serviceNow: {
      enableWebhookUpdates: false,
      instanceId: 'instanceId',
    },
    slack: {
      transmissionTarget: {
        incidentResponseTarget: {
          channelId: 'channelId',

          // the properties below are optional
          channelName: 'channelName',
        },
      },
      workspaceId: 'workspaceId',
      workspaceName: 'workspaceName',

      // the properties below are optional
      bidirectional: {
        roleArn: 'roleArn',

        // the properties below are optional
        enabled: false,
      },
    },
    sourceAws: {
      accountId: 'accountId',
      accountType: 'accountType',
      assumableRoleArn: 'assumableRoleArn',

      // the properties below are optional
      agentElevatedRoleArn: 'agentElevatedRoleArn',
      resources: [{
        resourceArn: 'resourceArn',

        // the properties below are optional
        resourceMetadata: resourceMetadata,
        resourceType: 'resourceType',
      }],
      tags: [{
        key: 'key',
        value: 'value',
      }],
    },
  },
  serviceId: 'serviceId',

  // the properties below are optional
  linkedAssociationIds: ['linkedAssociationIds'],
};

Properties ​

agentSpaceIdstringagent_space_idstragentSpaceIdStringAgentSpaceIdstringAgentSpaceId*stringrequired#
The unique identifier of the Agent Space.
configurationIResolvable | CfnAssociation.ServiceConfigurationPropertyconfigurationtyping.Union[IResolvable, ServiceConfigurationProperty]configurationIResolvableConfigurationIResolvableConfigurationinterface{}required#
The configuration that directs how the Agent Space interacts with the given service.
notes

You can specify only one configuration type per association.

Allowed Values : SourceAws | Aws | GitHub | GitLab | Slack | Dynatrace | ServiceNow | MCPServer | MCPServerNewRelic | MCPServerDatadog | MCPServerSplunk | EventChannel

linkedAssociationIdsoptionalstring[]linked_association_idsoptionaltyping.List[str]linkedAssociationIdsoptionalList<String>LinkedAssociationIdsoptionalstring[]LinkedAssociationIdsoptional*[]*string#
Set of linked association IDs for parent-child relationships.
serviceIdstringservice_idstrserviceIdStringServiceIdstringServiceId*stringrequired#
The identifier for the associated service.

For SourceAws and Aws configurations, this must be aws . For all other service types, this is a UUID generated from the RegisterService command.