CfnConnectionProps

class aws_cdk.aws_datazone.CfnConnectionProps(*, domain_identifier, name, aws_location=None, description=None, enable_trusted_identity_propagation=None, environment_identifier=None, project_identifier=None, props=None, scope=None)

Bases: object

Properties for defining a CfnConnection.

Parameters:

domain_identifier (str) – The ID of the domain where the connection is created.
name (str) – The name of the connection.
aws_location (Union[IResolvable, AwsLocationProperty, Dict[str, Any], None]) – The location where the connection is created.
description (Optional[str]) – Connection description.
enable_trusted_identity_propagation (Union[bool, IResolvable, None]) – Specifies whether the trusted identity propagation is enabled.
environment_identifier (Optional[str]) – The ID of the environment where the connection is created.
project_identifier (Optional[str]) – The identifier of the project in which the connection should be created. If
props (Union[IResolvable, ConnectionPropertiesInputProperty, Dict[str, Any], None]) – Connection props.
scope (Optional[str]) – The scope of the connection.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

cfn_connection_props = datazone.CfnConnectionProps(
    domain_identifier="domainIdentifier",
    name="name",

    # the properties below are optional
    aws_location=datazone.CfnConnection.AwsLocationProperty(
        access_role="accessRole",
        aws_account_id="awsAccountId",
        aws_region="awsRegion",
        iam_connection_id="iamConnectionId"
    ),
    description="description",
    enable_trusted_identity_propagation=False,
    environment_identifier="environmentIdentifier",
    project_identifier="projectIdentifier",
    props=datazone.CfnConnection.ConnectionPropertiesInputProperty(
        amazon_qProperties=datazone.CfnConnection.AmazonQPropertiesInputProperty(
            auth_mode="authMode",
            is_enabled=False,
            profile_arn="profileArn"
        ),
        athena_properties=datazone.CfnConnection.AthenaPropertiesInputProperty(
            workgroup_name="workgroupName"
        ),
        glue_properties=datazone.CfnConnection.GluePropertiesInputProperty(
            glue_connection_input=datazone.CfnConnection.GlueConnectionInputProperty(
                athena_properties={
                    "athena_properties_key": "athenaProperties"
                },
                authentication_configuration=datazone.CfnConnection.AuthenticationConfigurationInputProperty(
                    authentication_type="authenticationType",
                    basic_authentication_credentials=datazone.CfnConnection.BasicAuthenticationCredentialsProperty(
                        password="password",
                        user_name="userName"
                    ),
                    custom_authentication_credentials={
                        "custom_authentication_credentials_key": "customAuthenticationCredentials"
                    },
                    kms_key_arn="kmsKeyArn",
                    o_auth2_properties=datazone.CfnConnection.OAuth2PropertiesProperty(
                        authorization_code_properties=datazone.CfnConnection.AuthorizationCodePropertiesProperty(
                            authorization_code="authorizationCode",
                            redirect_uri="redirectUri"
                        ),
                        o_auth2_client_application=datazone.CfnConnection.OAuth2ClientApplicationProperty(
                            aws_managed_client_application_reference="awsManagedClientApplicationReference",
                            user_managed_client_application_client_id="userManagedClientApplicationClientId"
                        ),
                        o_auth2_credentials=datazone.CfnConnection.GlueOAuth2CredentialsProperty(
                            access_token="accessToken",
                            jwt_token="jwtToken",
                            refresh_token="refreshToken",
                            user_managed_client_application_client_secret="userManagedClientApplicationClientSecret"
                        ),
                        o_auth2_grant_type="oAuth2GrantType",
                        token_url="tokenUrl",
                        token_url_parameters_map={
                            "token_url_parameters_map_key": "tokenUrlParametersMap"
                        }
                    ),
                    secret_arn="secretArn"
                ),
                connection_properties={
                    "connection_properties_key": "connectionProperties"
                },
                connection_type="connectionType",
                description="description",
                match_criteria="matchCriteria",
                name="name",
                physical_connection_requirements=datazone.CfnConnection.PhysicalConnectionRequirementsProperty(
                    availability_zone="availabilityZone",
                    security_group_id_list=["securityGroupIdList"],
                    subnet_id="subnetId",
                    subnet_id_list=["subnetIdList"]
                ),
                python_properties={
                    "python_properties_key": "pythonProperties"
                },
                spark_properties={
                    "spark_properties_key": "sparkProperties"
                },
                validate_credentials=False,
                validate_for_compute_environments=["validateForComputeEnvironments"]
            )
        ),
        hyper_pod_properties=datazone.CfnConnection.HyperPodPropertiesInputProperty(
            cluster_name="clusterName"
        ),
        iam_properties=datazone.CfnConnection.IamPropertiesInputProperty(
            glue_lineage_sync_enabled=False
        ),
        redshift_properties=datazone.CfnConnection.RedshiftPropertiesInputProperty(
            credentials=datazone.CfnConnection.RedshiftCredentialsProperty(
                secret_arn="secretArn",
                username_password=datazone.CfnConnection.UsernamePasswordProperty(
                    password="password",
                    username="username"
                )
            ),
            database_name="databaseName",
            host="host",
            lineage_sync=datazone.CfnConnection.RedshiftLineageSyncConfigurationInputProperty(
                enabled=False,
                schedule=datazone.CfnConnection.LineageSyncScheduleProperty(
                    schedule="schedule"
                )
            ),
            port=123,
            storage=datazone.CfnConnection.RedshiftStoragePropertiesProperty(
                cluster_name="clusterName",
                workgroup_name="workgroupName"
            )
        ),
        s3_properties=datazone.CfnConnection.S3PropertiesInputProperty(
            s3_uri="s3Uri",

            # the properties below are optional
            s3_access_grant_location_id="s3AccessGrantLocationId"
        ),
        spark_emr_properties=datazone.CfnConnection.SparkEmrPropertiesInputProperty(
            compute_arn="computeArn",
            instance_profile_arn="instanceProfileArn",
            java_virtual_env="javaVirtualEnv",
            log_uri="logUri",
            python_virtual_env="pythonVirtualEnv",
            runtime_role="runtimeRole",
            trusted_certificates_s3_uri="trustedCertificatesS3Uri"
        ),
        spark_glue_properties=datazone.CfnConnection.SparkGluePropertiesInputProperty(
            additional_args=datazone.CfnConnection.SparkGlueArgsProperty(
                connection="connection"
            ),
            glue_connection_name="glueConnectionName",
            glue_version="glueVersion",
            idle_timeout=123,
            java_virtual_env="javaVirtualEnv",
            number_of_workers=123,
            python_virtual_env="pythonVirtualEnv",
            worker_type="workerType"
        )
    ),
    scope="scope"
)