CfnDataSource

class aws_cdk.aws_datazone.CfnDataSource(scope, id, *, domain_identifier, environment_identifier, name, project_identifier, type, asset_forms_input=None, configuration=None, description=None, enable_setting=None, publish_on_import=None, recommendation=None, schedule=None)

Bases: CfnResource

The AWS::DataZone::DataSource resource specifies an Amazon DataZone data source that is used to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone.

See:

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

CloudformationResource:

AWS::DataZone::DataSource

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_data_source = datazone.CfnDataSource(self, "MyCfnDataSource",
    domain_identifier="domainIdentifier",
    environment_identifier="environmentIdentifier",
    name="name",
    project_identifier="projectIdentifier",
    type="type",

    # the properties below are optional
    asset_forms_input=[datazone.CfnDataSource.FormInputProperty(
        form_name="formName",

        # the properties below are optional
        content="content",
        type_identifier="typeIdentifier",
        type_revision="typeRevision"
    )],
    configuration=datazone.CfnDataSource.DataSourceConfigurationInputProperty(
        glue_run_configuration=datazone.CfnDataSource.GlueRunConfigurationInputProperty(
            relational_filter_configurations=[datazone.CfnDataSource.RelationalFilterConfigurationProperty(
                database_name="databaseName",

                # the properties below are optional
                filter_expressions=[datazone.CfnDataSource.FilterExpressionProperty(
                    expression="expression",
                    type="type"
                )],
                schema_name="schemaName"
            )],

            # the properties below are optional
            auto_import_data_quality_result=False,
            data_access_role="dataAccessRole"
        ),
        redshift_run_configuration=datazone.CfnDataSource.RedshiftRunConfigurationInputProperty(
            redshift_credential_configuration=datazone.CfnDataSource.RedshiftCredentialConfigurationProperty(
                secret_manager_arn="secretManagerArn"
            ),
            redshift_storage=datazone.CfnDataSource.RedshiftStorageProperty(
                redshift_cluster_source=datazone.CfnDataSource.RedshiftClusterStorageProperty(
                    cluster_name="clusterName"
                ),
                redshift_serverless_source=datazone.CfnDataSource.RedshiftServerlessStorageProperty(
                    workgroup_name="workgroupName"
                )
            ),
            relational_filter_configurations=[datazone.CfnDataSource.RelationalFilterConfigurationProperty(
                database_name="databaseName",

                # the properties below are optional
                filter_expressions=[datazone.CfnDataSource.FilterExpressionProperty(
                    expression="expression",
                    type="type"
                )],
                schema_name="schemaName"
            )],

            # the properties below are optional
            data_access_role="dataAccessRole"
        )
    ),
    description="description",
    enable_setting="enableSetting",
    publish_on_import=False,
    recommendation=datazone.CfnDataSource.RecommendationConfigurationProperty(
        enable_business_name_generation=False
    ),
    schedule=datazone.CfnDataSource.ScheduleConfigurationProperty(
        schedule="schedule",
        timezone="timezone"
    )
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • domain_identifier (str) – The ID of the Amazon DataZone domain where the data source is created.

  • environment_identifier (str) – The unique identifier of the Amazon DataZone environment to which the data source publishes assets.

  • name (str) – The name of the data source.

  • project_identifier (str) – The identifier of the Amazon DataZone project in which you want to add this data source.

  • type (str) – The type of the data source.

  • asset_forms_input (Union[IResolvable, Sequence[Union[IResolvable, FormInputProperty, Dict[str, Any]]], None]) – The metadata forms attached to the assets that the data source works with.

  • configuration (Union[IResolvable, DataSourceConfigurationInputProperty, Dict[str, Any], None]) – The configuration of the data source.

  • description (Optional[str]) – The description of the data source.

  • enable_setting (Optional[str]) – Specifies whether the data source is enabled.

  • publish_on_import (Union[bool, IResolvable, None]) – Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

  • recommendation (Union[IResolvable, RecommendationConfigurationProperty, Dict[str, Any], None]) – Specifies whether the business name generation is to be enabled for this data source.

  • schedule (Union[IResolvable, ScheduleConfigurationProperty, Dict[str, Any], None]) – The schedule of the data source runs.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::DataZone::DataSource'
asset_forms_input

The metadata forms attached to the assets that the data source works with.

attr_created_at

The timestamp of when the data source was created.

CloudformationAttribute:

CreatedAt

attr_domain_id

The ID of the Amazon DataZone domain in which the data source exists.

CloudformationAttribute:

DomainId

attr_environment_id

The ID of the environment in which the data source exists.

CloudformationAttribute:

EnvironmentId

attr_id

The identifier of the data source run.

CloudformationAttribute:

Id

attr_last_run_asset_count

The count of the assets created during the last data source run.

CloudformationAttribute:

LastRunAssetCount

attr_last_run_at

The timestamp of when the data source run was last performed.

CloudformationAttribute:

LastRunAt

attr_last_run_status

The status of the last data source run.

CloudformationAttribute:

LastRunStatus

attr_project_id

The project ID included in the data source run activity.

CloudformationAttribute:

ProjectId

attr_status

The status of the data source.

CloudformationAttribute:

Status

attr_updated_at

The timestamp of when the data source was updated.

CloudformationAttribute:

UpdatedAt

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

configuration

The configuration of the data source.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

The description of the data source.

domain_identifier

The ID of the Amazon DataZone domain where the data source is created.

enable_setting

Specifies whether the data source is enabled.

environment_identifier

The unique identifier of the Amazon DataZone environment to which the data source publishes assets.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name of the data source.

node

The tree node.

project_identifier

The identifier of the Amazon DataZone project in which you want to add this data source.

publish_on_import

Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

recommendation

Specifies whether the business name generation is to be enabled for this data source.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

schedule

The schedule of the data source runs.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

type

The type of the data source.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

DataSourceConfigurationInputProperty

class CfnDataSource.DataSourceConfigurationInputProperty(*, glue_run_configuration=None, redshift_run_configuration=None)

Bases: object

The configuration of the data source.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-datasourceconfigurationinput.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

data_source_configuration_input_property = datazone.CfnDataSource.DataSourceConfigurationInputProperty(
    glue_run_configuration=datazone.CfnDataSource.GlueRunConfigurationInputProperty(
        relational_filter_configurations=[datazone.CfnDataSource.RelationalFilterConfigurationProperty(
            database_name="databaseName",

            # the properties below are optional
            filter_expressions=[datazone.CfnDataSource.FilterExpressionProperty(
                expression="expression",
                type="type"
            )],
            schema_name="schemaName"
        )],

        # the properties below are optional
        auto_import_data_quality_result=False,
        data_access_role="dataAccessRole"
    ),
    redshift_run_configuration=datazone.CfnDataSource.RedshiftRunConfigurationInputProperty(
        redshift_credential_configuration=datazone.CfnDataSource.RedshiftCredentialConfigurationProperty(
            secret_manager_arn="secretManagerArn"
        ),
        redshift_storage=datazone.CfnDataSource.RedshiftStorageProperty(
            redshift_cluster_source=datazone.CfnDataSource.RedshiftClusterStorageProperty(
                cluster_name="clusterName"
            ),
            redshift_serverless_source=datazone.CfnDataSource.RedshiftServerlessStorageProperty(
                workgroup_name="workgroupName"
            )
        ),
        relational_filter_configurations=[datazone.CfnDataSource.RelationalFilterConfigurationProperty(
            database_name="databaseName",

            # the properties below are optional
            filter_expressions=[datazone.CfnDataSource.FilterExpressionProperty(
                expression="expression",
                type="type"
            )],
            schema_name="schemaName"
        )],

        # the properties below are optional
        data_access_role="dataAccessRole"
    )
)

Attributes

glue_run_configuration

The configuration of the AWS Glue data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-datasourceconfigurationinput.html#cfn-datazone-datasource-datasourceconfigurationinput-gluerunconfiguration

redshift_run_configuration

The configuration of the Amazon Redshift data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-datasourceconfigurationinput.html#cfn-datazone-datasource-datasourceconfigurationinput-redshiftrunconfiguration

FilterExpressionProperty

class CfnDataSource.FilterExpressionProperty(*, expression, type)

Bases: object

A filter expression in Amazon DataZone.

Parameters:

  • expression (str) – The search filter expression.

  • type (str) – The search filter explresison type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-filterexpression.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

filter_expression_property = datazone.CfnDataSource.FilterExpressionProperty(
    expression="expression",
    type="type"
)

Attributes

expression

The search filter expression.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-filterexpression.html#cfn-datazone-datasource-filterexpression-expression

type

The search filter explresison type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-filterexpression.html#cfn-datazone-datasource-filterexpression-type

FormInputProperty

class CfnDataSource.FormInputProperty(*, form_name, content=None, type_identifier=None, type_revision=None)

Bases: object

The details of a metadata form.

Parameters:

  • form_name (str) – The name of the metadata form.

  • content (Optional[str]) – The content of the metadata form.

  • type_identifier (Optional[str]) – The ID of the metadata form type.

  • type_revision (Optional[str]) – The revision of the metadata form type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-forminput.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

form_input_property = datazone.CfnDataSource.FormInputProperty(
    form_name="formName",

    # the properties below are optional
    content="content",
    type_identifier="typeIdentifier",
    type_revision="typeRevision"
)

Attributes

content

The content of the metadata form.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-forminput.html#cfn-datazone-datasource-forminput-content

form_name

The name of the metadata form.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-forminput.html#cfn-datazone-datasource-forminput-formname

type_identifier

The ID of the metadata form type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-forminput.html#cfn-datazone-datasource-forminput-typeidentifier

type_revision

The revision of the metadata form type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-forminput.html#cfn-datazone-datasource-forminput-typerevision

GlueRunConfigurationInputProperty

class CfnDataSource.GlueRunConfigurationInputProperty(*, relational_filter_configurations, auto_import_data_quality_result=None, data_access_role=None)

Bases: object

The configuration details of the AWS Glue data source.

Parameters:

  • relational_filter_configurations (Union[IResolvable, Sequence[Union[IResolvable, RelationalFilterConfigurationProperty, Dict[str, Any]]]]) – The relational filter configurations included in the configuration details of the AWS Glue data source.

  • auto_import_data_quality_result (Union[bool, IResolvable, None]) – Specifies whether to automatically import data quality metrics as part of the data source run.

  • data_access_role (Optional[str]) – The data access role included in the configuration details of the AWS Glue data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-gluerunconfigurationinput.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

glue_run_configuration_input_property = datazone.CfnDataSource.GlueRunConfigurationInputProperty(
    relational_filter_configurations=[datazone.CfnDataSource.RelationalFilterConfigurationProperty(
        database_name="databaseName",

        # the properties below are optional
        filter_expressions=[datazone.CfnDataSource.FilterExpressionProperty(
            expression="expression",
            type="type"
        )],
        schema_name="schemaName"
    )],

    # the properties below are optional
    auto_import_data_quality_result=False,
    data_access_role="dataAccessRole"
)

Attributes

auto_import_data_quality_result

Specifies whether to automatically import data quality metrics as part of the data source run.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-gluerunconfigurationinput.html#cfn-datazone-datasource-gluerunconfigurationinput-autoimportdataqualityresult

data_access_role

The data access role included in the configuration details of the AWS Glue data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-gluerunconfigurationinput.html#cfn-datazone-datasource-gluerunconfigurationinput-dataaccessrole

relational_filter_configurations

The relational filter configurations included in the configuration details of the AWS Glue data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-gluerunconfigurationinput.html#cfn-datazone-datasource-gluerunconfigurationinput-relationalfilterconfigurations

RecommendationConfigurationProperty

class CfnDataSource.RecommendationConfigurationProperty(*, enable_business_name_generation=None)

Bases: object

The recommendation configuration for the data source.

Parameters:

enable_business_name_generation (Union[bool, IResolvable, None]) – Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-recommendationconfiguration.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

recommendation_configuration_property = datazone.CfnDataSource.RecommendationConfigurationProperty(
    enable_business_name_generation=False
)

Attributes

enable_business_name_generation

Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-recommendationconfiguration.html#cfn-datazone-datasource-recommendationconfiguration-enablebusinessnamegeneration

RedshiftClusterStorageProperty

class CfnDataSource.RedshiftClusterStorageProperty(*, cluster_name)

Bases: object

The details of the Amazon Redshift cluster storage.

Parameters:

cluster_name (str) – The name of an Amazon Redshift cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftclusterstorage.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

redshift_cluster_storage_property = datazone.CfnDataSource.RedshiftClusterStorageProperty(
    cluster_name="clusterName"
)

Attributes

cluster_name

The name of an Amazon Redshift cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftclusterstorage.html#cfn-datazone-datasource-redshiftclusterstorage-clustername

RedshiftCredentialConfigurationProperty

class CfnDataSource.RedshiftCredentialConfigurationProperty(*, secret_manager_arn)

Bases: object

The details of the credentials required to access an Amazon Redshift cluster.

Parameters:

secret_manager_arn (str) – The ARN of a secret manager for an Amazon Redshift cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftcredentialconfiguration.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

redshift_credential_configuration_property = datazone.CfnDataSource.RedshiftCredentialConfigurationProperty(
    secret_manager_arn="secretManagerArn"
)

Attributes

secret_manager_arn

The ARN of a secret manager for an Amazon Redshift cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftcredentialconfiguration.html#cfn-datazone-datasource-redshiftcredentialconfiguration-secretmanagerarn

RedshiftRunConfigurationInputProperty

class CfnDataSource.RedshiftRunConfigurationInputProperty(*, redshift_credential_configuration, redshift_storage, relational_filter_configurations, data_access_role=None)

Bases: object

The relational filter configurations included in the configuration details of the Amazon Redshift data source.

Parameters:

  • redshift_credential_configuration (Union[IResolvable, RedshiftCredentialConfigurationProperty, Dict[str, Any]]) – The details of the credentials required to access an Amazon Redshift cluster.

  • redshift_storage (Union[IResolvable, RedshiftStorageProperty, Dict[str, Any]]) – The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.

  • relational_filter_configurations (Union[IResolvable, Sequence[Union[IResolvable, RelationalFilterConfigurationProperty, Dict[str, Any]]]]) – The relational filter configurations included in the configuration details of the AWS Glue data source.

  • data_access_role (Optional[str]) – The data access role included in the configuration details of the Amazon Redshift data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftrunconfigurationinput.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

redshift_run_configuration_input_property = datazone.CfnDataSource.RedshiftRunConfigurationInputProperty(
    redshift_credential_configuration=datazone.CfnDataSource.RedshiftCredentialConfigurationProperty(
        secret_manager_arn="secretManagerArn"
    ),
    redshift_storage=datazone.CfnDataSource.RedshiftStorageProperty(
        redshift_cluster_source=datazone.CfnDataSource.RedshiftClusterStorageProperty(
            cluster_name="clusterName"
        ),
        redshift_serverless_source=datazone.CfnDataSource.RedshiftServerlessStorageProperty(
            workgroup_name="workgroupName"
        )
    ),
    relational_filter_configurations=[datazone.CfnDataSource.RelationalFilterConfigurationProperty(
        database_name="databaseName",

        # the properties below are optional
        filter_expressions=[datazone.CfnDataSource.FilterExpressionProperty(
            expression="expression",
            type="type"
        )],
        schema_name="schemaName"
    )],

    # the properties below are optional
    data_access_role="dataAccessRole"
)

Attributes

data_access_role

The data access role included in the configuration details of the Amazon Redshift data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftrunconfigurationinput.html#cfn-datazone-datasource-redshiftrunconfigurationinput-dataaccessrole

redshift_credential_configuration

The details of the credentials required to access an Amazon Redshift cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftrunconfigurationinput.html#cfn-datazone-datasource-redshiftrunconfigurationinput-redshiftcredentialconfiguration

redshift_storage

The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftrunconfigurationinput.html#cfn-datazone-datasource-redshiftrunconfigurationinput-redshiftstorage

relational_filter_configurations

The relational filter configurations included in the configuration details of the AWS Glue data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftrunconfigurationinput.html#cfn-datazone-datasource-redshiftrunconfigurationinput-relationalfilterconfigurations

RedshiftServerlessStorageProperty

class CfnDataSource.RedshiftServerlessStorageProperty(*, workgroup_name)

Bases: object

The details of the Amazon Redshift Serverless workgroup storage.

Parameters:

workgroup_name (str) – The name of the Amazon Redshift Serverless workgroup.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftserverlessstorage.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

redshift_serverless_storage_property = datazone.CfnDataSource.RedshiftServerlessStorageProperty(
    workgroup_name="workgroupName"
)

Attributes

workgroup_name

The name of the Amazon Redshift Serverless workgroup.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftserverlessstorage.html#cfn-datazone-datasource-redshiftserverlessstorage-workgroupname

RedshiftStorageProperty

class CfnDataSource.RedshiftStorageProperty(*, redshift_cluster_source=None, redshift_serverless_source=None)

Bases: object

The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftstorage.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

redshift_storage_property = datazone.CfnDataSource.RedshiftStorageProperty(
    redshift_cluster_source=datazone.CfnDataSource.RedshiftClusterStorageProperty(
        cluster_name="clusterName"
    ),
    redshift_serverless_source=datazone.CfnDataSource.RedshiftServerlessStorageProperty(
        workgroup_name="workgroupName"
    )
)

Attributes

redshift_cluster_source

The details of the Amazon Redshift cluster source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftstorage.html#cfn-datazone-datasource-redshiftstorage-redshiftclustersource

redshift_serverless_source

The details of the Amazon Redshift Serverless workgroup source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftstorage.html#cfn-datazone-datasource-redshiftstorage-redshiftserverlesssource

RelationalFilterConfigurationProperty

class CfnDataSource.RelationalFilterConfigurationProperty(*, database_name, filter_expressions=None, schema_name=None)

Bases: object

The relational filter configuration for the data source.

Parameters:

  • database_name (str) – The database name specified in the relational filter configuration for the data source.

  • filter_expressions (Union[IResolvable, Sequence[Union[IResolvable, FilterExpressionProperty, Dict[str, Any]]], None]) – The filter expressions specified in the relational filter configuration for the data source.

  • schema_name (Optional[str]) – The schema name specified in the relational filter configuration for the data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-relationalfilterconfiguration.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

relational_filter_configuration_property = datazone.CfnDataSource.RelationalFilterConfigurationProperty(
    database_name="databaseName",

    # the properties below are optional
    filter_expressions=[datazone.CfnDataSource.FilterExpressionProperty(
        expression="expression",
        type="type"
    )],
    schema_name="schemaName"
)

Attributes

database_name

The database name specified in the relational filter configuration for the data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-relationalfilterconfiguration.html#cfn-datazone-datasource-relationalfilterconfiguration-databasename

filter_expressions

The filter expressions specified in the relational filter configuration for the data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-relationalfilterconfiguration.html#cfn-datazone-datasource-relationalfilterconfiguration-filterexpressions

schema_name

The schema name specified in the relational filter configuration for the data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-relationalfilterconfiguration.html#cfn-datazone-datasource-relationalfilterconfiguration-schemaname

ScheduleConfigurationProperty

class CfnDataSource.ScheduleConfigurationProperty(*, schedule=None, timezone=None)

Bases: object

The details of the schedule of the data source runs.

Parameters:

  • schedule (Optional[str]) – The schedule of the data source runs.

  • timezone (Optional[str]) – The timezone of the data source run.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-scheduleconfiguration.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

schedule_configuration_property = datazone.CfnDataSource.ScheduleConfigurationProperty(
    schedule="schedule",
    timezone="timezone"
)

Attributes

schedule

The schedule of the data source runs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-scheduleconfiguration.html#cfn-datazone-datasource-scheduleconfiguration-schedule

timezone

The timezone of the data source run.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-scheduleconfiguration.html#cfn-datazone-datasource-scheduleconfiguration-timezone