Interface ICfnConnectionProps
Properties for defining a CfnConnection.
Namespace: Amazon.CDK.AWS.DataZone
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnConnectionPropsSyntax (vb)
Public Interface ICfnConnectionPropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DataZone;
var workflowsServerlessProperties;
var cfnConnectionProps = new CfnConnectionProps {
DomainIdentifier = "domainIdentifier",
Name = "name",
// the properties below are optional
AwsLocation = new AwsLocationProperty {
AccessRole = "accessRole",
AwsAccountId = "awsAccountId",
AwsRegion = "awsRegion",
IamConnectionId = "iamConnectionId"
},
Configurations = new [] { new ConnectionConfigurationProperty {
Classification = "classification",
Properties = new Dictionary<string, string> {
{ "propertiesKey", "properties" }
}
} },
Description = "description",
EnableTrustedIdentityPropagation = false,
EnvironmentIdentifier = "environmentIdentifier",
ProjectIdentifier = "projectIdentifier",
Props = new ConnectionPropertiesInputProperty {
AmazonQProperties = new AmazonQPropertiesInputProperty {
AuthMode = "authMode",
IsEnabled = false,
ProfileArn = "profileArn"
},
AthenaProperties = new AthenaPropertiesInputProperty {
WorkgroupName = "workgroupName"
},
GlueProperties = new GluePropertiesInputProperty {
GlueConnectionInput = new GlueConnectionInputProperty {
AthenaProperties = new Dictionary<string, string> {
{ "athenaPropertiesKey", "athenaProperties" }
},
AuthenticationConfiguration = new AuthenticationConfigurationInputProperty {
AuthenticationType = "authenticationType",
BasicAuthenticationCredentials = new BasicAuthenticationCredentialsProperty {
Password = "password",
UserName = "userName"
},
CustomAuthenticationCredentials = new Dictionary<string, string> {
{ "customAuthenticationCredentialsKey", "customAuthenticationCredentials" }
},
KmsKeyArn = "kmsKeyArn",
OAuth2Properties = new OAuth2PropertiesProperty {
AuthorizationCodeProperties = new AuthorizationCodePropertiesProperty {
AuthorizationCode = "authorizationCode",
RedirectUri = "redirectUri"
},
OAuth2ClientApplication = new OAuth2ClientApplicationProperty {
AwsManagedClientApplicationReference = "awsManagedClientApplicationReference",
UserManagedClientApplicationClientId = "userManagedClientApplicationClientId"
},
OAuth2Credentials = new GlueOAuth2CredentialsProperty {
AccessToken = "accessToken",
JwtToken = "jwtToken",
RefreshToken = "refreshToken",
UserManagedClientApplicationClientSecret = "userManagedClientApplicationClientSecret"
},
OAuth2GrantType = "oAuth2GrantType",
TokenUrl = "tokenUrl",
TokenUrlParametersMap = new Dictionary<string, string> {
{ "tokenUrlParametersMapKey", "tokenUrlParametersMap" }
}
},
SecretArn = "secretArn"
},
ConnectionProperties = new Dictionary<string, string> {
{ "connectionPropertiesKey", "connectionProperties" }
},
ConnectionType = "connectionType",
Description = "description",
MatchCriteria = "matchCriteria",
Name = "name",
PhysicalConnectionRequirements = new PhysicalConnectionRequirementsProperty {
AvailabilityZone = "availabilityZone",
SecurityGroupIdList = new [] { "securityGroupIdList" },
SubnetId = "subnetId",
SubnetIdList = new [] { "subnetIdList" }
},
PythonProperties = new Dictionary<string, string> {
{ "pythonPropertiesKey", "pythonProperties" }
},
SparkProperties = new Dictionary<string, string> {
{ "sparkPropertiesKey", "sparkProperties" }
},
ValidateCredentials = false,
ValidateForComputeEnvironments = new [] { "validateForComputeEnvironments" }
}
},
HyperPodProperties = new HyperPodPropertiesInputProperty {
ClusterName = "clusterName"
},
IamProperties = new IamPropertiesInputProperty {
GlueLineageSyncEnabled = false
},
LakehouseProperties = new LakehousePropertiesInputProperty {
GlueLineageSyncEnabled = false
},
MlflowProperties = new MlflowPropertiesInputProperty {
TrackingServerArn = "trackingServerArn"
},
RedshiftProperties = new RedshiftPropertiesInputProperty {
Credentials = new RedshiftCredentialsProperty {
SecretArn = "secretArn",
UsernamePassword = new UsernamePasswordProperty {
Password = "password",
Username = "username"
}
},
DatabaseName = "databaseName",
Host = "host",
LineageSync = new RedshiftLineageSyncConfigurationInputProperty {
Enabled = false,
Schedule = new LineageSyncScheduleProperty {
Schedule = "schedule"
}
},
Port = 123,
Storage = new RedshiftStoragePropertiesProperty {
ClusterName = "clusterName",
WorkgroupName = "workgroupName"
}
},
S3Properties = new S3PropertiesInputProperty {
S3Uri = "s3Uri",
// the properties below are optional
RegisterS3AccessGrantLocation = false,
S3AccessGrantLocationId = "s3AccessGrantLocationId"
},
SparkEmrProperties = new SparkEmrPropertiesInputProperty {
ComputeArn = "computeArn",
InstanceProfileArn = "instanceProfileArn",
JavaVirtualEnv = "javaVirtualEnv",
LogUri = "logUri",
ManagedEndpointArn = "managedEndpointArn",
PythonVirtualEnv = "pythonVirtualEnv",
RuntimeRole = "runtimeRole",
TrustedCertificatesS3Uri = "trustedCertificatesS3Uri"
},
SparkGlueProperties = new SparkGluePropertiesInputProperty {
AdditionalArgs = new SparkGlueArgsProperty {
Connection = "connection"
},
GlueConnectionName = "glueConnectionName",
GlueVersion = "glueVersion",
IdleTimeout = 123,
JavaVirtualEnv = "javaVirtualEnv",
NumberOfWorkers = 123,
PythonVirtualEnv = "pythonVirtualEnv",
WorkerType = "workerType"
},
WorkflowsMwaaProperties = new WorkflowsMwaaPropertiesInputProperty {
MwaaEnvironmentName = "mwaaEnvironmentName"
},
WorkflowsServerlessProperties = workflowsServerlessProperties
},
Scope = "scope"
};Synopsis
Properties
| AwsLocation | The location where the connection is created. |
| Configurations | The configurations of the connection. |
| Description | Connection description. |
| DomainIdentifier | The ID of the domain where the connection is created. |
| EnableTrustedIdentityPropagation | Specifies whether the trusted identity propagation is enabled. |
| EnvironmentIdentifier | The ID of the environment where the connection is created. |
| Name | The name of the connection. |
| ProjectIdentifier | The identifier of the project in which the connection should be created. |
| Props | Connection props. |
| Scope | The scope of the connection. |
Properties
AwsLocation
The location where the connection is created.
object? AwsLocation { get; }Property Value
Remarks
Configurations
The configurations of the connection.
object? Configurations { get; }Property Value
Remarks
Description
Connection description.
string? Description { get; }Property Value
Remarks
DomainIdentifier
The ID of the domain where the connection is created.
string DomainIdentifier { get; }Property Value
Remarks
EnableTrustedIdentityPropagation
Specifies whether the trusted identity propagation is enabled.
object? EnableTrustedIdentityPropagation { get; }Property Value
Remarks
EnvironmentIdentifier
The ID of the environment where the connection is created.
string? EnvironmentIdentifier { get; }Property Value
Remarks
Name
The name of the connection.
string Name { get; }Property Value
Remarks
ProjectIdentifier
The identifier of the project in which the connection should be created.
string? ProjectIdentifier { get; }Property Value
Remarks
Props
Connection props.
object? Props { get; }Property Value
Remarks
Scope
The scope of the connection.
string? Scope { get; }