Class: Aws::ElasticsearchService::Types::UpdateElasticsearchDomainConfigRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ElasticsearchService::Types::UpdateElasticsearchDomainConfigRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-elasticsearchservice/types.rb
Overview
When making an API call, you may pass UpdateElasticsearchDomainConfigRequest data as a hash:
{
domain_name: "DomainName", # required
elasticsearch_cluster_config: {
instance_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, m5.large.elasticsearch, m5.xlarge.elasticsearch, m5.2xlarge.elasticsearch, m5.4xlarge.elasticsearch, m5.12xlarge.elasticsearch, r5.large.elasticsearch, r5.xlarge.elasticsearch, r5.2xlarge.elasticsearch, r5.4xlarge.elasticsearch, r5.12xlarge.elasticsearch, c5.large.elasticsearch, c5.xlarge.elasticsearch, c5.2xlarge.elasticsearch, c5.4xlarge.elasticsearch, c5.9xlarge.elasticsearch, c5.18xlarge.elasticsearch, ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch, i3.large.elasticsearch, i3.xlarge.elasticsearch, i3.2xlarge.elasticsearch, i3.4xlarge.elasticsearch, i3.8xlarge.elasticsearch, i3.16xlarge.elasticsearch
instance_count: 1,
dedicated_master_enabled: false,
zone_awareness_enabled: false,
zone_awareness_config: {
availability_zone_count: 1,
},
dedicated_master_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, m5.large.elasticsearch, m5.xlarge.elasticsearch, m5.2xlarge.elasticsearch, m5.4xlarge.elasticsearch, m5.12xlarge.elasticsearch, r5.large.elasticsearch, r5.xlarge.elasticsearch, r5.2xlarge.elasticsearch, r5.4xlarge.elasticsearch, r5.12xlarge.elasticsearch, c5.large.elasticsearch, c5.xlarge.elasticsearch, c5.2xlarge.elasticsearch, c5.4xlarge.elasticsearch, c5.9xlarge.elasticsearch, c5.18xlarge.elasticsearch, ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch, i3.large.elasticsearch, i3.xlarge.elasticsearch, i3.2xlarge.elasticsearch, i3.4xlarge.elasticsearch, i3.8xlarge.elasticsearch, i3.16xlarge.elasticsearch
dedicated_master_count: 1,
warm_enabled: false,
warm_type: "ultrawarm1.medium.elasticsearch", # accepts ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch
warm_count: 1,
cold_storage_options: {
enabled: false, # required
},
},
ebs_options: {
ebs_enabled: false,
volume_type: "standard", # accepts standard, gp2, io1
volume_size: 1,
iops: 1,
},
snapshot_options: {
automated_snapshot_start_hour: 1,
},
vpc_options: {
subnet_ids: ["String"],
security_group_ids: ["String"],
},
cognito_options: {
enabled: false,
user_pool_id: "UserPoolId",
identity_pool_id: "IdentityPoolId",
role_arn: "RoleArn",
},
advanced_options: {
"String" => "String",
},
access_policies: "PolicyDocument",
log_publishing_options: {
"INDEX_SLOW_LOGS" => {
cloud_watch_logs_log_group_arn: "CloudWatchLogsLogGroupArn",
enabled: false,
},
},
domain_endpoint_options: {
enforce_https: false,
tls_security_policy: "Policy-Min-TLS-1-0-2019-07", # accepts Policy-Min-TLS-1-0-2019-07, Policy-Min-TLS-1-2-2019-07
custom_endpoint_enabled: false,
custom_endpoint: "DomainNameFqdn",
custom_endpoint_certificate_arn: "ARN",
},
advanced_security_options: {
enabled: false,
internal_user_database_enabled: false,
master_user_options: {
master_user_arn: "ARN",
master_user_name: "Username",
master_user_password: "Password",
},
saml_options: {
enabled: false,
idp: {
metadata_content: "SAMLMetadata", # required
entity_id: "SAMLEntityId", # required
},
master_user_name: "Username",
master_backend_role: "BackendRole",
subject_key: "String",
roles_key: "String",
session_timeout_minutes: 1,
},
anonymous_auth_enabled: false,
},
node_to_node_encryption_options: {
enabled: false,
},
encryption_at_rest_options: {
enabled: false,
kms_key_id: "KmsKeyId",
},
auto_tune_options: {
desired_state: "ENABLED", # accepts ENABLED, DISABLED
rollback_on_disable: "NO_ROLLBACK", # accepts NO_ROLLBACK, DEFAULT_ROLLBACK
maintenance_schedules: [
{
start_at: Time.now,
duration: {
value: 1,
unit: "HOURS", # accepts HOURS
},
cron_expression_for_recurrence: "String",
},
],
},
dry_run: false,
}
Container for the parameters to the `UpdateElasticsearchDomain` operation. Specifies the type and number of instances in the domain cluster.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#access_policies ⇒ String
IAM access policy as a JSON-formatted string.
-
#advanced_options ⇒ Hash<String,String>
Modifies the advanced option to allow references to indices in an HTTP request body.
-
#advanced_security_options ⇒ Types::AdvancedSecurityOptionsInput
Specifies advanced security options.
-
#auto_tune_options ⇒ Types::AutoTuneOptions
Specifies Auto-Tune options.
-
#cognito_options ⇒ Types::CognitoOptions
Options to specify the Cognito user and identity pools for Kibana authentication.
-
#domain_endpoint_options ⇒ Types::DomainEndpointOptions
Options to specify configuration that will be applied to the domain endpoint.
-
#domain_name ⇒ String
The name of the Elasticsearch domain that you are updating.
-
#dry_run ⇒ Boolean
This flag, when set to True, specifies whether the `UpdateElasticsearchDomain` request should return the results of validation checks without actually applying the change.
-
#ebs_options ⇒ Types::EBSOptions
Specify the type and size of the EBS volume that you want to use.
-
#elasticsearch_cluster_config ⇒ Types::ElasticsearchClusterConfig
The type and number of instances to instantiate for the domain cluster.
-
#encryption_at_rest_options ⇒ Types::EncryptionAtRestOptions
Specifies the Encryption At Rest Options.
-
#log_publishing_options ⇒ Hash<String,Types::LogPublishingOption>
Map of `LogType` and `LogPublishingOption`, each containing options to publish a given type of Elasticsearch log.
-
#node_to_node_encryption_options ⇒ Types::NodeToNodeEncryptionOptions
Specifies the NodeToNodeEncryptionOptions.
-
#snapshot_options ⇒ Types::SnapshotOptions
Option to set the time, in UTC format, for the daily automated snapshot.
-
#vpc_options ⇒ Types::VPCOptions
Options to specify the subnets and security groups for VPC endpoint.
Instance Attribute Details
#access_policies ⇒ String
IAM access policy as a JSON-formatted string.
4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 |
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 4543 class UpdateElasticsearchDomainConfigRequest < Struct.new( :domain_name, :elasticsearch_cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :log_publishing_options, :domain_endpoint_options, :advanced_security_options, :node_to_node_encryption_options, :encryption_at_rest_options, :auto_tune_options, :dry_run) SENSITIVE = [] include Aws::Structure end |
#advanced_options ⇒ Hash<String,String>
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][1
-
for more information.
4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 |
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 4543 class UpdateElasticsearchDomainConfigRequest < Struct.new( :domain_name, :elasticsearch_cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :log_publishing_options, :domain_endpoint_options, :advanced_security_options, :node_to_node_encryption_options, :encryption_at_rest_options, :auto_tune_options, :dry_run) SENSITIVE = [] include Aws::Structure end |
#advanced_security_options ⇒ Types::AdvancedSecurityOptionsInput
Specifies advanced security options.
4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 |
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 4543 class UpdateElasticsearchDomainConfigRequest < Struct.new( :domain_name, :elasticsearch_cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :log_publishing_options, :domain_endpoint_options, :advanced_security_options, :node_to_node_encryption_options, :encryption_at_rest_options, :auto_tune_options, :dry_run) SENSITIVE = [] include Aws::Structure end |
#auto_tune_options ⇒ Types::AutoTuneOptions
Specifies Auto-Tune options.
4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 |
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 4543 class UpdateElasticsearchDomainConfigRequest < Struct.new( :domain_name, :elasticsearch_cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :log_publishing_options, :domain_endpoint_options, :advanced_security_options, :node_to_node_encryption_options, :encryption_at_rest_options, :auto_tune_options, :dry_run) SENSITIVE = [] include Aws::Structure end |
#cognito_options ⇒ Types::CognitoOptions
Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see [Amazon Cognito Authentication for Kibana].
[1]: docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html
4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 |
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 4543 class UpdateElasticsearchDomainConfigRequest < Struct.new( :domain_name, :elasticsearch_cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :log_publishing_options, :domain_endpoint_options, :advanced_security_options, :node_to_node_encryption_options, :encryption_at_rest_options, :auto_tune_options, :dry_run) SENSITIVE = [] include Aws::Structure end |
#domain_endpoint_options ⇒ Types::DomainEndpointOptions
Options to specify configuration that will be applied to the domain endpoint.
4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 |
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 4543 class UpdateElasticsearchDomainConfigRequest < Struct.new( :domain_name, :elasticsearch_cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :log_publishing_options, :domain_endpoint_options, :advanced_security_options, :node_to_node_encryption_options, :encryption_at_rest_options, :auto_tune_options, :dry_run) SENSITIVE = [] include Aws::Structure end |
#domain_name ⇒ String
The name of the Elasticsearch domain that you are updating.
4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 |
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 4543 class UpdateElasticsearchDomainConfigRequest < Struct.new( :domain_name, :elasticsearch_cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :log_publishing_options, :domain_endpoint_options, :advanced_security_options, :node_to_node_encryption_options, :encryption_at_rest_options, :auto_tune_options, :dry_run) SENSITIVE = [] include Aws::Structure end |
#dry_run ⇒ Boolean
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.
4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 |
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 4543 class UpdateElasticsearchDomainConfigRequest < Struct.new( :domain_name, :elasticsearch_cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :log_publishing_options, :domain_endpoint_options, :advanced_security_options, :node_to_node_encryption_options, :encryption_at_rest_options, :auto_tune_options, :dry_run) SENSITIVE = [] include Aws::Structure end |
#ebs_options ⇒ Types::EBSOptions
Specify the type and size of the EBS volume that you want to use.
4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 |
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 4543 class UpdateElasticsearchDomainConfigRequest < Struct.new( :domain_name, :elasticsearch_cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :log_publishing_options, :domain_endpoint_options, :advanced_security_options, :node_to_node_encryption_options, :encryption_at_rest_options, :auto_tune_options, :dry_run) SENSITIVE = [] include Aws::Structure end |
#elasticsearch_cluster_config ⇒ Types::ElasticsearchClusterConfig
The type and number of instances to instantiate for the domain cluster.
4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 |
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 4543 class UpdateElasticsearchDomainConfigRequest < Struct.new( :domain_name, :elasticsearch_cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :log_publishing_options, :domain_endpoint_options, :advanced_security_options, :node_to_node_encryption_options, :encryption_at_rest_options, :auto_tune_options, :dry_run) SENSITIVE = [] include Aws::Structure end |
#encryption_at_rest_options ⇒ Types::EncryptionAtRestOptions
Specifies the Encryption At Rest Options.
4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 |
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 4543 class UpdateElasticsearchDomainConfigRequest < Struct.new( :domain_name, :elasticsearch_cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :log_publishing_options, :domain_endpoint_options, :advanced_security_options, :node_to_node_encryption_options, :encryption_at_rest_options, :auto_tune_options, :dry_run) SENSITIVE = [] include Aws::Structure end |
#log_publishing_options ⇒ Hash<String,Types::LogPublishingOption>
Map of `LogType` and `LogPublishingOption`, each containing options to publish a given type of Elasticsearch log.
4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 |
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 4543 class UpdateElasticsearchDomainConfigRequest < Struct.new( :domain_name, :elasticsearch_cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :log_publishing_options, :domain_endpoint_options, :advanced_security_options, :node_to_node_encryption_options, :encryption_at_rest_options, :auto_tune_options, :dry_run) SENSITIVE = [] include Aws::Structure end |
#node_to_node_encryption_options ⇒ Types::NodeToNodeEncryptionOptions
Specifies the NodeToNodeEncryptionOptions.
4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 |
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 4543 class UpdateElasticsearchDomainConfigRequest < Struct.new( :domain_name, :elasticsearch_cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :log_publishing_options, :domain_endpoint_options, :advanced_security_options, :node_to_node_encryption_options, :encryption_at_rest_options, :auto_tune_options, :dry_run) 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.
4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 |
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 4543 class UpdateElasticsearchDomainConfigRequest < Struct.new( :domain_name, :elasticsearch_cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :log_publishing_options, :domain_endpoint_options, :advanced_security_options, :node_to_node_encryption_options, :encryption_at_rest_options, :auto_tune_options, :dry_run) SENSITIVE = [] include Aws::Structure end |
#vpc_options ⇒ Types::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*
[1]: docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc
4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 |
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 4543 class UpdateElasticsearchDomainConfigRequest < Struct.new( :domain_name, :elasticsearch_cluster_config, :ebs_options, :snapshot_options, :vpc_options, :cognito_options, :advanced_options, :access_policies, :log_publishing_options, :domain_endpoint_options, :advanced_security_options, :node_to_node_encryption_options, :encryption_at_rest_options, :auto_tune_options, :dry_run) SENSITIVE = [] include Aws::Structure end |