CfnDomainPropsMixin

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

Bases: Mixin

The AWS::OpenSearchService::Domain resource creates an Amazon OpenSearch Service domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html
CloudformationResource:: AWS::OpenSearchService::Domain
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

# access_policies: Any

cfn_domain_props_mixin = opensearchservice_mixins.CfnDomainPropsMixin(opensearchservice_mixins.CfnDomainMixinProps(
    access_policies=access_policies,
    advanced_options={
        "advanced_options_key": "advancedOptions"
    },
    advanced_security_options=opensearchservice_mixins.CfnDomainPropsMixin.AdvancedSecurityOptionsInputProperty(
        anonymous_auth_disable_date="anonymousAuthDisableDate",
        anonymous_auth_enabled=False,
        enabled=False,
        iam_federation_options={
            "enabled": False,
            "roles_key": "rolesKey",
            "subject_key": "subjectKey"
        },
        internal_user_database_enabled=False,
        jwt_options=opensearchservice_mixins.CfnDomainPropsMixin.JWTOptionsProperty(
            enabled=False,
            public_key="publicKey",
            roles_key="rolesKey",
            subject_key="subjectKey"
        ),
        master_user_options=opensearchservice_mixins.CfnDomainPropsMixin.MasterUserOptionsProperty(
            master_user_arn="masterUserArn",
            master_user_name="masterUserName",
            master_user_password="masterUserPassword"
        ),
        saml_options=opensearchservice_mixins.CfnDomainPropsMixin.SAMLOptionsProperty(
            enabled=False,
            idp=opensearchservice_mixins.CfnDomainPropsMixin.IdpProperty(
                entity_id="entityId",
                metadata_content="metadataContent"
            ),
            master_backend_role="masterBackendRole",
            master_user_name="masterUserName",
            roles_key="rolesKey",
            session_timeout_minutes=123,
            subject_key="subjectKey"
        )
    ),
    aiml_options=opensearchservice_mixins.CfnDomainPropsMixin.AIMLOptionsProperty(
        s3_vectors_engine=opensearchservice_mixins.CfnDomainPropsMixin.S3VectorsEngineProperty(
            enabled=False
        )
    ),
    cluster_config=opensearchservice_mixins.CfnDomainPropsMixin.ClusterConfigProperty(
        cold_storage_options=opensearchservice_mixins.CfnDomainPropsMixin.ColdStorageOptionsProperty(
            enabled=False
        ),
        dedicated_master_count=123,
        dedicated_master_enabled=False,
        dedicated_master_type="dedicatedMasterType",
        instance_count=123,
        instance_type="instanceType",
        multi_az_with_standby_enabled=False,
        node_options=[opensearchservice_mixins.CfnDomainPropsMixin.NodeOptionProperty(
            node_config=opensearchservice_mixins.CfnDomainPropsMixin.NodeConfigProperty(
                count=123,
                enabled=False,
                type="type"
            ),
            node_type="nodeType"
        )],
        warm_count=123,
        warm_enabled=False,
        warm_type="warmType",
        zone_awareness_config=opensearchservice_mixins.CfnDomainPropsMixin.ZoneAwarenessConfigProperty(
            availability_zone_count=123
        ),
        zone_awareness_enabled=False
    ),
    cognito_options=opensearchservice_mixins.CfnDomainPropsMixin.CognitoOptionsProperty(
        enabled=False,
        identity_pool_id="identityPoolId",
        role_arn="roleArn",
        user_pool_id="userPoolId"
    ),
    domain_arn="domainArn",
    domain_endpoint_options=opensearchservice_mixins.CfnDomainPropsMixin.DomainEndpointOptionsProperty(
        custom_endpoint="customEndpoint",
        custom_endpoint_certificate_arn="customEndpointCertificateArn",
        custom_endpoint_enabled=False,
        enforce_https=False,
        tls_security_policy="tlsSecurityPolicy"
    ),
    domain_name="domainName",
    ebs_options=opensearchservice_mixins.CfnDomainPropsMixin.EBSOptionsProperty(
        ebs_enabled=False,
        iops=123,
        throughput=123,
        volume_size=123,
        volume_type="volumeType"
    ),
    encryption_at_rest_options=opensearchservice_mixins.CfnDomainPropsMixin.EncryptionAtRestOptionsProperty(
        enabled=False,
        kms_key_id="kmsKeyId"
    ),
    engine_version="engineVersion",
    identity_center_options=opensearchservice_mixins.CfnDomainPropsMixin.IdentityCenterOptionsProperty(
        enabled_api_access=False,
        identity_center_application_arn="identityCenterApplicationArn",
        identity_center_instance_arn="identityCenterInstanceArn",
        identity_store_id="identityStoreId",
        roles_key="rolesKey",
        subject_key="subjectKey"
    ),
    ip_address_type="ipAddressType",
    log_publishing_options={
        "log_publishing_options_key": opensearchservice_mixins.CfnDomainPropsMixin.LogPublishingOptionProperty(
            cloud_watch_logs_log_group_arn="cloudWatchLogsLogGroupArn",
            enabled=False
        )
    },
    node_to_node_encryption_options=opensearchservice_mixins.CfnDomainPropsMixin.NodeToNodeEncryptionOptionsProperty(
        enabled=False
    ),
    off_peak_window_options=opensearchservice_mixins.CfnDomainPropsMixin.OffPeakWindowOptionsProperty(
        enabled=False,
        off_peak_window=opensearchservice_mixins.CfnDomainPropsMixin.OffPeakWindowProperty(
            window_start_time=opensearchservice_mixins.CfnDomainPropsMixin.WindowStartTimeProperty(
                hours=123,
                minutes=123
            )
        )
    ),
    skip_shard_migration_wait=False,
    snapshot_options=opensearchservice_mixins.CfnDomainPropsMixin.SnapshotOptionsProperty(
        automated_snapshot_start_hour=123
    ),
    software_update_options=opensearchservice_mixins.CfnDomainPropsMixin.SoftwareUpdateOptionsProperty(
        auto_software_update_enabled=False
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_options=opensearchservice_mixins.CfnDomainPropsMixin.VPCOptionsProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnDomainMixinProps, 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 = ['accessPolicies', 'advancedOptions', 'advancedSecurityOptions', 'aimlOptions', 'clusterConfig', 'cognitoOptions', 'domainArn', 'domainEndpointOptions', 'domainName', 'ebsOptions', 'encryptionAtRestOptions', 'engineVersion', 'identityCenterOptions', 'ipAddressType', 'logPublishingOptions', 'nodeToNodeEncryptionOptions', 'offPeakWindowOptions', 'skipShardMigrationWait', 'snapshotOptions', 'softwareUpdateOptions', 'tags', 'vpcOptions']

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

AIMLOptionsProperty

class CfnDomainPropsMixin.AIMLOptionsProperty(*, s3_vectors_engine=None)

Bases: object

Parameters:: s3_vectors_engine (Union[IResolvable, S3VectorsEngineProperty, Dict[str, Any], None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-aimloptions.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

a_iMLOptions_property = opensearchservice_mixins.CfnDomainPropsMixin.AIMLOptionsProperty(
    s3_vectors_engine=opensearchservice_mixins.CfnDomainPropsMixin.S3VectorsEngineProperty(
        enabled=False
    )
)

Attributes

s3_vectors_engine

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-aimloptions.html#cfn-opensearchservice-domain-aimloptions-s3vectorsengine

Type:: see

AdvancedSecurityOptionsInputProperty

class CfnDomainPropsMixin.AdvancedSecurityOptionsInputProperty(*, anonymous_auth_disable_date=None, anonymous_auth_enabled=None, enabled=None, iam_federation_options=None, internal_user_database_enabled=None, jwt_options=None, master_user_options=None, saml_options=None)

Bases: object

Specifies options for fine-grained access control.

If you specify advanced security options, you must also enable node-to-node encryption ( NodeToNodeEncryptionOptions ) and encryption at rest ( EncryptionAtRestOptions ). You must also enable EnforceHTTPS within DomainEndpointOptions , which requires HTTPS for all traffic to the domain.

Parameters:

anonymous_auth_disable_date (Optional[str]) – Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain .
anonymous_auth_enabled (Union[bool, IResolvable, None]) –
True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain .
enabled (Union[bool, IResolvable, None]) – True to enable fine-grained access control. You must also enable encryption of data at rest and node-to-node encryption. See Fine-grained access control in Amazon OpenSearch Service .
iam_federation_options (Union[IResolvable, IAMFederationOptionsProperty, Dict[str, Any], None]) – Input configuration for IAM identity federation within advanced security options.
internal_user_database_enabled (Union[bool, IResolvable, None]) – True to enable the internal user database.
jwt_options (Union[IResolvable, JWTOptionsProperty, Dict[str, Any], None]) – Container for information about the JWT configuration of the Amazon OpenSearch Service.
master_user_options (Union[IResolvable, MasterUserOptionsProperty, Dict[str, Any], None]) – Specifies information about the master user.
saml_options (Union[IResolvable, SAMLOptionsProperty, Dict[str, Any], None]) – Container for information about the SAML configuration for OpenSearch Dashboards.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.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

advanced_security_options_input_property = opensearchservice_mixins.CfnDomainPropsMixin.AdvancedSecurityOptionsInputProperty(
    anonymous_auth_disable_date="anonymousAuthDisableDate",
    anonymous_auth_enabled=False,
    enabled=False,
    iam_federation_options={
        "enabled": False,
        "roles_key": "rolesKey",
        "subject_key": "subjectKey"
    },
    internal_user_database_enabled=False,
    jwt_options=opensearchservice_mixins.CfnDomainPropsMixin.JWTOptionsProperty(
        enabled=False,
        public_key="publicKey",
        roles_key="rolesKey",
        subject_key="subjectKey"
    ),
    master_user_options=opensearchservice_mixins.CfnDomainPropsMixin.MasterUserOptionsProperty(
        master_user_arn="masterUserArn",
        master_user_name="masterUserName",
        master_user_password="masterUserPassword"
    ),
    saml_options=opensearchservice_mixins.CfnDomainPropsMixin.SAMLOptionsProperty(
        enabled=False,
        idp=opensearchservice_mixins.CfnDomainPropsMixin.IdpProperty(
            entity_id="entityId",
            metadata_content="metadataContent"
        ),
        master_backend_role="masterBackendRole",
        master_user_name="masterUserName",
        roles_key="rolesKey",
        session_timeout_minutes=123,
        subject_key="subjectKey"
    )
)

Attributes

anonymous_auth_disable_date

Date and time when the migration period will be disabled.

Only necessary when enabling fine-grained access control on an existing domain .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-anonymousauthdisabledate

anonymous_auth_enabled

True to enable a 30-day migration period during which administrators can create role mappings.

Only necessary when enabling fine-grained access control on an existing domain .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-anonymousauthenabled

enabled

True to enable fine-grained access control.

You must also enable encryption of data at rest and node-to-node encryption. See Fine-grained access control in Amazon OpenSearch Service .

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

iam_federation_options

Input configuration for IAM identity federation within advanced security options.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-iamfederationoptions

internal_user_database_enabled

True to enable the internal user database.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-internaluserdatabaseenabled

jwt_options

Container for information about the JWT configuration of the Amazon OpenSearch Service.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-jwtoptions

master_user_options

Specifies information about the master user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-masteruseroptions

saml_options

Container for information about the SAML configuration for OpenSearch Dashboards.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-samloptions

ClusterConfigProperty

class CfnDomainPropsMixin.ClusterConfigProperty(*, cold_storage_options=None, dedicated_master_count=None, dedicated_master_enabled=None, dedicated_master_type=None, instance_count=None, instance_type=None, multi_az_with_standby_enabled=None, node_options=None, warm_count=None, warm_enabled=None, warm_type=None, zone_awareness_config=None, zone_awareness_enabled=None)

Bases: object

The cluster configuration for the OpenSearch Service domain.

You can specify options such as the instance type and the number of instances. For more information, see Creating and managing Amazon OpenSearch Service domains in the Amazon OpenSearch Service Developer Guide .

Parameters:

cold_storage_options (Union[IResolvable, ColdStorageOptionsProperty, Dict[str, Any], None]) – Container for cold storage configuration options.
dedicated_master_count (Union[int, float, None]) – The number of instances to use for the master node. If you specify this property, you must specify true for the DedicatedMasterEnabled property.
dedicated_master_enabled (Union[bool, IResolvable, None]) – Indicates whether to use a dedicated master node for the OpenSearch Service domain. A dedicated master node is a cluster node that performs cluster management tasks, but doesn’t hold data or respond to data upload requests. Dedicated master nodes offload cluster management tasks to increase the stability of your search clusters. See Dedicated master nodes in Amazon OpenSearch Service .
dedicated_master_type (Optional[str]) – The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.search . If you specify this property, you must specify true for the DedicatedMasterEnabled property. For valid values, see Supported instance types in Amazon OpenSearch Service .
instance_count (Union[int, float, None]) – The number of data nodes (instances) to use in the OpenSearch Service domain.
instance_type (Optional[str]) –
The instance type for your data nodes, such as m3.medium.search . For valid values, see Supported instance types in Amazon OpenSearch Service .
multi_az_with_standby_enabled (Union[bool, IResolvable, None]) – Indicates whether Multi-AZ with Standby deployment option is enabled. For more information, see Multi-AZ with Standby .
node_options (Union[IResolvable, Sequence[Union[IResolvable, NodeOptionProperty, Dict[str, Any]]], None]) – List of node options for the domain.
warm_count (Union[int, float, None]) – The number of warm nodes in the cluster.
warm_enabled (Union[bool, IResolvable, None]) – Whether to enable UltraWarm storage for the cluster. See UltraWarm storage for Amazon OpenSearch Service .
warm_type (Optional[str]) – The instance type for the cluster’s warm nodes.
zone_awareness_config (Union[IResolvable, ZoneAwarenessConfigProperty, Dict[str, Any], None]) – Specifies zone awareness configuration options. Only use if ZoneAwarenessEnabled is true .
zone_awareness_enabled (Union[bool, IResolvable, None]) – Indicates whether to enable zone awareness for the OpenSearch Service domain. When you enable zone awareness, OpenSearch Service allocates the nodes and replica index shards that belong to a cluster across two Availability Zones (AZs) in the same region to prevent data loss and minimize downtime in the event of node or data center failure. Don’t enable zone awareness if your cluster has no replica index shards or is a single-node cluster. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.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

cluster_config_property = opensearchservice_mixins.CfnDomainPropsMixin.ClusterConfigProperty(
    cold_storage_options=opensearchservice_mixins.CfnDomainPropsMixin.ColdStorageOptionsProperty(
        enabled=False
    ),
    dedicated_master_count=123,
    dedicated_master_enabled=False,
    dedicated_master_type="dedicatedMasterType",
    instance_count=123,
    instance_type="instanceType",
    multi_az_with_standby_enabled=False,
    node_options=[opensearchservice_mixins.CfnDomainPropsMixin.NodeOptionProperty(
        node_config=opensearchservice_mixins.CfnDomainPropsMixin.NodeConfigProperty(
            count=123,
            enabled=False,
            type="type"
        ),
        node_type="nodeType"
    )],
    warm_count=123,
    warm_enabled=False,
    warm_type="warmType",
    zone_awareness_config=opensearchservice_mixins.CfnDomainPropsMixin.ZoneAwarenessConfigProperty(
        availability_zone_count=123
    ),
    zone_awareness_enabled=False
)

Attributes

cold_storage_options

Container for cold storage configuration options.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-coldstorageoptions

dedicated_master_count

The number of instances to use for the master node.

If you specify this property, you must specify true for the DedicatedMasterEnabled property.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-dedicatedmastercount

dedicated_master_enabled

Indicates whether to use a dedicated master node for the OpenSearch Service domain.

A dedicated master node is a cluster node that performs cluster management tasks, but doesn’t hold data or respond to data upload requests. Dedicated master nodes offload cluster management tasks to increase the stability of your search clusters. See Dedicated master nodes in Amazon OpenSearch Service .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-dedicatedmasterenabled

dedicated_master_type

The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.search . If you specify this property, you must specify true for the DedicatedMasterEnabled property. For valid values, see Supported instance types in Amazon OpenSearch Service .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-dedicatedmastertype

instance_count

The number of data nodes (instances) to use in the OpenSearch Service domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-instancecount

instance_type

The instance type for your data nodes, such as m3.medium.search . For valid values, see Supported instance types in Amazon OpenSearch Service .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-instancetype

multi_az_with_standby_enabled

Indicates whether Multi-AZ with Standby deployment option is enabled.

For more information, see Multi-AZ with Standby .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-multiazwithstandbyenabled

node_options

List of node options for the domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-nodeoptions

warm_count

The number of warm nodes in the cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-warmcount

warm_enabled

Whether to enable UltraWarm storage for the cluster.

See UltraWarm storage for Amazon OpenSearch Service .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-warmenabled

warm_type

The instance type for the cluster’s warm nodes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-warmtype

zone_awareness_config

Specifies zone awareness configuration options.

Only use if ZoneAwarenessEnabled is true .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-zoneawarenessconfig

zone_awareness_enabled

Indicates whether to enable zone awareness for the OpenSearch Service domain.

When you enable zone awareness, OpenSearch Service allocates the nodes and replica index shards that belong to a cluster across two Availability Zones (AZs) in the same region to prevent data loss and minimize downtime in the event of node or data center failure. Don’t enable zone awareness if your cluster has no replica index shards or is a single-node cluster. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#cfn-opensearchservice-domain-clusterconfig-zoneawarenessenabled

CognitoOptionsProperty

class CfnDomainPropsMixin.CognitoOptionsProperty(*, enabled=None, identity_pool_id=None, role_arn=None, user_pool_id=None)

Bases: object

Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

Parameters:

enabled (Union[bool, IResolvable, None]) – Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. See Amazon Cognito authentication for OpenSearch Dashboards .
identity_pool_id (Optional[str]) – The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. Required if you enabled Cognito Authentication for OpenSearch Dashboards.
role_arn (Optional[str]) – The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool. Required if you enabled Cognito Authentication for OpenSearch Dashboards.
user_pool_id (Optional[str]) – The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. Required if you enabled Cognito Authentication for OpenSearch Dashboards.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-cognitooptions.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

cognito_options_property = opensearchservice_mixins.CfnDomainPropsMixin.CognitoOptionsProperty(
    enabled=False,
    identity_pool_id="identityPoolId",
    role_arn="roleArn",
    user_pool_id="userPoolId"
)

Attributes

enabled

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

See Amazon Cognito authentication for OpenSearch Dashboards .

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

identity_pool_id

The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

Required if you enabled Cognito Authentication for OpenSearch Dashboards.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-cognitooptions.html#cfn-opensearchservice-domain-cognitooptions-identitypoolid

role_arn

The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

Required if you enabled Cognito Authentication for OpenSearch Dashboards.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-cognitooptions.html#cfn-opensearchservice-domain-cognitooptions-rolearn

user_pool_id

The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

Required if you enabled Cognito Authentication for OpenSearch Dashboards.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-cognitooptions.html#cfn-opensearchservice-domain-cognitooptions-userpoolid

ColdStorageOptionsProperty

class CfnDomainPropsMixin.ColdStorageOptionsProperty(*, enabled=None)

Bases: object

Container for the parameters required to enable cold storage for an OpenSearch Service domain.

For more information, see Cold storage for Amazon OpenSearch Service .

Parameters:: enabled (Union[bool, IResolvable, None]) – Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-coldstorageoptions.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

cold_storage_options_property = opensearchservice_mixins.CfnDomainPropsMixin.ColdStorageOptionsProperty(
    enabled=False
)

Attributes

enabled

Whether to enable or disable cold storage on the domain.

You must enable UltraWarm storage to enable cold storage.

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

DomainEndpointOptionsProperty

class CfnDomainPropsMixin.DomainEndpointOptionsProperty(*, custom_endpoint=None, custom_endpoint_certificate_arn=None, custom_endpoint_enabled=None, enforce_https=None, tls_security_policy=None)

Bases: object

Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.

Parameters:

custom_endpoint (Optional[str]) – The fully qualified URL for your custom endpoint. Required if you enabled a custom endpoint for the domain.
custom_endpoint_certificate_arn (Optional[str]) – The Certificate Manager ARN for your domain’s SSL/TLS certificate. Required if you enabled a custom endpoint for the domain.
custom_endpoint_enabled (Union[bool, IResolvable, None]) – True to enable a custom endpoint for the domain. If enabled, you must also provide values for CustomEndpoint and CustomEndpointCertificateArn .
enforce_https (Union[bool, IResolvable, None]) – True to require that all traffic to the domain arrive over HTTPS. Required if you enable fine-grained access control in AdvancedSecurityOptions .
tls_security_policy (Optional[str]) – The minimum TLS version required for traffic to the domain. The policy can be one of the following values:. - Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2 - Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2 - Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.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

domain_endpoint_options_property = opensearchservice_mixins.CfnDomainPropsMixin.DomainEndpointOptionsProperty(
    custom_endpoint="customEndpoint",
    custom_endpoint_certificate_arn="customEndpointCertificateArn",
    custom_endpoint_enabled=False,
    enforce_https=False,
    tls_security_policy="tlsSecurityPolicy"
)

Attributes

custom_endpoint

The fully qualified URL for your custom endpoint.

Required if you enabled a custom endpoint for the domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html#cfn-opensearchservice-domain-domainendpointoptions-customendpoint

custom_endpoint_certificate_arn

The Certificate Manager ARN for your domain’s SSL/TLS certificate.

Required if you enabled a custom endpoint for the domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html#cfn-opensearchservice-domain-domainendpointoptions-customendpointcertificatearn

custom_endpoint_enabled

True to enable a custom endpoint for the domain.

If enabled, you must also provide values for CustomEndpoint and CustomEndpointCertificateArn .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html#cfn-opensearchservice-domain-domainendpointoptions-customendpointenabled

enforce_https

True to require that all traffic to the domain arrive over HTTPS.

Required if you enable fine-grained access control in AdvancedSecurityOptions .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html#cfn-opensearchservice-domain-domainendpointoptions-enforcehttps

tls_security_policy

.

Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2
Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2
Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html#cfn-opensearchservice-domain-domainendpointoptions-tlssecuritypolicy
Type:: The minimum TLS version required for traffic to the domain. The policy can be one of the following values

EBSOptionsProperty

class CfnDomainPropsMixin.EBSOptionsProperty(*, ebs_enabled=None, iops=None, throughput=None, volume_size=None, volume_type=None)

Bases: object

The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.

For more information, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide .

Parameters:

ebs_enabled (Union[bool, IResolvable, None]) – Specifies whether Amazon EBS volumes are attached to data nodes in the OpenSearch Service domain.
iops (Union[int, float, None]) – The number of I/O operations per second (IOPS) that the volume supports. This property applies only to the gp3 and provisioned IOPS EBS volume types.
throughput (Union[int, float, None]) – The throughput (in MiB/s) of the EBS volumes attached to data nodes. Applies only to the gp3 volume type.
volume_size (Union[int, float, None]) –
The size (in GiB) of the EBS volume for each data node. The minimum and maximum size of an EBS volume depends on the EBS volume type and the instance type to which it is attached. For more information, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide .
volume_type (Optional[str]) – The EBS volume type to use with the OpenSearch Service domain. If you choose gp3 , you must also specify values for Iops and Throughput . For more information about each type, see Amazon EBS volume types in the Amazon EC2 User Guide for Linux Instances .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.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

e_bSOptions_property = opensearchservice_mixins.CfnDomainPropsMixin.EBSOptionsProperty(
    ebs_enabled=False,
    iops=123,
    throughput=123,
    volume_size=123,
    volume_type="volumeType"
)

Attributes

ebs_enabled

Specifies whether Amazon EBS volumes are attached to data nodes in the OpenSearch Service domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-ebsenabled

iops

The number of I/O operations per second (IOPS) that the volume supports.

This property applies only to the gp3 and provisioned IOPS EBS volume types.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-iops

throughput

The throughput (in MiB/s) of the EBS volumes attached to data nodes.

Applies only to the gp3 volume type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-throughput

volume_size

The size (in GiB) of the EBS volume for each data node.

The minimum and maximum size of an EBS volume depends on the EBS volume type and the instance type to which it is attached. For more information, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-volumesize

volume_type

The EBS volume type to use with the OpenSearch Service domain.

If you choose gp3 , you must also specify values for Iops and Throughput . For more information about each type, see Amazon EBS volume types in the Amazon EC2 User Guide for Linux Instances .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html#cfn-opensearchservice-domain-ebsoptions-volumetype

EncryptionAtRestOptionsProperty

class CfnDomainPropsMixin.EncryptionAtRestOptionsProperty(*, enabled=None, kms_key_id=None)

Bases: object

Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.

Parameters:

enabled (Union[bool, IResolvable, None]) – Specify true to enable encryption at rest. Required if you enable fine-grained access control in AdvancedSecurityOptionsInput . If no encryption at rest options were initially specified in the template, updating this property by adding it causes no interruption. However, if you change this property after it’s already been set within a template, the domain is deleted and recreated in order to modify the property.
kms_key_id (Optional[str]) – The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a . Required if you enable encryption at rest. You can also use keyAlias as a value. If no encryption at rest options were initially specified in the template, updating this property by adding it causes no interruption. However, if you change this property after it’s already been set within a template, the domain is deleted and recreated in order to modify the property.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-encryptionatrestoptions.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

encryption_at_rest_options_property = opensearchservice_mixins.CfnDomainPropsMixin.EncryptionAtRestOptionsProperty(
    enabled=False,
    kms_key_id="kmsKeyId"
)

Attributes

enabled

Specify true to enable encryption at rest. Required if you enable fine-grained access control in AdvancedSecurityOptionsInput .

If no encryption at rest options were initially specified in the template, updating this property by adding it causes no interruption. However, if you change this property after it’s already been set within a template, the domain is deleted and recreated in order to modify the property.

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

kms_key_id

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a . Required if you enable encryption at rest.

You can also use keyAlias as a value.

If no encryption at rest options were initially specified in the template, updating this property by adding it causes no interruption. However, if you change this property after it’s already been set within a template, the domain is deleted and recreated in order to modify the property.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-encryptionatrestoptions.html#cfn-opensearchservice-domain-encryptionatrestoptions-kmskeyid

IAMFederationOptionsProperty

class CfnDomainPropsMixin.IAMFederationOptionsProperty(*, enabled=None, roles_key=None, subject_key=None)

Bases: object

Parameters:

enabled (Union[bool, IResolvable, None])
roles_key (Optional[str])
subject_key (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-iamfederationoptions.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

i_aMFederation_options_property = {
    "enabled": False,
    "roles_key": "rolesKey",
    "subject_key": "subjectKey"
}

Attributes

enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-iamfederationoptions.html#cfn-opensearchservice-domain-iamfederationoptions-enabled

Type:: see

roles_key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-iamfederationoptions.html#cfn-opensearchservice-domain-iamfederationoptions-roleskey

Type:: see

subject_key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-iamfederationoptions.html#cfn-opensearchservice-domain-iamfederationoptions-subjectkey

Type:: see

IdentityCenterOptionsProperty

class CfnDomainPropsMixin.IdentityCenterOptionsProperty(*, enabled_api_access=None, identity_center_application_arn=None, identity_center_instance_arn=None, identity_store_id=None, roles_key=None, subject_key=None)

Bases: object

Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources.

This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.

Parameters:

enabled_api_access (Union[bool, IResolvable, None]) – Indicates whether IAM Identity Center is enabled for the application.
identity_center_application_arn (Optional[str]) – The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.
identity_center_instance_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM Identity Center instance.
identity_store_id (Optional[str]) – The identifier of the IAM Identity Store.
roles_key (Optional[str]) – Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.
subject_key (Optional[str]) – Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.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

identity_center_options_property = opensearchservice_mixins.CfnDomainPropsMixin.IdentityCenterOptionsProperty(
    enabled_api_access=False,
    identity_center_application_arn="identityCenterApplicationArn",
    identity_center_instance_arn="identityCenterInstanceArn",
    identity_store_id="identityStoreId",
    roles_key="rolesKey",
    subject_key="subjectKey"
)

Attributes

enabled_api_access

Indicates whether IAM Identity Center is enabled for the application.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html#cfn-opensearchservice-domain-identitycenteroptions-enabledapiaccess

identity_center_application_arn

The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html#cfn-opensearchservice-domain-identitycenteroptions-identitycenterapplicationarn

identity_center_instance_arn

The Amazon Resource Name (ARN) of the IAM Identity Center instance.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html#cfn-opensearchservice-domain-identitycenteroptions-identitycenterinstancearn

identity_store_id

The identifier of the IAM Identity Store.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html#cfn-opensearchservice-domain-identitycenteroptions-identitystoreid

roles_key

Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html#cfn-opensearchservice-domain-identitycenteroptions-roleskey

subject_key

Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html#cfn-opensearchservice-domain-identitycenteroptions-subjectkey

IdpProperty

class CfnDomainPropsMixin.IdpProperty(*, entity_id=None, metadata_content=None)

Bases: object

The SAML Identity Provider’s information.

Parameters:

entity_id (Optional[str]) – The unique entity ID of the application in the SAML identity provider.
metadata_content (Optional[str]) – The metadata of the SAML application, in XML format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-idp.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

idp_property = opensearchservice_mixins.CfnDomainPropsMixin.IdpProperty(
    entity_id="entityId",
    metadata_content="metadataContent"
)

Attributes

entity_id

The unique entity ID of the application in the SAML identity provider.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-idp.html#cfn-opensearchservice-domain-idp-entityid

metadata_content

The metadata of the SAML application, in XML format.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-idp.html#cfn-opensearchservice-domain-idp-metadatacontent

JWTOptionsProperty

class CfnDomainPropsMixin.JWTOptionsProperty(*, enabled=None, public_key=None, roles_key=None, subject_key=None)

Bases: object

Parameters:

enabled (Union[bool, IResolvable, None])
public_key (Optional[str])
roles_key (Optional[str])
subject_key (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-jwtoptions.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

j_wTOptions_property = opensearchservice_mixins.CfnDomainPropsMixin.JWTOptionsProperty(
    enabled=False,
    public_key="publicKey",
    roles_key="rolesKey",
    subject_key="subjectKey"
)

Attributes

enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-jwtoptions.html#cfn-opensearchservice-domain-jwtoptions-enabled

Type:: see

public_key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-jwtoptions.html#cfn-opensearchservice-domain-jwtoptions-publickey

Type:: see

roles_key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-jwtoptions.html#cfn-opensearchservice-domain-jwtoptions-roleskey

Type:: see

subject_key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-jwtoptions.html#cfn-opensearchservice-domain-jwtoptions-subjectkey

Type:: see

LogPublishingOptionProperty

class CfnDomainPropsMixin.LogPublishingOptionProperty(*, cloud_watch_logs_log_group_arn=None, enabled=None)

Bases: object

Specifies whether the OpenSearch Service domain publishes application, search slow logs, or index slow logs to Amazon CloudWatch.

Each option must be an object of name SEARCH_SLOW_LOGS , ES_APPLICATION_LOGS , INDEX_SLOW_LOGS , or AUDIT_LOGS depending on the type of logs you want to publish. For the full syntax, see the examples .

Before you enable log publishing, you need to create a CloudWatch log group and provide OpenSearch Service the correct permissions to write to it. To learn more, see Enabling log publishing ( AWS CloudFormation) .

Parameters:

cloud_watch_logs_log_group_arn (Optional[str]) – Specifies the CloudWatch log group to publish to. Required if you enable log publishing.
enabled (Union[bool, IResolvable, None]) – If true , enables the publishing of logs to CloudWatch. Default: false .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-logpublishingoption.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

log_publishing_option_property = opensearchservice_mixins.CfnDomainPropsMixin.LogPublishingOptionProperty(
    cloud_watch_logs_log_group_arn="cloudWatchLogsLogGroupArn",
    enabled=False
)

Attributes

cloud_watch_logs_log_group_arn

Specifies the CloudWatch log group to publish to.

Required if you enable log publishing.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-logpublishingoption.html#cfn-opensearchservice-domain-logpublishingoption-cloudwatchlogsloggrouparn

enabled

If true , enables the publishing of logs to CloudWatch.

Default: false .

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

MasterUserOptionsProperty

class CfnDomainPropsMixin.MasterUserOptionsProperty(*, master_user_arn=None, master_user_name=None, master_user_password=None)

Bases: object

Specifies information about the master user.

Required if InternalUserDatabaseEnabled is true in AdvancedSecurityOptions .

Parameters:

master_user_arn (Optional[str]) –
Amazon Resource Name (ARN) for the master user. The ARN can point to an IAM user or role. This property is required for Amazon Cognito to work, and it must match the role configured for Cognito. Only specify if InternalUserDatabaseEnabled is false in AdvancedSecurityOptionsInput .
master_user_name (Optional[str]) –
Username for the master user. Only specify if InternalUserDatabaseEnabled is true in AdvancedSecurityOptionsInput . If you don’t want to specify this value directly within the template, you can use a dynamic reference instead.
master_user_password (Optional[str]) –
Password for the master user. Only specify if InternalUserDatabaseEnabled is true in AdvancedSecurityOptionsInput . If you don’t want to specify this value directly within the template, you can use a dynamic reference instead.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-masteruseroptions.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

master_user_options_property = opensearchservice_mixins.CfnDomainPropsMixin.MasterUserOptionsProperty(
    master_user_arn="masterUserArn",
    master_user_name="masterUserName",
    master_user_password="masterUserPassword"
)

Attributes

master_user_arn

Amazon Resource Name (ARN) for the master user.

The ARN can point to an IAM user or role. This property is required for Amazon Cognito to work, and it must match the role configured for Cognito. Only specify if InternalUserDatabaseEnabled is false in AdvancedSecurityOptionsInput .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-masteruseroptions.html#cfn-opensearchservice-domain-masteruseroptions-masteruserarn

master_user_name

Username for the master user. Only specify if InternalUserDatabaseEnabled is true in AdvancedSecurityOptionsInput .

If you don’t want to specify this value directly within the template, you can use a dynamic reference instead.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-masteruseroptions.html#cfn-opensearchservice-domain-masteruseroptions-masterusername

master_user_password

Password for the master user. Only specify if InternalUserDatabaseEnabled is true in AdvancedSecurityOptionsInput .

If you don’t want to specify this value directly within the template, you can use a dynamic reference instead.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-masteruseroptions.html#cfn-opensearchservice-domain-masteruseroptions-masteruserpassword

NodeConfigProperty

class CfnDomainPropsMixin.NodeConfigProperty(*, count=None, enabled=None, type=None)

Bases: object

Configuration options for defining the setup of any node type within the cluster.

Parameters:

count (Union[int, float, None]) – The number of nodes of a specific type within the cluster.
enabled (Union[bool, IResolvable, None]) – A boolean value indicating whether a specific node type is active or inactive.
type (Optional[str]) – The instance type of a particular node within the cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodeconfig.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

node_config_property = opensearchservice_mixins.CfnDomainPropsMixin.NodeConfigProperty(
    count=123,
    enabled=False,
    type="type"
)

Attributes

count

The number of nodes of a specific type within the cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodeconfig.html#cfn-opensearchservice-domain-nodeconfig-count

enabled

A boolean value indicating whether a specific node type is active or inactive.

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

type

The instance type of a particular node within the cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodeconfig.html#cfn-opensearchservice-domain-nodeconfig-type

NodeOptionProperty

class CfnDomainPropsMixin.NodeOptionProperty(*, node_config=None, node_type=None)

Bases: object

Configuration settings for defining the node type within a cluster.

Parameters:

node_config (Union[IResolvable, NodeConfigProperty, Dict[str, Any], None]) – Configuration options for defining the setup of any node type.
node_type (Optional[str]) – Defines the type of node, such as coordinating nodes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodeoption.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

node_option_property = opensearchservice_mixins.CfnDomainPropsMixin.NodeOptionProperty(
    node_config=opensearchservice_mixins.CfnDomainPropsMixin.NodeConfigProperty(
        count=123,
        enabled=False,
        type="type"
    ),
    node_type="nodeType"
)

Attributes

node_config

Configuration options for defining the setup of any node type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodeoption.html#cfn-opensearchservice-domain-nodeoption-nodeconfig

node_type

Defines the type of node, such as coordinating nodes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodeoption.html#cfn-opensearchservice-domain-nodeoption-nodetype

NodeToNodeEncryptionOptionsProperty

class CfnDomainPropsMixin.NodeToNodeEncryptionOptionsProperty(*, enabled=None)

Bases: object

Specifies options for node-to-node encryption.

Parameters:

enabled (Union[bool, IResolvable, None]) –

Specifies to enable or disable node-to-node encryption on the domain. Required if you enable fine-grained access control in AdvancedSecurityOptionsInput .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodetonodeencryptionoptions.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

node_to_node_encryption_options_property = opensearchservice_mixins.CfnDomainPropsMixin.NodeToNodeEncryptionOptionsProperty(
    enabled=False
)

Attributes

enabled

Specifies to enable or disable node-to-node encryption on the domain.

Required if you enable fine-grained access control in AdvancedSecurityOptionsInput .

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

OffPeakWindowOptionsProperty

class CfnDomainPropsMixin.OffPeakWindowOptionsProperty(*, enabled=None, off_peak_window=None)

Bases: object

Off-peak window settings for the domain.

Parameters:

enabled (Union[bool, IResolvable, None]) – Specifies whether off-peak window settings are enabled for the domain.
off_peak_window (Union[IResolvable, OffPeakWindowProperty, Dict[str, Any], None]) – Off-peak window settings for the domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-offpeakwindowoptions.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

off_peak_window_options_property = opensearchservice_mixins.CfnDomainPropsMixin.OffPeakWindowOptionsProperty(
    enabled=False,
    off_peak_window=opensearchservice_mixins.CfnDomainPropsMixin.OffPeakWindowProperty(
        window_start_time=opensearchservice_mixins.CfnDomainPropsMixin.WindowStartTimeProperty(
            hours=123,
            minutes=123
        )
    )
)

Attributes

enabled

Specifies whether off-peak window settings are enabled for the domain.

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

off_peak_window

Off-peak window settings for the domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-offpeakwindowoptions.html#cfn-opensearchservice-domain-offpeakwindowoptions-offpeakwindow

OffPeakWindowProperty

class CfnDomainPropsMixin.OffPeakWindowProperty(*, window_start_time=None)

Bases: object

A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on the domain.

These actions can include scheduled service software updates and blue/green Auto-Tune enhancements. OpenSearch Service will schedule these actions during the window that you specify. If you don’t specify a window start time, it defaults to 10:00 P.M. local time.

Parameters:: window_start_time (Union[IResolvable, WindowStartTimeProperty, Dict[str, Any], None]) – The desired start time for an off-peak maintenance window.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-offpeakwindow.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

off_peak_window_property = opensearchservice_mixins.CfnDomainPropsMixin.OffPeakWindowProperty(
    window_start_time=opensearchservice_mixins.CfnDomainPropsMixin.WindowStartTimeProperty(
        hours=123,
        minutes=123
    )
)

Attributes

window_start_time

The desired start time for an off-peak maintenance window.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-offpeakwindow.html#cfn-opensearchservice-domain-offpeakwindow-windowstarttime

S3VectorsEngineProperty

class CfnDomainPropsMixin.S3VectorsEngineProperty(*, enabled=None)

Bases: object

Options for enabling S3 vectors engine features on the specified domain.

Parameters:: enabled (Union[bool, IResolvable, None]) – Enables S3 vectors engine features.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-s3vectorsengine.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

s3_vectors_engine_property = opensearchservice_mixins.CfnDomainPropsMixin.S3VectorsEngineProperty(
    enabled=False
)

Attributes

enabled

Enables S3 vectors engine features.

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

SAMLOptionsProperty

class CfnDomainPropsMixin.SAMLOptionsProperty(*, enabled=None, idp=None, master_backend_role=None, master_user_name=None, roles_key=None, session_timeout_minutes=None, subject_key=None)

Bases: object

Container for information about the SAML configuration for OpenSearch Dashboards.

Parameters:

enabled (Union[bool, IResolvable, None]) – True to enable SAML authentication for a domain.
idp (Union[IResolvable, IdpProperty, Dict[str, Any], None]) – The SAML Identity Provider’s information.
master_backend_role (Optional[str]) – The backend role that the SAML master user is mapped to.
master_user_name (Optional[str]) – The SAML master user name, which is stored in the domain’s internal user database.
roles_key (Optional[str]) – Element of the SAML assertion to use for backend roles. Default is roles .
session_timeout_minutes (Union[int, float, None]) – The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
subject_key (Optional[str]) – Element of the SAML assertion to use for the user name. Default is NameID .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.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

s_aMLOptions_property = opensearchservice_mixins.CfnDomainPropsMixin.SAMLOptionsProperty(
    enabled=False,
    idp=opensearchservice_mixins.CfnDomainPropsMixin.IdpProperty(
        entity_id="entityId",
        metadata_content="metadataContent"
    ),
    master_backend_role="masterBackendRole",
    master_user_name="masterUserName",
    roles_key="rolesKey",
    session_timeout_minutes=123,
    subject_key="subjectKey"
)

Attributes

enabled

True to enable SAML authentication for a domain.

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

idp

The SAML Identity Provider’s information.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-idp

master_backend_role

The backend role that the SAML master user is mapped to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-masterbackendrole

master_user_name

The SAML master user name, which is stored in the domain’s internal user database.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-masterusername

roles_key

Element of the SAML assertion to use for backend roles.

Default is roles .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-roleskey

session_timeout_minutes

The duration, in minutes, after which a user session becomes inactive.

Acceptable values are between 1 and 1440, and the default value is 60.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-sessiontimeoutminutes

subject_key

Element of the SAML assertion to use for the user name.

Default is NameID .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-subjectkey

ServiceSoftwareOptionsProperty

class CfnDomainPropsMixin.ServiceSoftwareOptionsProperty(*, automated_update_date=None, cancellable=None, current_version=None, description=None, new_version=None, optional_deployment=None, update_available=None, update_status=None)

Bases: object

The current status of the service software for an Amazon OpenSearch Service domain.

For more information, see Service software updates in Amazon OpenSearch Service .

Parameters:

automated_update_date (Optional[str]) – The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
cancellable (Union[bool, IResolvable, None]) – True if you’re able to cancel your service software version update. False if you can’t cancel your service software update.
current_version (Optional[str]) – The current service software version present on the domain.
description (Optional[str]) – A description of the service software update status.
new_version (Optional[str]) – The new service software version, if one is available.
optional_deployment (Union[bool, IResolvable, None]) – True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.
update_available (Union[bool, IResolvable, None]) – True if you’re able to update your service software version. False if you can’t update your service software version.
update_status (Optional[str]) – The status of your service software update.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.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

service_software_options_property = opensearchservice_mixins.CfnDomainPropsMixin.ServiceSoftwareOptionsProperty(
    automated_update_date="automatedUpdateDate",
    cancellable=False,
    current_version="currentVersion",
    description="description",
    new_version="newVersion",
    optional_deployment=False,
    update_available=False,
    update_status="updateStatus"
)

Attributes

automated_update_date

The timestamp, in Epoch time, until which you can manually request a service software update.

After this date, we automatically update your service software.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-automatedupdatedate

cancellable

True if you’re able to cancel your service software version update.

False if you can’t cancel your service software update.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-cancellable

current_version

The current service software version present on the domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-currentversion

description

A description of the service software update status.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-description

new_version

The new service software version, if one is available.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-newversion

optional_deployment

True if a service software is never automatically updated.

False if a service software is automatically updated after the automated update date.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-optionaldeployment

update_available

True if you’re able to update your service software version.

False if you can’t update your service software version.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-updateavailable

update_status

The status of your service software update.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-updatestatus

SnapshotOptionsProperty

class CfnDomainPropsMixin.SnapshotOptionsProperty(*, automated_snapshot_start_hour=None)

Bases: object

DEPRECATED .

This setting is only relevant to domains running legacy Elasticsearch OSS versions earlier than 5.3. It does not apply to OpenSearch domains.

The automated snapshot configuration for the OpenSearch Service domain indexes.

Parameters:: automated_snapshot_start_hour (Union[int, float, None]) – The hour in UTC during which the service takes an automated daily snapshot of the indexes in the OpenSearch Service domain. For example, if you specify 0, OpenSearch Service takes an automated snapshot everyday between midnight and 1 am. You can specify a value between 0 and 23.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-snapshotoptions.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

snapshot_options_property = opensearchservice_mixins.CfnDomainPropsMixin.SnapshotOptionsProperty(
    automated_snapshot_start_hour=123
)

Attributes

automated_snapshot_start_hour

The hour in UTC during which the service takes an automated daily snapshot of the indexes in the OpenSearch Service domain.

For example, if you specify 0, OpenSearch Service takes an automated snapshot everyday between midnight and 1 am. You can specify a value between 0 and 23.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-snapshotoptions.html#cfn-opensearchservice-domain-snapshotoptions-automatedsnapshotstarthour

SoftwareUpdateOptionsProperty

class CfnDomainPropsMixin.SoftwareUpdateOptionsProperty(*, auto_software_update_enabled=None)

Bases: object

Options for configuring service software updates for a domain.

Parameters:: auto_software_update_enabled (Union[bool, IResolvable, None]) – Specifies whether automatic service software updates are enabled for the domain.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-softwareupdateoptions.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

software_update_options_property = opensearchservice_mixins.CfnDomainPropsMixin.SoftwareUpdateOptionsProperty(
    auto_software_update_enabled=False
)

Attributes

auto_software_update_enabled

Specifies whether automatic service software updates are enabled for the domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-softwareupdateoptions.html#cfn-opensearchservice-domain-softwareupdateoptions-autosoftwareupdateenabled

VPCOptionsProperty

class CfnDomainPropsMixin.VPCOptionsProperty(*, security_group_ids=None, subnet_ids=None)

Bases: object

The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

For more information, see Launching your Amazon OpenSearch Service domains using a VPC in the Amazon OpenSearch Service Developer Guide .

Parameters:

security_group_ids (Optional[Sequence[str]]) – The list of security group IDs that are associated with the VPC endpoints for the domain. If you don’t provide a security group ID, OpenSearch Service uses the default security group for the VPC. To learn more, see Security groups for your VPC in the Amazon VPC User Guide .
subnet_ids (Optional[Sequence[str]]) – Provide one subnet ID for each Availability Zone that your domain uses. For example, you must specify three subnet IDs for a three-AZ domain. To learn more, see VPCs and subnets in the Amazon VPC User Guide . If you specify more than one subnet, you must also configure ZoneAwarenessEnabled and ZoneAwarenessConfig within ClusterConfig , otherwise you’ll see the error “You must specify exactly one subnet” during template creation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-vpcoptions.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

v_pCOptions_property = opensearchservice_mixins.CfnDomainPropsMixin.VPCOptionsProperty(
    security_group_ids=["securityGroupIds"],
    subnet_ids=["subnetIds"]
)

Attributes

security_group_ids

The list of security group IDs that are associated with the VPC endpoints for the domain.

If you don’t provide a security group ID, OpenSearch Service uses the default security group for the VPC. To learn more, see Security groups for your VPC in the Amazon VPC User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-vpcoptions.html#cfn-opensearchservice-domain-vpcoptions-securitygroupids

subnet_ids

Provide one subnet ID for each Availability Zone that your domain uses.

For example, you must specify three subnet IDs for a three-AZ domain. To learn more, see VPCs and subnets in the Amazon VPC User Guide .

If you specify more than one subnet, you must also configure ZoneAwarenessEnabled and ZoneAwarenessConfig within ClusterConfig , otherwise you’ll see the error “You must specify exactly one subnet” during template creation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-vpcoptions.html#cfn-opensearchservice-domain-vpcoptions-subnetids

WindowStartTimeProperty

class CfnDomainPropsMixin.WindowStartTimeProperty(*, hours=None, minutes=None)

Bases: object

A custom start time for the off-peak window, in Coordinated Universal Time (UTC).

The window length will always be 10 hours, so you can’t specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

Parameters:

hours (Union[int, float, None]) – The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC. The minimum value is 0 and the maximum value is 23.
minutes (Union[int, float, None]) – The start minute of the window, in UTC. The minimum value is 0 and the maximum value is 59.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-windowstarttime.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

window_start_time_property = opensearchservice_mixins.CfnDomainPropsMixin.WindowStartTimeProperty(
    hours=123,
    minutes=123
)

Attributes

hours

The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time.

For example, 17 refers to 5:00 P.M. UTC. The minimum value is 0 and the maximum value is 23.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-windowstarttime.html#cfn-opensearchservice-domain-windowstarttime-hours

minutes

The start minute of the window, in UTC.

The minimum value is 0 and the maximum value is 59.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-windowstarttime.html#cfn-opensearchservice-domain-windowstarttime-minutes

ZoneAwarenessConfigProperty

class CfnDomainPropsMixin.ZoneAwarenessConfigProperty(*, availability_zone_count=None)

Bases: object

Specifies zone awareness configuration options.

Only use if ZoneAwarenessEnabled is true .

Parameters:: availability_zone_count (Union[int, float, None]) – If you enabled multiple Availability Zones (AZs), the number of AZs that you want the domain to use. Valid values are 2 and 3 . Default is 2.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-zoneawarenessconfig.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

zone_awareness_config_property = opensearchservice_mixins.CfnDomainPropsMixin.ZoneAwarenessConfigProperty(
    availability_zone_count=123
)

Attributes

availability_zone_count

If you enabled multiple Availability Zones (AZs), the number of AZs that you want the domain to use.

Valid values are 2 and 3 . Default is 2.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-zoneawarenessconfig.html#cfn-opensearchservice-domain-zoneawarenessconfig-availabilityzonecount