CfnDomainProps

class aws_cdk.aws_opensearchservice.CfnDomainProps(*, access_policies=None, advanced_options=None, advanced_security_options=None, cluster_config=None, cognito_options=None, domain_arn=None, domain_endpoint_options=None, domain_name=None, ebs_options=None, encryption_at_rest_options=None, engine_version=None, identity_center_options=None, ip_address_type=None, log_publishing_options=None, node_to_node_encryption_options=None, off_peak_window_options=None, skip_shard_migration_wait=None, snapshot_options=None, software_update_options=None, tags=None, vpc_options=None)

Bases: object

Properties for defining a CfnDomain.

Parameters:

access_policies (Any) – An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions. For more information, see Configuring access policies in the Amazon OpenSearch Service Developer Guide .
advanced_options (Union[IResolvable, Mapping[str, str], None]) – Additional options to specify for the OpenSearch Service domain. For more information, see AdvancedOptions in the OpenSearch Service API reference.
advanced_security_options (Union[IResolvable, AdvancedSecurityOptionsInputProperty, Dict[str, Any], None]) – Specifies options for fine-grained access control and SAML authentication. 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.
cluster_config (Union[IResolvable, ClusterConfigProperty, Dict[str, Any], None]) – Container for the cluster configuration of a domain.
cognito_options (Union[IResolvable, CognitoOptionsProperty, Dict[str, Any], None]) – Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
domain_arn (Optional[str]) –
domain_endpoint_options (Union[IResolvable, DomainEndpointOptionsProperty, Dict[str, Any], None]) – 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.
domain_name (Optional[str]) – A name for the OpenSearch Service domain. The name must have a minimum length of 3 and a maximum length of 28. If you don’t specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name. For more information, see Name Type . Required when creating a new domain. .. epigraph:: If you specify a name, you can’t perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
ebs_options (Union[IResolvable, EBSOptionsProperty, Dict[str, Any], None]) – 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 .
encryption_at_rest_options (Union[IResolvable, EncryptionAtRestOptionsProperty, Dict[str, Any], None]) – Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use. See Encryption of data at rest for Amazon OpenSearch Service . 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.
engine_version (Optional[str]) – The version of OpenSearch to use. The value must be in the format OpenSearch_X.Y or Elasticsearch_X.Y . If not specified, the latest version of OpenSearch is used. For information about the versions that OpenSearch Service supports, see Supported versions of OpenSearch and Elasticsearch in the Amazon OpenSearch Service Developer Guide . If you set the EnableVersionUpgrade update policy to true , you can update EngineVersion without interruption. When EnableVersionUpgrade is set to false , or is not specified, updating EngineVersion results in replacement .
identity_center_options (Union[IResolvable, IdentityCenterOptionsProperty, Dict[str, Any], None]) – Container for IAM Identity Center Option control for the domain.
ip_address_type (Optional[str]) – Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can’t change your address type later.
log_publishing_options (Union[IResolvable, Mapping[str, Union[IResolvable, LogPublishingOptionProperty, Dict[str, Any]]], None]) – An object with one or more of the following keys: SEARCH_SLOW_LOGS , ES_APPLICATION_LOGS , INDEX_SLOW_LOGS , AUDIT_LOGS , depending on the types of logs you want to publish. Each key needs a valid LogPublishingOption value. For the full syntax, see the examples .
node_to_node_encryption_options (Union[IResolvable, NodeToNodeEncryptionOptionsProperty, Dict[str, Any], None]) – Specifies whether node-to-node encryption is enabled. See Node-to-node encryption for Amazon OpenSearch Service .
off_peak_window_options (Union[IResolvable, OffPeakWindowOptionsProperty, Dict[str, Any], None]) – Options for a domain’s off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.
skip_shard_migration_wait (Union[bool, IResolvable, None]) –
snapshot_options (Union[IResolvable, SnapshotOptionsProperty, Dict[str, Any], None]) – DEPRECATED . The automated snapshot configuration for the OpenSearch Service domain indexes.
software_update_options (Union[IResolvable, SoftwareUpdateOptionsProperty, Dict[str, Any], None]) – Service software update options for the domain.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.
vpc_options (Union[IResolvable, VPCOptionsProperty, Dict[str, Any], None]) – The virtual private cloud (VPC) configuration for the OpenSearch Service domain. For more information, see Launching your Amazon OpenSearch Service domains within a VPC in the Amazon OpenSearch Service Developer Guide . If you remove this entity altogether, along with its associated properties, it causes a replacement. You might encounter this scenario if you’re updating your security configuration from a VPC to a public endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_opensearchservice as opensearchservice

# access_policies: Any

