CfnApplicationPropsMixin

class aws_cdk.mixins_preview.aws_opensearchservice.mixins.CfnApplicationPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an OpenSearch UI application.

For more information, see Using the OpenSearch user interface in Amazon OpenSearch Service .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-application.html
CloudformationResource:: AWS::OpenSearchService::Application
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_opensearchservice import mixins as opensearchservice_mixins

cfn_application_props_mixin = opensearchservice_mixins.CfnApplicationPropsMixin(opensearchservice_mixins.CfnApplicationMixinProps(
    app_configs=[opensearchservice_mixins.CfnApplicationPropsMixin.AppConfigProperty(
        key="key",
        value="value"
    )],
    data_sources=[opensearchservice_mixins.CfnApplicationPropsMixin.DataSourceProperty(
        data_source_arn="dataSourceArn",
        data_source_description="dataSourceDescription"
    )],
    endpoint="endpoint",
    iam_identity_center_options=opensearchservice_mixins.CfnApplicationPropsMixin.IamIdentityCenterOptionsProperty(
        enabled=False,
        iam_identity_center_instance_arn="iamIdentityCenterInstanceArn",
        iam_role_for_identity_center_application_arn="iamRoleForIdentityCenterApplicationArn"
    ),
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::OpenSearchService::Application.

Parameters:

props (Union[CfnApplicationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['appConfigs', 'dataSources', 'endpoint', 'iamIdentityCenterOptions', 'name', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AppConfigProperty

class CfnApplicationPropsMixin.AppConfigProperty(*, key=None, value=None)

Bases: object

Configuration settings for an OpenSearch application.

For more information, see see Using the OpenSearch user interface in Amazon OpenSearch Service .

Parameters:

key (Optional[str]) – The configuration item to set, such as the admin role for the OpenSearch application.
value (Optional[str]) – The value assigned to the configuration key, such as an IAM user ARN.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-appconfig.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.mixins_preview.aws_opensearchservice import mixins as opensearchservice_mixins

app_config_property = opensearchservice_mixins.CfnApplicationPropsMixin.AppConfigProperty(
    key="key",
    value="value"
)

Attributes

key

The configuration item to set, such as the admin role for the OpenSearch application.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-appconfig.html#cfn-opensearchservice-application-appconfig-key

value

The value assigned to the configuration key, such as an IAM user ARN.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-appconfig.html#cfn-opensearchservice-application-appconfig-value

DataSourceProperty

class CfnApplicationPropsMixin.DataSourceProperty(*, data_source_arn=None, data_source_description=None)

Bases: object

Data sources that are associated with an OpenSearch application.

Parameters:

data_source_arn (Optional[str]) – Amazon Resource Name (ARN) format.
data_source_description (Optional[str]) – Detailed description of a data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-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.mixins_preview.aws_opensearchservice import mixins as opensearchservice_mixins

data_source_property = opensearchservice_mixins.CfnApplicationPropsMixin.DataSourceProperty(
    data_source_arn="dataSourceArn",
    data_source_description="dataSourceDescription"
)

Attributes

data_source_arn

Amazon Resource Name (ARN) format.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-datasource.html#cfn-opensearchservice-application-datasource-datasourcearn

data_source_description

Detailed description of a data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-datasource.html#cfn-opensearchservice-application-datasource-datasourcedescription

IamIdentityCenterOptionsProperty

class CfnApplicationPropsMixin.IamIdentityCenterOptionsProperty(*, enabled=None, iam_identity_center_instance_arn=None, iam_role_for_identity_center_application_arn=None)

Bases: object

Configuration settings for IAM Identity Center in an OpenSearch application.

Parameters:

enabled (Union[bool, IResolvable, None]) – Indicates whether IAM Identity Center is enabled for the OpenSearch application.
iam_identity_center_instance_arn (Optional[str]) – Amazon Resource Name (ARN) format.
iam_role_for_identity_center_application_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center application for the OpenSearch application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-iamidentitycenteroptions.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.mixins_preview.aws_opensearchservice import mixins as opensearchservice_mixins

iam_identity_center_options_property = opensearchservice_mixins.CfnApplicationPropsMixin.IamIdentityCenterOptionsProperty(
    enabled=False,
    iam_identity_center_instance_arn="iamIdentityCenterInstanceArn",
    iam_role_for_identity_center_application_arn="iamRoleForIdentityCenterApplicationArn"
)

Attributes

enabled

Indicates whether IAM Identity Center is enabled for the OpenSearch application.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-iamidentitycenteroptions.html#cfn-opensearchservice-application-iamidentitycenteroptions-enabled

iam_identity_center_instance_arn

Amazon Resource Name (ARN) format.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-iamidentitycenteroptions.html#cfn-opensearchservice-application-iamidentitycenteroptions-iamidentitycenterinstancearn

iam_role_for_identity_center_application_arn

The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center application for the OpenSearch application.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-iamidentitycenteroptions.html#cfn-opensearchservice-application-iamidentitycenteroptions-iamroleforidentitycenterapplicationarn