CfnDomainPropsMixin

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

Bases: Mixin

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html
CloudformationResource:: AWS::Elasticsearch::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_elasticsearch import mixins as elasticsearch_mixins

# access_policies: Any

cfn_domain_props_mixin = elasticsearch_mixins.CfnDomainPropsMixin(elasticsearch_mixins.CfnDomainMixinProps(
    access_policies=access_policies,
    advanced_options={
        "advanced_options_key": "advancedOptions"
    },
    advanced_security_options=elasticsearch_mixins.CfnDomainPropsMixin.AdvancedSecurityOptionsInputProperty(
        anonymous_auth_enabled=False,
        enabled=False,
        internal_user_database_enabled=False,
        master_user_options=elasticsearch_mixins.CfnDomainPropsMixin.MasterUserOptionsProperty(
            master_user_arn="masterUserArn",
            master_user_name="masterUserName",
            master_user_password="masterUserPassword"
        )
    ),
    cognito_options=elasticsearch_mixins.CfnDomainPropsMixin.CognitoOptionsProperty(
        enabled=False,
        identity_pool_id="identityPoolId",
        role_arn="roleArn",
        user_pool_id="userPoolId"
    ),
    domain_arn="domainArn",
    domain_endpoint_options=elasticsearch_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=elasticsearch_mixins.CfnDomainPropsMixin.EBSOptionsProperty(
        ebs_enabled=False,
        iops=123,
        volume_size=123,
        volume_type="volumeType"
    ),
    elasticsearch_cluster_config=elasticsearch_mixins.CfnDomainPropsMixin.ElasticsearchClusterConfigProperty(
        cold_storage_options=elasticsearch_mixins.CfnDomainPropsMixin.ColdStorageOptionsProperty(
            enabled=False
        ),
        dedicated_master_count=123,
        dedicated_master_enabled=False,
        dedicated_master_type="dedicatedMasterType",
        instance_count=123,
        instance_type="instanceType",
        warm_count=123,
        warm_enabled=False,
        warm_type="warmType",
        zone_awareness_config=elasticsearch_mixins.CfnDomainPropsMixin.ZoneAwarenessConfigProperty(
            availability_zone_count=123
        ),
        zone_awareness_enabled=False
    ),
    elasticsearch_version="elasticsearchVersion",
    encryption_at_rest_options=elasticsearch_mixins.CfnDomainPropsMixin.EncryptionAtRestOptionsProperty(
        enabled=False,
        kms_key_id="kmsKeyId"
    ),
    log_publishing_options={
        "log_publishing_options_key": elasticsearch_mixins.CfnDomainPropsMixin.LogPublishingOptionProperty(
            cloud_watch_logs_log_group_arn="cloudWatchLogsLogGroupArn",
            enabled=False
        )
    },
    node_to_node_encryption_options=elasticsearch_mixins.CfnDomainPropsMixin.NodeToNodeEncryptionOptionsProperty(
        enabled=False
    ),
    snapshot_options=elasticsearch_mixins.CfnDomainPropsMixin.SnapshotOptionsProperty(
        automated_snapshot_start_hour=123
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_options=elasticsearch_mixins.CfnDomainPropsMixin.VPCOptionsProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Elasticsearch::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', 'cognitoOptions', 'domainArn', 'domainEndpointOptions', 'domainName', 'ebsOptions', 'elasticsearchClusterConfig', 'elasticsearchVersion', 'encryptionAtRestOptions', 'logPublishingOptions', 'nodeToNodeEncryptionOptions', 'snapshotOptions', '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

AdvancedSecurityOptionsInputProperty

class CfnDomainPropsMixin.AdvancedSecurityOptionsInputProperty(*, anonymous_auth_enabled=None, enabled=None, internal_user_database_enabled=None, master_user_options=None)

Bases: object

Specifies options for fine-grained access control.

Parameters:

anonymous_auth_enabled (Union[bool, IResolvable, None])
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.
internal_user_database_enabled (Union[bool, IResolvable, None]) – True to enable the internal user database.
master_user_options (Union[IResolvable, MasterUserOptionsProperty, Dict[str, Any], None]) – Specifies information about the master user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-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_elasticsearch import mixins as elasticsearch_mixins

advanced_security_options_input_property = elasticsearch_mixins.CfnDomainPropsMixin.AdvancedSecurityOptionsInputProperty(
    anonymous_auth_enabled=False,
    enabled=False,
    internal_user_database_enabled=False,
    master_user_options=elasticsearch_mixins.CfnDomainPropsMixin.MasterUserOptionsProperty(
        master_user_arn="masterUserArn",
        master_user_name="masterUserName",
        master_user_password="masterUserPassword"
    )
)

Attributes

anonymous_auth_enabled

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

Type:: see

enabled

True to enable fine-grained access control.

You must also enable encryption of data at rest and node-to-node encryption.

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

internal_user_database_enabled

True to enable the internal user database.

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

master_user_options

Specifies information about the master user.

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

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 enable Cognito authentication.
role_arn (Optional[str]) – The AmazonESCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool. Required if you enable Cognito authentication.
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 enable Cognito authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-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_elasticsearch import mixins as elasticsearch_mixins

cognito_options_property = elasticsearch_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-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-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 enable Cognito authentication.

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

role_arn

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

Required if you enable Cognito authentication.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-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 enable Cognito authentication.

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

ColdStorageOptionsProperty

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

Bases: object

Specifies options for cold storage. For more information, see Cold storage for Amazon Elasticsearch Service .

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

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

Attributes

enabled

Whether to enable or disable cold storage on the domain.

You must enable UltraWarm storage in order to enable cold storage.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-coldstorageoptions.html#cfn-elasticsearch-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.
tls_security_policy (Optional[str]) – The minimum TLS version required for traffic to the domain. Valid values are TLS 1.3 (recommended) or 1.2:. - Policy-Min-TLS-1-0-2019-07 - Policy-Min-TLS-1-2-2019-07

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-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_elasticsearch import mixins as elasticsearch_mixins

domain_endpoint_options_property = elasticsearch_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-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-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-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-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-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-customendpointenabled

enforce_https

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

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

tls_security_policy

.

Policy-Min-TLS-1-0-2019-07
Policy-Min-TLS-1-2-2019-07

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-tlssecuritypolicy
Type:: The minimum TLS version required for traffic to the domain. Valid values are TLS 1.3 (recommended) or 1.2

EBSOptionsProperty

class CfnDomainPropsMixin.EBSOptionsProperty(*, ebs_enabled=None, iops=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 . .. epigraph:

The ``AWS::Elasticsearch::Domain`` resource is being replaced by the `AWS::OpenSearchService::Domain <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html>`_ resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see `New resource types <https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource>`_ 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 provisioned IOPS EBS volume types.
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, such as standard, gp2, or io1. 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-elasticsearch-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_elasticsearch import mixins as elasticsearch_mixins

e_bSOptions_property = elasticsearch_mixins.CfnDomainPropsMixin.EBSOptionsProperty(
    ebs_enabled=False,
    iops=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-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-ebsenabled

iops

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

This property applies only to provisioned IOPS EBS volume types.

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

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-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-volumesize

volume_type

The EBS volume type to use with the OpenSearch Service domain, such as standard, gp2, or io1.

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-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-volumetype

ElasticsearchClusterConfigProperty

class CfnDomainPropsMixin.ElasticsearchClusterConfigProperty(*, cold_storage_options=None, dedicated_master_count=None, dedicated_master_enabled=None, dedicated_master_type=None, instance_count=None, instance_type=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 . .. epigraph:

The ``AWS::Elasticsearch::Domain`` resource is being replaced by the `AWS::OpenSearchService::Domain <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html>`_ resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see `New resource types <https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource>`_ in the *Amazon OpenSearch Service Developer Guide* .

Parameters:

cold_storage_options (Union[IResolvable, ColdStorageOptionsProperty, Dict[str, Any], None]) – Specifies cold storage options for the domain.
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.elasticsearch . 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.elasticsearch . For valid values, see Supported instance types in Amazon OpenSearch Service .
warm_count (Union[int, float, None]) – The number of warm nodes in the cluster. Required if you enable warm storage.
warm_enabled (Union[bool, IResolvable, None]) – Whether to enable warm storage for the cluster.
warm_type (Optional[str]) – The instance type for the cluster’s warm nodes. Required if you enable warm storage.
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-elasticsearch-domain-elasticsearchclusterconfig.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_elasticsearch import mixins as elasticsearch_mixins

elasticsearch_cluster_config_property = elasticsearch_mixins.CfnDomainPropsMixin.ElasticsearchClusterConfigProperty(
    cold_storage_options=elasticsearch_mixins.CfnDomainPropsMixin.ColdStorageOptionsProperty(
        enabled=False
    ),
    dedicated_master_count=123,
    dedicated_master_enabled=False,
    dedicated_master_type="dedicatedMasterType",
    instance_count=123,
    instance_type="instanceType",
    warm_count=123,
    warm_enabled=False,
    warm_type="warmType",
    zone_awareness_config=elasticsearch_mixins.CfnDomainPropsMixin.ZoneAwarenessConfigProperty(
        availability_zone_count=123
    ),
    zone_awareness_enabled=False
)

Attributes

cold_storage_options

Specifies cold storage options for the domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-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-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-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-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-dedicatedmasterenabled

dedicated_master_type

The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.elasticsearch . 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-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-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-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-instancecount

instance_type

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

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

warm_count

The number of warm nodes in the cluster.

Required if you enable warm storage.

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

warm_enabled

Whether to enable warm storage for the cluster.

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

warm_type

The instance type for the cluster’s warm nodes.

Required if you enable warm storage.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-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-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-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-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticsearchclusterconfig-zoneawarenessenabled

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.
kms_key_id (Optional[str]) – The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a . Required if you enable encryption at rest.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-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_elasticsearch import mixins as elasticsearch_mixins

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

Attributes

enabled

Specify true to enable encryption at rest.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html#cfn-elasticsearch-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.

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

LogPublishingOptionProperty

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

Bases: object

The AWS::Elasticsearch::Domain resource is being replaced by the AWS::OpenSearchService::Domain resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see New resource types in the Amazon OpenSearch Service Developer Guide .

Attributes

cloud_watch_logs_log_group_arn

Specifies the CloudWatch log group to publish to.

Required if you enable log publishing for the domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-logpublishingoption.html#cfn-elasticsearch-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-elasticsearch-domain-logpublishingoption.html#cfn-elasticsearch-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 you enabled the internal user database.

Parameters:

master_user_arn (Optional[str]) – ARN for the master user. Only specify if InternalUserDatabaseEnabled is false in AdvancedSecurityOptions .
master_user_name (Optional[str]) – Username for the master user. Only specify if InternalUserDatabaseEnabled is true in AdvancedSecurityOptions .
master_user_password (Optional[str]) – Password for the master user. Only specify if InternalUserDatabaseEnabled is true in AdvancedSecurityOptions .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-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_elasticsearch import mixins as elasticsearch_mixins

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

Attributes

master_user_arn

ARN for the master user.

Only specify if InternalUserDatabaseEnabled is false in AdvancedSecurityOptions .

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

master_user_name

Username for the master user.

Only specify if InternalUserDatabaseEnabled is true in AdvancedSecurityOptions .

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

master_user_password

Password for the master user.

Only specify if InternalUserDatabaseEnabled is true in AdvancedSecurityOptions .

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

NodeToNodeEncryptionOptionsProperty

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

Bases: object

Specifies whether node-to-node encryption is enabled.

Parameters:: enabled (Union[bool, IResolvable, None]) – Specifies whether node-to-node encryption is enabled, as a Boolean.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-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_elasticsearch import mixins as elasticsearch_mixins

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

Attributes

enabled

Specifies whether node-to-node encryption is enabled, as a Boolean.

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

SnapshotOptionsProperty

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

Bases: object

The AWS::Elasticsearch::Domain resource is being replaced by the AWS::OpenSearchService::Domain resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see New resource types in the Amazon OpenSearch Service Developer Guide .

Attributes

automated_snapshot_start_hour

The hour in UTC during which the service takes an automated daily snapshot of the indices 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-elasticsearch-domain-snapshotoptions.html#cfn-elasticsearch-domain-snapshotoptions-automatedsnapshotstarthour

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 . .. epigraph:

The ``AWS::Elasticsearch::Domain`` resource is being replaced by the `AWS::OpenSearchService::Domain <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html>`_ resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see `New resource types <https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource>`_ 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 Availability Zone domain. To learn more, see VPCs and subnets in the Amazon VPC User Guide . Required if you’re creating your domain inside a VPC.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-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_elasticsearch import mixins as elasticsearch_mixins

v_pCOptions_property = elasticsearch_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-elasticsearch-domain-vpcoptions.html#cfn-elasticsearch-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 Availability Zone domain. To learn more, see VPCs and subnets in the Amazon VPC User Guide .

Required if you’re creating your domain inside a VPC.

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

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-elasticsearch-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_elasticsearch import mixins as elasticsearch_mixins

zone_awareness_config_property = elasticsearch_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-elasticsearch-domain-zoneawarenessconfig.html#cfn-elasticsearch-domain-zoneawarenessconfig-availabilityzonecount