Class: Aws::OpenSearchService::Types::UpdateDomainConfigRequest

Inherits:

Struct

Object
Struct
Aws::OpenSearchService::Types::UpdateDomainConfigRequest

show all

Includes:: Structure

Defined in:: 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.
#aiml_options ⇒ Types::AIMLOptionsInput

Options for all machine learning features for the specified domain.
#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.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_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 a `TooManyClauses` error.

For more information, see [Advanced cluster parameters].

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#advanced_security_options ⇒ `Types::AdvancedSecurityOptionsInput`

Options for fine-grained access control.

Returns:

(Types::AdvancedSecurityOptionsInput)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#aiml_options ⇒ `Types::AIMLOptionsInput`

Options for all machine learning features for the specified domain.

Returns:

(Types::AIMLOptionsInput)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#auto_tune_options ⇒ `Types::AutoTuneOptions`

Options for Auto-Tune.

Returns:

(Types::AutoTuneOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_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.

Returns:

(Types::ClusterConfig)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#cognito_options ⇒ `Types::CognitoOptions`

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

Returns:

(Types::CognitoOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_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.

Returns:

(Types::DomainEndpointOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ `String`

The name of the domain that you’re updating.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_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.

Returns:

(Boolean)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_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].

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#validation-check

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_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.

Returns:

(Types::EBSOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_at_rest_options ⇒ `Types::EncryptionAtRestOptions`

Encryption at rest options for the domain.

Returns:

(Types::EncryptionAtRestOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_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.

Returns:

(String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#log_publishing_options ⇒ `Hash<String,Types::LogPublishingOption>`

Options to publish OpenSearch logs to Amazon CloudWatch Logs.

Returns:

(Hash<String,Types::LogPublishingOption>)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#node_to_node_encryption_options ⇒ `Types::NodeToNodeEncryptionOptions`

Node-to-node encryption options for the domain.

Returns:

(Types::NodeToNodeEncryptionOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#off_peak_window_options ⇒ `Types::OffPeakWindowOptions`

Off-peak window options for the domain.

Returns:

(Types::OffPeakWindowOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_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.

Returns:

(Types::SnapshotOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#software_update_options ⇒ `Types::SoftwareUpdateOptions`

Service software update options for the domain.

Returns:

(Types::SoftwareUpdateOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_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].

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html

Returns:

(Types::VPCOptions)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6230

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,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::OpenSearchService::Types::UpdateDomainConfigRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#access_policies ⇒ String

#advanced_options ⇒ Hash<String,String>

#advanced_security_options ⇒ Types::AdvancedSecurityOptionsInput

#aiml_options ⇒ Types::AIMLOptionsInput

#auto_tune_options ⇒ Types::AutoTuneOptions

#cluster_config ⇒ Types::ClusterConfig

#cognito_options ⇒ Types::CognitoOptions

#domain_endpoint_options ⇒ Types::DomainEndpointOptions

#domain_name ⇒ String

#dry_run ⇒ Boolean

#dry_run_mode ⇒ String

#ebs_options ⇒ Types::EBSOptions

#encryption_at_rest_options ⇒ Types::EncryptionAtRestOptions

#ip_address_type ⇒ String

#log_publishing_options ⇒ Hash<String,Types::LogPublishingOption>

#node_to_node_encryption_options ⇒ Types::NodeToNodeEncryptionOptions

#off_peak_window_options ⇒ Types::OffPeakWindowOptions

#snapshot_options ⇒ Types::SnapshotOptions

#software_update_options ⇒ Types::SoftwareUpdateOptions

#vpc_options ⇒ Types::VPCOptions

#access_policies ⇒ `String`

#advanced_options ⇒ `Hash<String,String>`

#advanced_security_options ⇒ `Types::AdvancedSecurityOptionsInput`

#aiml_options ⇒ `Types::AIMLOptionsInput`

#auto_tune_options ⇒ `Types::AutoTuneOptions`

#cluster_config ⇒ `Types::ClusterConfig`

#cognito_options ⇒ `Types::CognitoOptions`

#domain_endpoint_options ⇒ `Types::DomainEndpointOptions`

#domain_name ⇒ `String`

#dry_run ⇒ `Boolean`

#dry_run_mode ⇒ `String`

#ebs_options ⇒ `Types::EBSOptions`

#encryption_at_rest_options ⇒ `Types::EncryptionAtRestOptions`

#ip_address_type ⇒ `String`

#log_publishing_options ⇒ `Hash<String,Types::LogPublishingOption>`

#node_to_node_encryption_options ⇒ `Types::NodeToNodeEncryptionOptions`

#off_peak_window_options ⇒ `Types::OffPeakWindowOptions`

#snapshot_options ⇒ `Types::SnapshotOptions`

#software_update_options ⇒ `Types::SoftwareUpdateOptions`

#vpc_options ⇒ `Types::VPCOptions`