Class: Aws::OpenSearchService::Types::UpdateDomainConfigRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::OpenSearchService::Types::UpdateDomainConfigRequest
- Defined in:
- gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb
Overview
Container for the request parameters to the UpdateDomain
operation.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#access_policies ⇒ String
Identity and Access Management (IAM) access policy as a JSON-formatted string.
-
#advanced_options ⇒ Hash<String,String>
Key-value pairs to specify advanced configuration options.
-
#advanced_security_options ⇒ Types::AdvancedSecurityOptionsInput
Options for fine-grained access control.
-
#auto_tune_options ⇒ Types::AutoTuneOptions
Options for Auto-Tune.
-
#cluster_config ⇒ Types::ClusterConfig
Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
-
#cognito_options ⇒ Types::CognitoOptions
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
-
#domain_endpoint_options ⇒ Types::DomainEndpointOptions
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
-
#domain_name ⇒ String
The name of the domain that you're updating.
-
#dry_run ⇒ Boolean
This flag, when set to True, specifies whether the
UpdateDomain
request should return the results of a dry run analysis without actually applying the change. -
#dry_run_mode ⇒ String
The type of dry run to perform.
-
#ebs_options ⇒ Types::EBSOptions
The type and size of the EBS volume to attach to instances in the domain.
-
#encryption_at_rest_options ⇒ Types::EncryptionAtRestOptions
Encryption at rest options for the domain.
-
#ip_address_type ⇒ String
Specify either dual stack or IPv4 as your IP address type.
-
#log_publishing_options ⇒ Hash<String,Types::LogPublishingOption>
Options to publish OpenSearch logs to Amazon CloudWatch Logs.
-
#node_to_node_encryption_options ⇒ Types::NodeToNodeEncryptionOptions
Node-to-node encryption options for the domain.
-
#off_peak_window_options ⇒ Types::OffPeakWindowOptions
Off-peak window options for the domain.
-
#snapshot_options ⇒ Types::SnapshotOptions
Option to set the time, in UTC format, for the daily automated snapshot.
-
#software_update_options ⇒ Types::SoftwareUpdateOptions
Service software update options for the domain.
-
#vpc_options ⇒ Types::VPCOptions
Options to specify the subnets and security groups for a VPC endpoint.
Instance Attribute Details
#access_policies ⇒ String
Identity and Access Management (IAM) access policy as a JSON-formatted string.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |
#advanced_options ⇒ Hash<String,String>
Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:
"rest.action.multi.allow_explicit_index": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true."indices.fielddata.cache.size": "80"
- Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded."indices.query.bool.max_clause_count": "1024"
- Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in aTooManyClauses
error.
For more information, see Advanced cluster parameters.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |
#advanced_security_options ⇒ Types::AdvancedSecurityOptionsInput
Options for fine-grained access control.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |
#auto_tune_options ⇒ Types::AutoTuneOptions
Options for Auto-Tune.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |
#cluster_config ⇒ Types::ClusterConfig
Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |
#cognito_options ⇒ Types::CognitoOptions
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |
#domain_endpoint_options ⇒ Types::DomainEndpointOptions
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |
#domain_name ⇒ String
The name of the domain that you're updating.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |
#dry_run ⇒ Boolean
This flag, when set to True, specifies whether the UpdateDomain
request should return the results of a dry run analysis without
actually applying the change. A dry run determines what type of
deployment the update will cause.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |
#dry_run_mode ⇒ String
The type of dry run to perform.
Basic
only returns the type of deployment (blue/green or dynamic) that the update will cause.Verbose
runs an additional check to validate the changes you're making. For more information, see Validating a domain update.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |
#ebs_options ⇒ Types::EBSOptions
The type and size of the EBS volume to attach to instances in the domain.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |
#encryption_at_rest_options ⇒ Types::EncryptionAtRestOptions
Encryption at rest options for the domain.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |
#ip_address_type ⇒ String
Specify 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 your IP address type is currently set to dual stack, you can't change it.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |
#log_publishing_options ⇒ Hash<String,Types::LogPublishingOption>
Options to publish OpenSearch logs to Amazon CloudWatch Logs.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |
#node_to_node_encryption_options ⇒ Types::NodeToNodeEncryptionOptions
Node-to-node encryption options for the domain.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |
#off_peak_window_options ⇒ Types::OffPeakWindowOptions
Off-peak window options for the domain.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |
#snapshot_options ⇒ Types::SnapshotOptions
Option to set the time, in UTC format, for the daily automated
snapshot. Default value is 0
hours.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |
#software_update_options ⇒ Types::SoftwareUpdateOptions
Service software update options for the domain.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |
#vpc_options ⇒ Types::VPCOptions
Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 |
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6023 class UpdateDomainConfigRequest < Struct.new( :domain_name, :cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :ip_address_type, :log_publishing_options, :encryption_at_rest_options, :domain_endpoint_options, :node_to_node_encryption_options, :advanced_security_options, :auto_tune_options, :dry_run, :dry_run_mode, :off_peak_window_options, :software_update_options) SENSITIVE = [] include Aws::Structure end |