cfn_domain_props = opensearchservice.CfnDomainProps(
    access_policies=access_policies,
    advanced_options={
        "advanced_options_key": "advancedOptions"
    },
    advanced_security_options=opensearchservice.CfnDomain.AdvancedSecurityOptionsInputProperty(
        anonymous_auth_disable_date="anonymousAuthDisableDate",
        anonymous_auth_enabled=False,
        enabled=False,
        internal_user_database_enabled=False,
        jwt_options=opensearchservice.CfnDomain.JWTOptionsProperty(
            enabled=False,
            public_key="publicKey",
            roles_key="rolesKey",
            subject_key="subjectKey"
        ),
        master_user_options=opensearchservice.CfnDomain.MasterUserOptionsProperty(
            master_user_arn="masterUserArn",
            master_user_name="masterUserName",
            master_user_password="masterUserPassword"
        ),
        saml_options=opensearchservice.CfnDomain.SAMLOptionsProperty(
            enabled=False,
            idp=opensearchservice.CfnDomain.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"
        )
    ),
    cluster_config=opensearchservice.CfnDomain.ClusterConfigProperty(
        cold_storage_options=opensearchservice.CfnDomain.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,
        warm_count=123,
        warm_enabled=False,
        warm_type="warmType",
        zone_awareness_config=opensearchservice.CfnDomain.ZoneAwarenessConfigProperty(
            availability_zone_count=123
        ),
        zone_awareness_enabled=False
    ),
    cognito_options=opensearchservice.CfnDomain.CognitoOptionsProperty(
        enabled=False,
        identity_pool_id="identityPoolId",
        role_arn="roleArn",
        user_pool_id="userPoolId"
    ),
    domain_arn="domainArn",
    domain_endpoint_options=opensearchservice.CfnDomain.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.CfnDomain.EBSOptionsProperty(
        ebs_enabled=False,
        iops=123,
        throughput=123,
        volume_size=123,
        volume_type="volumeType"
    ),
    encryption_at_rest_options=opensearchservice.CfnDomain.EncryptionAtRestOptionsProperty(
        enabled=False,
        kms_key_id="kmsKeyId"
    ),
    engine_version="engineVersion",
    identity_center_options=opensearchservice.CfnDomain.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.CfnDomain.LogPublishingOptionProperty(
            cloud_watch_logs_log_group_arn="cloudWatchLogsLogGroupArn",
            enabled=False
        )
    },
    node_to_node_encryption_options=opensearchservice.CfnDomain.NodeToNodeEncryptionOptionsProperty(
        enabled=False
    ),
    off_peak_window_options=opensearchservice.CfnDomain.OffPeakWindowOptionsProperty(
        enabled=False,
        off_peak_window=opensearchservice.CfnDomain.OffPeakWindowProperty(
            window_start_time=opensearchservice.CfnDomain.WindowStartTimeProperty(
                hours=123,
                minutes=123
            )
        )
    ),
    skip_shard_migration_wait=False,
    snapshot_options=opensearchservice.CfnDomain.SnapshotOptionsProperty(
        automated_snapshot_start_hour=123
    ),
    software_update_options=opensearchservice.CfnDomain.SoftwareUpdateOptionsProperty(
        auto_software_update_enabled=False
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_options=opensearchservice.CfnDomain.VPCOptionsProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
)

Attributes

access_policies

An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.

For more information, see Configuring access policies in the Amazon OpenSearch Service Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-accesspolicies

advanced_options

Additional options to specify for the OpenSearch Service domain.

For more information, see AdvancedOptions in the OpenSearch Service API reference.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-advancedoptions

advanced_security_options

Specifies options for fine-grained access control and SAML authentication.

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-advancedsecurityoptions

cluster_config

Container for the cluster configuration of a domain.

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

cognito_options

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

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

domain_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-domainarn

Type:: see

domain_endpoint_options

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.

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

domain_name

A name for the OpenSearch Service domain.

The name must have a minimum length of 3 and a maximum length of 28. If you don’t specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name. For more information, see Name Type .

Required when creating a new domain. .. epigraph:

If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-domainname

ebs_options

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 .

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

encryption_at_rest_options

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

See Encryption of data at rest for Amazon OpenSearch Service .

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-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-encryptionatrestoptions

engine_version

The version of OpenSearch to use.

The value must be in the format OpenSearch_X.Y or Elasticsearch_X.Y . If not specified, the latest version of OpenSearch is used. For information about the versions that OpenSearch Service supports, see Supported versions of OpenSearch and Elasticsearch in the Amazon OpenSearch Service Developer Guide .

If you set the EnableVersionUpgrade update policy to true , you can update EngineVersion without interruption. When EnableVersionUpgrade is set to false , or is not specified, updating EngineVersion results in replacement .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-engineversion

identity_center_options

Container for IAM Identity Center Option control for the domain.

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

ip_address_type

Choose either dual stack or IPv4 as your IP address type.

Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can’t change your address type later.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-ipaddresstype

log_publishing_options

SEARCH_SLOW_LOGS , ES_APPLICATION_LOGS , INDEX_SLOW_LOGS , AUDIT_LOGS , depending on the types of logs you want to publish.

Each key needs a valid LogPublishingOption value. For the full syntax, see the examples .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-logpublishingoptions
Type:: An object with one or more of the following keys

node_to_node_encryption_options

Specifies whether node-to-node encryption is enabled.

See Node-to-node encryption for Amazon OpenSearch Service .

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

off_peak_window_options

Options for a domain’s off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

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

skip_shard_migration_wait

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-skipshardmigrationwait

Type:: see

snapshot_options

DEPRECATED .

The automated snapshot configuration for the OpenSearch Service domain indexes.

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

software_update_options

Service software update options for the domain.

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

tags

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-tags

vpc_options

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

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

If you remove this entity altogether, along with its associated properties, it causes a replacement. You might encounter this scenario if you’re updating your security configuration from a VPC to a public endpoint.

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