CfnConnectionProps Struct
Properties for defining a CfnConnection.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_datazone as datazone } from 'aws-cdk-lib';
declare const workflowsServerlessProperties: any;
const cfnConnectionProps: datazone.CfnConnectionProps = {
domainIdentifier: 'domainIdentifier',
name: 'name',
// the properties below are optional
awsLocation: {
accessRole: 'accessRole',
awsAccountId: 'awsAccountId',
awsRegion: 'awsRegion',
iamConnectionId: 'iamConnectionId',
},
configurations: [{
classification: 'classification',
properties: {
propertiesKey: 'properties',
},
}],
description: 'description',
enableTrustedIdentityPropagation: false,
environmentIdentifier: 'environmentIdentifier',
projectIdentifier: 'projectIdentifier',
props: {
amazonQProperties: {
authMode: 'authMode',
isEnabled: false,
profileArn: 'profileArn',
},
athenaProperties: {
workgroupName: 'workgroupName',
},
glueProperties: {
glueConnectionInput: {
athenaProperties: {
athenaPropertiesKey: 'athenaProperties',
},
authenticationConfiguration: {
authenticationType: 'authenticationType',
basicAuthenticationCredentials: {
password: 'password',
userName: 'userName',
},
customAuthenticationCredentials: {
customAuthenticationCredentialsKey: 'customAuthenticationCredentials',
},
kmsKeyArn: 'kmsKeyArn',
oAuth2Properties: {
authorizationCodeProperties: {
authorizationCode: 'authorizationCode',
redirectUri: 'redirectUri',
},
oAuth2ClientApplication: {
awsManagedClientApplicationReference: 'awsManagedClientApplicationReference',
userManagedClientApplicationClientId: 'userManagedClientApplicationClientId',
},
oAuth2Credentials: {
accessToken: 'accessToken',
jwtToken: 'jwtToken',
refreshToken: 'refreshToken',
userManagedClientApplicationClientSecret: 'userManagedClientApplicationClientSecret',
},
oAuth2GrantType: 'oAuth2GrantType',
tokenUrl: 'tokenUrl',
tokenUrlParametersMap: {
tokenUrlParametersMapKey: 'tokenUrlParametersMap',
},
},
secretArn: 'secretArn',
},
connectionProperties: {
connectionPropertiesKey: 'connectionProperties',
},
connectionType: 'connectionType',
description: 'description',
matchCriteria: 'matchCriteria',
name: 'name',
physicalConnectionRequirements: {
availabilityZone: 'availabilityZone',
securityGroupIdList: ['securityGroupIdList'],
subnetId: 'subnetId',
subnetIdList: ['subnetIdList'],
},
pythonProperties: {
pythonPropertiesKey: 'pythonProperties',
},
sparkProperties: {
sparkPropertiesKey: 'sparkProperties',
},
validateCredentials: false,
validateForComputeEnvironments: ['validateForComputeEnvironments'],
},
},
hyperPodProperties: {
clusterName: 'clusterName',
},
iamProperties: {
glueLineageSyncEnabled: false,
roleArn: 'roleArn',
},
lakehouseProperties: {
glueLineageSyncEnabled: false,
},
mlflowProperties: {
trackingServerArn: 'trackingServerArn',
},
redshiftProperties: {
credentials: {
secretArn: 'secretArn',
usernamePassword: {
password: 'password',
username: 'username',
},
},
databaseName: 'databaseName',
host: 'host',
lineageSync: {
enabled: false,
schedule: {
schedule: 'schedule',
},
},
port: 123,
storage: {
clusterName: 'clusterName',
workgroupName: 'workgroupName',
},
},
s3Properties: {
s3Uri: 's3Uri',
// the properties below are optional
registerS3AccessGrantLocation: false,
s3AccessGrantLocationId: 's3AccessGrantLocationId',
},
sparkEmrProperties: {
computeArn: 'computeArn',
instanceProfileArn: 'instanceProfileArn',
javaVirtualEnv: 'javaVirtualEnv',
logUri: 'logUri',
managedEndpointArn: 'managedEndpointArn',
pythonVirtualEnv: 'pythonVirtualEnv',
runtimeRole: 'runtimeRole',
trustedCertificatesS3Uri: 'trustedCertificatesS3Uri',
},
sparkGlueProperties: {
additionalArgs: {
connection: 'connection',
},
glueConnectionName: 'glueConnectionName',
glueVersion: 'glueVersion',
idleTimeout: 123,
javaVirtualEnv: 'javaVirtualEnv',
numberOfWorkers: 123,
pythonVirtualEnv: 'pythonVirtualEnv',
workerType: 'workerType',
},
workflowsMwaaProperties: {
mwaaEnvironmentName: 'mwaaEnvironmentName',
},
workflowsServerlessProperties: workflowsServerlessProperties,
},
scope: 'scope',
};
Properties
awsLocationoptionalIResolvable | CfnConnection.AwsLocationPropertyaws_locationoptionaltyping.Union[IResolvable, AwsLocationProperty]awsLocationoptionalIResolvableAwsLocationoptionalIResolvableAwsLocationoptionalinterface{}#The location where the connection is created.
configurationsoptionalIResolvable | IResolvable | CfnConnection.ConnectionConfigurationProperty[]configurationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ConnectionConfigurationProperty]]]configurationsoptionalIResolvableConfigurationsoptionalIResolvableConfigurationsoptionalinterface{}#The configurations of the connection.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#Connection description.
domainIdentifierstringdomain_identifierstrdomainIdentifierStringDomainIdentifierstringDomainIdentifier*stringrequired#The ID of the domain where the connection is created.
enableTrustedIdentityPropagationoptionalboolean | IResolvableenable_trusted_identity_propagationoptionaltyping.Union[bool, IResolvable]enableTrustedIdentityPropagationoptionalBooleanEnableTrustedIdentityPropagationoptionalboolEnableTrustedIdentityPropagationoptionalinterface{}#Specifies whether the trusted identity propagation is enabled.
environmentIdentifieroptionalstringenvironment_identifieroptionalstrenvironmentIdentifieroptionalStringEnvironmentIdentifieroptionalstringEnvironmentIdentifieroptional*string#The ID of the environment where the connection is created.
The name of the connection.
projectIdentifieroptionalstringproject_identifieroptionalstrprojectIdentifieroptionalStringProjectIdentifieroptionalstringProjectIdentifieroptional*string#The identifier of the project in which the connection should be created.
If
propsoptionalIResolvable | CfnConnection.ConnectionPropertiesInputPropertypropsoptionaltyping.Union[IResolvable, ConnectionPropertiesInputProperty]propsoptionalIResolvablePropsoptionalIResolvablePropsoptionalinterface{}#Connection props.
The scope of the connection.