Skip to content

UpdateElasticsearchDomainConfigRequest

Source code in docs_src/capo_elasticsearch_service/types/update_elasticsearch_domain_config_request.py
class UpdateElasticsearchDomainConfigRequest(TypedDict, closed=True):
    domain_name: "capo_elasticsearch_service.types.domain_name.DomainName"
    """<p>The name of the Elasticsearch domain that you are updating. </p>"""
    elasticsearch_cluster_config: NotRequired[
        "capo_elasticsearch_service.types.elasticsearch_cluster_config.ElasticsearchClusterConfig"
    ]
    """<p>The type and number of instances to instantiate for the domain cluster.</p>"""
    ebs_options: NotRequired["capo_elasticsearch_service.types.ebs_options.EBSOptions"]
    """<p>Specify the type and size of the EBS volume that you want to use. </p>"""
    snapshot_options: NotRequired[
        "capo_elasticsearch_service.types.snapshot_options.SnapshotOptions"
    ]
    """<p>Option to set the time, in UTC format, for the daily automated snapshot. Default value is <code>0</code> hours. </p>"""
    vpc_options: NotRequired["capo_elasticsearch_service.types.vpc_options.VPCOptions"]
    """<p>Options to specify the subnets and security groups for VPC endpoint. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc" target="_blank">Creating a VPC</a> in <i>VPC Endpoints for Amazon Elasticsearch Service Domains</i></p>"""
    cognito_options: NotRequired[
        "capo_elasticsearch_service.types.cognito_options.CognitoOptions"
    ]
    """<p>Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html" target="_blank">Amazon Cognito Authentication for Kibana</a>.</p>"""
    advanced_options: NotRequired[
        "capo_elasticsearch_service.types.advanced_options.AdvancedOptions"
    ]
    """<p>Modifies the advanced option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options" target="_blank">Configuration Advanced Options</a> for more information.</p>"""
    access_policies: NotRequired[
        "capo_elasticsearch_service.types.policy_document.PolicyDocument"
    ]
    """<p>IAM access policy as a JSON-formatted string.</p>"""
    log_publishing_options: NotRequired[
        "capo_elasticsearch_service.types.log_publishing_options.LogPublishingOptions"
    ]
    """<p>Map of <code>LogType</code> and <code>LogPublishingOption</code>, each containing options to publish a given type of Elasticsearch log.</p>"""
    domain_endpoint_options: NotRequired[
        "capo_elasticsearch_service.types.domain_endpoint_options.DomainEndpointOptions"
    ]
    """<p>Options to specify configuration that will be applied to the domain endpoint.</p>"""
    advanced_security_options: NotRequired[
        "capo_elasticsearch_service.types.advanced_security_options_input.AdvancedSecurityOptionsInput"
    ]
    """<p>Specifies advanced security options.</p>"""
    node_to_node_encryption_options: NotRequired[
        "capo_elasticsearch_service.types.node_to_node_encryption_options.NodeToNodeEncryptionOptions"
    ]
    """<p>Specifies the NodeToNodeEncryptionOptions.</p>"""
    encryption_at_rest_options: NotRequired[
        "capo_elasticsearch_service.types.encryption_at_rest_options.EncryptionAtRestOptions"
    ]
    """<p>Specifies the Encryption At Rest Options.</p>"""
    auto_tune_options: NotRequired[
        "capo_elasticsearch_service.types.auto_tune_options.AutoTuneOptions"
    ]
    """<p>Specifies Auto-Tune options.</p>"""
    dry_run: NotRequired["capo_elasticsearch_service.types.dry_run.DryRun"]
    """<p> This flag, when set to True, specifies whether the <code>UpdateElasticsearchDomain</code> request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update. </p>"""
    deployment_strategy_options: NotRequired[
        "capo_elasticsearch_service.types.deployment_strategy_options.DeploymentStrategyOptions"
    ]
    """<p>Specifies the deployment strategy options.</p>"""
    automated_snapshot_pause_options: NotRequired[
        "capo_elasticsearch_service.types.automated_snapshot_pause_request_options.AutomatedSnapshotPauseRequestOptions"
    ]
    """<p>Specifies the automated snapshot pause options for the domain.</p> <important> <p>Suspending snapshots reduces data protection. You cannot restore your domain to points in time when snapshots are suspended. Use this feature only for short-term operational needs such as migrations or maintenance windows.</p> </important> <p>Maximum suspension duration: 3 days.</p>"""
    use_case: NotRequired[
        "capo_elasticsearch_service.types.domain_use_case.DomainUseCase"
    ]
    """<p>The primary use case for the domain. For valid values, see <code>DomainUseCase</code>.</p>"""
    engine_mode: NotRequired[
        "capo_elasticsearch_service.types.domain_engine_mode.DomainEngineMode"
    ]
    """<p>The engine mode for the domain. For valid values and requirements, see <code>DomainEngineMode</code>.</p>"""

access_policies instance-attribute

access_policies: NotRequired[PolicyDocument]

IAM access policy as a JSON-formatted string.

advanced_options instance-attribute

advanced_options: NotRequired[AdvancedOptions]

Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

advanced_security_options instance-attribute

advanced_security_options: NotRequired[AdvancedSecurityOptionsInput]

Specifies advanced security options.

auto_tune_options instance-attribute

auto_tune_options: NotRequired[AutoTuneOptions]

Specifies Auto-Tune options.

automated_snapshot_pause_options instance-attribute

automated_snapshot_pause_options: NotRequired[AutomatedSnapshotPauseRequestOptions]

Specifies the automated snapshot pause options for the domain.

Suspending snapshots reduces data protection. You cannot restore your domain to points in time when snapshots are suspended. Use this feature only for short-term operational needs such as migrations or maintenance windows.

Maximum suspension duration: 3 days.

cognito_options instance-attribute

cognito_options: NotRequired[CognitoOptions]

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

deployment_strategy_options instance-attribute

deployment_strategy_options: NotRequired[DeploymentStrategyOptions]

Specifies the deployment strategy options.

domain_endpoint_options instance-attribute

domain_endpoint_options: NotRequired[DomainEndpointOptions]

Options to specify configuration that will be applied to the domain endpoint.

domain_name instance-attribute

domain_name: DomainName

The name of the Elasticsearch domain that you are updating.

dry_run instance-attribute

dry_run: NotRequired[DryRun]

This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update.

ebs_options instance-attribute

ebs_options: NotRequired[EBSOptions]

Specify the type and size of the EBS volume that you want to use.

elasticsearch_cluster_config instance-attribute

elasticsearch_cluster_config: NotRequired[ElasticsearchClusterConfig]

The type and number of instances to instantiate for the domain cluster.

encryption_at_rest_options instance-attribute

encryption_at_rest_options: NotRequired[EncryptionAtRestOptions]

Specifies the Encryption At Rest Options.

engine_mode instance-attribute

engine_mode: NotRequired[DomainEngineMode]

The engine mode for the domain. For valid values and requirements, see DomainEngineMode.

log_publishing_options instance-attribute

log_publishing_options: NotRequired[LogPublishingOptions]

Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

node_to_node_encryption_options instance-attribute

node_to_node_encryption_options: NotRequired[NodeToNodeEncryptionOptions]

Specifies the NodeToNodeEncryptionOptions.

snapshot_options instance-attribute

snapshot_options: NotRequired[SnapshotOptions]

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

use_case instance-attribute

use_case: NotRequired[DomainUseCase]

The primary use case for the domain. For valid values, see DomainUseCase.

vpc_options instance-attribute

vpc_options: NotRequired[VPCOptions]

Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains