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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-opensearchservice/types.rb

Overview

Container for the request parameters to the ‘UpdateDomain` operation.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_policies ⇒ String

Identity and Access Management (IAM) access policy as a JSON-formatted string.

Returns:

  • (String) 


5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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


5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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.

Returns:



5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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.

Returns:



5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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.

Returns:



5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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.

Returns:



5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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.

Returns:



5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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.

Returns:

  • (String) 


5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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.

Returns:

  • (Boolean) 


5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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

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

Returns:

  • (String) 


5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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.

Returns:



5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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.

Returns:



5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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

The type of IP addresses supported by the endpoint for the domain.

Returns:

  • (String) 


5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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.

Returns:



5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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.

Returns:



5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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.

Returns:



5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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.

Returns:



5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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.

Returns:



5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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

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

Returns:



5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 5594

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