CfnDomain

class aws_cdk.aws_opensearchservice.CfnDomain(scope, id, *, 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, ip_address_type=None, log_publishing_options=None, node_to_node_encryption_options=None, off_peak_window_options=None, snapshot_options=None, software_update_options=None, tags=None, vpc_options=None)

Bases: CfnResource

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

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 = opensearchservice.CfnDomain(self, "MyCfnDomain",
    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,
        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",
    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
            )
        )
    ),
    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"]
    )
)

Parameters:

• scope (Construct) – Scope in which this resource is defined.

• id (str) – Construct identifier for this resource (unique in its scope).

• access_policies (Optional[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 .

• 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.

• 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

• key (str) –

• value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

• path (str) –

  • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

• value (Any) –

  • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

• property_path (str) – The path of the property.

• value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

• policy (Optional[RemovalPolicy]) –

• apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

• default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

• attribute_name (str) – The name of the attribute.

• type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

• target (CfnResource) – The dependency to replace.

• new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::OpenSearchService::Domain'

access_policies

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

advanced_options

Additional options to specify for the OpenSearch Service domain.

advanced_security_options

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

attr_advanced_security_options_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 .

CloudformationAttribute:

AdvancedSecurityOptions.AnonymousAuthDisableDate

attr_arn

The Amazon Resource Name (ARN) of the CloudFormation stack.

CloudformationAttribute:

Arn

attr_domain_endpoint

The domain-specific endpoint used for requests to the OpenSearch APIs, such as search-mystack-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com .

CloudformationAttribute:

DomainEndpoint

attr_domain_endpoint_v2

If IPAddressType to set to dualstack , a version 2 domain endpoint is provisioned.

This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

CloudformationAttribute:

DomainEndpointV2

attr_domain_endpoints

DomainEndpoints

Type:

cloudformationAttribute

attr_id

The resource ID.

For example, 123456789012/my-domain .

CloudformationAttribute:

Id

attr_service_software_options

ServiceSoftwareOptions

Type:

cloudformationAttribute

attr_service_software_options_automated_update_date

ServiceSoftwareOptions.AutomatedUpdateDate

Type:

cloudformationAttribute

attr_service_software_options_cancellable

ServiceSoftwareOptions.Cancellable

Type:

cloudformationAttribute

attr_service_software_options_current_version

ServiceSoftwareOptions.CurrentVersion

Type:

cloudformationAttribute

attr_service_software_options_description

ServiceSoftwareOptions.Description

Type:

cloudformationAttribute

attr_service_software_options_new_version

ServiceSoftwareOptions.NewVersion

Type:

cloudformationAttribute

attr_service_software_options_optional_deployment

ServiceSoftwareOptions.OptionalDeployment

Type:

cloudformationAttribute

attr_service_software_options_update_available

ServiceSoftwareOptions.UpdateAvailable

Type:

cloudformationAttribute

attr_service_software_options_update_status

ServiceSoftwareOptions.UpdateStatus

Type:

cloudformationAttribute

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

cluster_config

Container for the cluster configuration of a domain.

cognito_options

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

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

domain_arn

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.

domain_name

A name for the OpenSearch Service domain.

ebs_options

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

encryption_at_rest_options

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

engine_version

The version of OpenSearch to use.

ip_address_type

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

log_publishing_options

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

Type:

An object with one or more of the following keys

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The tree node.

node_to_node_encryption_options

Specifies whether node-to-node encryption is enabled.

off_peak_window_options

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

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

snapshot_options

DEPRECATED .

software_update_options

Service software update options for the domain.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Tag Manager which manages the tags for this resource.

tags_raw

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

vpc_options

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AdvancedSecurityOptionsInputProperty

class CfnDomain.AdvancedSecurityOptionsInputProperty(*, anonymous_auth_disable_date=None, anonymous_auth_enabled=None, enabled=None, internal_user_database_enabled=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 .

• 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.

• 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 import aws_opensearchservice as opensearchservice

advanced_security_options_input_property = opensearchservice.CfnDomain.AdvancedSecurityOptionsInputProperty(
    anonymous_auth_disable_date="anonymousAuthDisableDate",
    anonymous_auth_enabled=False,
    enabled=False,
    internal_user_database_enabled=False,
    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"
    )
)

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

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

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 CfnDomain.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, 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 .

• 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 import aws_opensearchservice as opensearchservice

cluster_config_property = 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
)

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

//docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html>`_ .

See:

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

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 <https

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

//docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html>`_ .

See:

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

Type:

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

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

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 CfnDomain.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 import aws_opensearchservice as opensearchservice

cognito_options_property = opensearchservice.CfnDomain.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 CfnDomain.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 import aws_opensearchservice as opensearchservice

cold_storage_options_property = opensearchservice.CfnDomain.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 CfnDomain.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 AWS 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. 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-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 import aws_opensearchservice as opensearchservice

domain_endpoint_options_property = opensearchservice.CfnDomain.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 AWS 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

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

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. Valid values are TLS 1.3 (recommended) or 1.2

EBSOptionsProperty

class CfnDomain.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 import aws_opensearchservice as opensearchservice

e_bSOptions_property = opensearchservice.CfnDomain.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 CfnDomain.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 import aws_opensearchservice as opensearchservice

encryption_at_rest_options_property = opensearchservice.CfnDomain.EncryptionAtRestOptionsProperty(
    enabled=False,
    kms_key_id="kmsKeyId"
)

Attributes

enabled

//docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html>`_ .

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

Type:

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

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

IdpProperty

class CfnDomain.IdpProperty(*, entity_id, metadata_content)

Bases: object

The SAML Identity Provider’s information.

Parameters:

• entity_id (str) – The unique entity ID of the application in the SAML identity provider.

• metadata_content (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 import aws_opensearchservice as opensearchservice

idp_property = opensearchservice.CfnDomain.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

LogPublishingOptionProperty

class CfnDomain.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 import aws_opensearchservice as opensearchservice

log_publishing_option_property = opensearchservice.CfnDomain.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 CfnDomain.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 import aws_opensearchservice as opensearchservice

master_user_options_property = opensearchservice.CfnDomain.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

//docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html>`_ .

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

Type:

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

master_user_password

//docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html>`_ .

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

Type:

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

NodeToNodeEncryptionOptionsProperty

class CfnDomain.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 import aws_opensearchservice as opensearchservice

node_to_node_encryption_options_property = opensearchservice.CfnDomain.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 CfnDomain.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 import aws_opensearchservice as opensearchservice

off_peak_window_options_property = opensearchservice.CfnDomain.OffPeakWindowOptionsProperty(
    enabled=False,
    off_peak_window=opensearchservice.CfnDomain.OffPeakWindowProperty(
        window_start_time=opensearchservice.CfnDomain.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 CfnDomain.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 import aws_opensearchservice as opensearchservice

off_peak_window_property = opensearchservice.CfnDomain.OffPeakWindowProperty(
    window_start_time=opensearchservice.CfnDomain.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

SAMLOptionsProperty

class CfnDomain.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 import aws_opensearchservice as opensearchservice

s_aMLOptions_property = 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"
)

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 CfnDomain.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 import aws_opensearchservice as opensearchservice

service_software_options_property = opensearchservice.CfnDomain.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 CfnDomain.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 import aws_opensearchservice as opensearchservice

snapshot_options_property = opensearchservice.CfnDomain.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 CfnDomain.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 import aws_opensearchservice as opensearchservice

software_update_options_property = opensearchservice.CfnDomain.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 CfnDomain.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 import aws_opensearchservice as opensearchservice

v_pCOptions_property = opensearchservice.CfnDomain.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 CfnDomain.WindowStartTimeProperty(*, hours, minutes)

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]) – 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]) – 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 import aws_opensearchservice as opensearchservice

window_start_time_property = opensearchservice.CfnDomain.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 CfnDomain.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 import aws_opensearchservice as opensearchservice

zone_awareness_config_property = opensearchservice.CfnDomain.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