CfnDataSourceProps

class aws_cdk.aws_opensearch.CfnDataSourceProps(*, data_source_type, domain_name, name, description=None)

Bases: object

Properties for defining a CfnDataSource.

Parameters:

• data_source_type (Union[IResolvable, DataSourceTypeProperty, Dict[str, Any]]) – The type of data source.

• domain_name (str) – The name of the OpenSearch Service domain.

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

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearch-datasource.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_opensearch as opensearch

cfn_data_source_props = opensearch.CfnDataSourceProps(
    data_source_type=opensearch.CfnDataSource.DataSourceTypeProperty(
        s3_glue_data_catalog=opensearch.CfnDataSource.S3GlueDataCatalogProperty(
            role_arn="roleArn"
        )
    ),
    domain_name="domainName",
    name="name",

    # the properties below are optional
    description="description"
)

Attributes

data_source_type

The type of data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearch-datasource.html#cfn-opensearch-datasource-datasourcetype

description

A description of the data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearch-datasource.html#cfn-opensearch-datasource-description

domain_name

The name of the OpenSearch Service domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearch-datasource.html#cfn-opensearch-datasource-domainname

name

The name of the data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearch-datasource.html#cfn-opensearch-datasource-name