CfnIntegrationProps Struct
Properties for defining a CfnIntegration.
| Source | |
|---|---|
| Type last changed |
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',
}],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_securityagent as securityagent
cfn_integration_props = securityagent.CfnIntegrationProps(
display_name="displayName",
provider="provider",
# the properties below are optional
kms_key_id="kmsKeyId",
private_connection_name="privateConnectionName",
provider_input=securityagent.CfnIntegration.ProviderInputProperty(
bitbucket=securityagent.CfnIntegration.BitbucketInputProperty(
code="code",
installation_id="installationId",
state="state",
workspace="workspace"
),
confluence=securityagent.CfnIntegration.ConfluenceInputProperty(
code="code",
installation_id="installationId",
site_url="siteUrl",
state="state"
),
github=securityagent.CfnIntegration.GitHubInputProperty(
code="code",
state="state",
# the properties below are optional
installation_id="installationId",
organization_name="organizationName",
target_url="targetUrl"
),
gitlab=securityagent.CfnIntegration.GitLabInputProperty(
access_token="accessToken",
token_type="tokenType",
# the properties below are optional
group_id="groupId",
target_url="targetUrl"
)
),
tags=[CfnTag(
key="key",
value="value"
)]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.securityagent.*;
CfnIntegrationProps cfnIntegrationProps = CfnIntegrationProps.builder()
.displayName("displayName")
.provider("provider")
// the properties below are optional
.kmsKeyId("kmsKeyId")
.privateConnectionName("privateConnectionName")
.providerInput(ProviderInputProperty.builder()
.bitbucket(BitbucketInputProperty.builder()
.code("code")
.installationId("installationId")
.state("state")
.workspace("workspace")
.build())
.confluence(ConfluenceInputProperty.builder()
.code("code")
.installationId("installationId")
.siteUrl("siteUrl")
.state("state")
.build())
.github(GitHubInputProperty.builder()
.code("code")
.state("state")
// the properties below are optional
.installationId("installationId")
.organizationName("organizationName")
.targetUrl("targetUrl")
.build())
.gitlab(GitLabInputProperty.builder()
.accessToken("accessToken")
.tokenType("tokenType")
// the properties below are optional
.groupId("groupId")
.targetUrl("targetUrl")
.build())
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SecurityAgent;
var cfnIntegrationProps = new CfnIntegrationProps {
DisplayName = "displayName",
Provider = "provider",
// the properties below are optional
KmsKeyId = "kmsKeyId",
PrivateConnectionName = "privateConnectionName",
ProviderInput = new ProviderInputProperty {
Bitbucket = new BitbucketInputProperty {
Code = "code",
InstallationId = "installationId",
State = "state",
Workspace = "workspace"
},
Confluence = new ConfluenceInputProperty {
Code = "code",
InstallationId = "installationId",
SiteUrl = "siteUrl",
State = "state"
},
Github = new GitHubInputProperty {
Code = "code",
State = "state",
// the properties below are optional
InstallationId = "installationId",
OrganizationName = "organizationName",
TargetUrl = "targetUrl"
},
Gitlab = new GitLabInputProperty {
AccessToken = "accessToken",
TokenType = "tokenType",
// the properties below are optional
GroupId = "groupId",
TargetUrl = "targetUrl"
}
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnIntegrationProps := &CfnIntegrationProps{
DisplayName: jsii.String("displayName"),
Provider: jsii.String("provider"),
// the properties below are optional
KmsKeyId: jsii.String("kmsKeyId"),
PrivateConnectionName: jsii.String("privateConnectionName"),
ProviderInput: &ProviderInputProperty{
Bitbucket: &BitbucketInputProperty{
Code: jsii.String("code"),
InstallationId: jsii.String("installationId"),
State: jsii.String("state"),
Workspace: jsii.String("workspace"),
},
Confluence: &ConfluenceInputProperty{
Code: jsii.String("code"),
InstallationId: jsii.String("installationId"),
SiteUrl: jsii.String("siteUrl"),
State: jsii.String("state"),
},
Github: &GitHubInputProperty{
Code: jsii.String("code"),
State: jsii.String("state"),
// the properties below are optional
InstallationId: jsii.String("installationId"),
OrganizationName: jsii.String("organizationName"),
TargetUrl: jsii.String("targetUrl"),
},
Gitlab: &GitLabInputProperty{
AccessToken: jsii.String("accessToken"),
TokenType: jsii.String("tokenType"),
// the properties below are optional
GroupId: jsii.String("groupId"),
TargetUrl: jsii.String("targetUrl"),
},
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
Properties
The display name for the integration.
kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*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.
privateConnectionNameoptionalstringprivate_connection_nameoptionalstrprivateConnectionNameoptionalStringPrivateConnectionNameoptionalstringPrivateConnectionNameoptional*string #The name of an active private connection used to reach a self-hosted provider instance over private networking.
The integration provider.
providerInputoptionalIResolvable | CfnIntegration.provider_inputoptionaltyping.Union[IResolvable, ProviderInputProperty]providerInputoptionalIResolvableProviderInputoptionalIResolvableProviderInputoptionalinterface{} #The provider-specific input required to create the integration.
Exactly one of the provider input objects must be specified.