AWS CDK Reference

Appearance

v2.274.0

CfnIntegrationProps Struct Added in v2.274.0 ​

Properties for defining a CfnIntegration.

Source
Generated code
Type last changed
v2.274.0 · 20 Oct 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_securityagent as securityagent } from 'aws-cdk-lib';
const cfnIntegrationProps: securityagent.CfnIntegrationProps = {
  displayName: 'displayName',
  provider: 'provider',

  // the properties below are optional
  kmsKeyId: 'kmsKeyId',
  privateConnectionName: 'privateConnectionName',
  providerInput: {
    bitbucket: {
      code: 'code',
      installationId: 'installationId',
      state: 'state',
      workspace: 'workspace',
    },
    confluence: {
      code: 'code',
      installationId: 'installationId',
      siteUrl: 'siteUrl',
      state: 'state',
    },
    github: {
      code: 'code',
      state: 'state',

      // the properties below are optional
      installationId: 'installationId',
      organizationName: 'organizationName',
      targetUrl: 'targetUrl',
    },
    gitlab: {
      accessToken: 'accessToken',
      tokenType: 'tokenType',

      // the properties below are optional
      groupId: 'groupId',
      targetUrl: 'targetUrl',
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

displayNamestringdisplay_namestrdisplayNameStringDisplayNamestringDisplayName*stringrequired#
The display name for the integration.
kmsKeyIdstringkms_key_idstrkmsKeyIdStringKmsKeyIdstringKmsKeyId*string#
The identifier of the AWS KMS key to use for encrypting data associated with the integration.

Can be a key ID, key ARN, alias name, or alias ARN.

privateConnectionNamestringprivate_connection_namestrprivateConnectionNameStringPrivateConnectionNamestringPrivateConnectionName*string#
The name of an active private connection used to reach a self-hosted provider instance over private networking.
providerstringproviderstrproviderStringProviderstringProvider*stringrequired#
The integration provider.
providerInputIResolvable | CfnIntegration.ProviderInputPropertyprovider_inputtyping.Union[IResolvable, ProviderInputProperty]providerInputIResolvableProviderInputIResolvableProviderInputinterface{}#
The provider-specific input required to create the integration.

Exactly one of the provider input objects must be specified.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
The tags to associate with the integration.