You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElasticsearchService::Types::UpdateElasticsearchDomainConfigRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb

Overview

Note:

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, 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,
    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, 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,
  },
  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"],
  },
  advanced_options: {
    "String" => "String",
  },
  access_policies: "PolicyDocument",
  log_publishing_options: {
    "INDEX_SLOW_LOGS" => {
      cloud_watch_logs_log_group_arn: "CloudWatchLogsLogGroupArn",
      enabled: false,
    },
  },
}

Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the type and number of instances in the domain cluster.

Instance Attribute Summary collapse

Instance Attribute Details

#access_policiesString

IAM access policy as a JSON-formatted string.

Returns:

  • (String)


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 1301

class UpdateElasticsearchDomainConfigRequest < Struct.new(
  :domain_name,
  :elasticsearch_cluster_config,
  :ebs_options,
  :snapshot_options,
  :vpc_options,
  :advanced_options,
  :access_policies,
  :log_publishing_options)
  include Aws::Structure
end

#advanced_optionsHash<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 for more information.

Returns:

  • (Hash<String,String>)


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 1301

class UpdateElasticsearchDomainConfigRequest < Struct.new(
  :domain_name,
  :elasticsearch_cluster_config,
  :ebs_options,
  :snapshot_options,
  :vpc_options,
  :advanced_options,
  :access_policies,
  :log_publishing_options)
  include Aws::Structure
end

#domain_nameString

The name of the Elasticsearch domain that you are updating.

Returns:

  • (String)


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 1301

class UpdateElasticsearchDomainConfigRequest < Struct.new(
  :domain_name,
  :elasticsearch_cluster_config,
  :ebs_options,
  :snapshot_options,
  :vpc_options,
  :advanced_options,
  :access_policies,
  :log_publishing_options)
  include Aws::Structure
end

#ebs_optionsTypes::EBSOptions

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

Returns:



1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 1301

class UpdateElasticsearchDomainConfigRequest < Struct.new(
  :domain_name,
  :elasticsearch_cluster_config,
  :ebs_options,
  :snapshot_options,
  :vpc_options,
  :advanced_options,
  :access_policies,
  :log_publishing_options)
  include Aws::Structure
end

#elasticsearch_cluster_configTypes::ElasticsearchClusterConfig

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



1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 1301

class UpdateElasticsearchDomainConfigRequest < Struct.new(
  :domain_name,
  :elasticsearch_cluster_config,
  :ebs_options,
  :snapshot_options,
  :vpc_options,
  :advanced_options,
  :access_policies,
  :log_publishing_options)
  include Aws::Structure
end

#log_publishing_optionsHash<String,Types::LogPublishingOption>

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

Returns:



1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 1301

class UpdateElasticsearchDomainConfigRequest < Struct.new(
  :domain_name,
  :elasticsearch_cluster_config,
  :ebs_options,
  :snapshot_options,
  :vpc_options,
  :advanced_options,
  :access_policies,
  :log_publishing_options)
  include Aws::Structure
end

#snapshot_optionsTypes::SnapshotOptions

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



1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 1301

class UpdateElasticsearchDomainConfigRequest < Struct.new(
  :domain_name,
  :elasticsearch_cluster_config,
  :ebs_options,
  :snapshot_options,
  :vpc_options,
  :advanced_options,
  :access_policies,
  :log_publishing_options)
  include Aws::Structure
end

#vpc_optionsTypes::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

Returns:



1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 1301

class UpdateElasticsearchDomainConfigRequest < Struct.new(
  :domain_name,
  :elasticsearch_cluster_config,
  :ebs_options,
  :snapshot_options,
  :vpc_options,
  :advanced_options,
  :access_policies,
  :log_publishing_options)
  include Aws::Structure
end