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

Class: Aws::ElasticsearchService::Types::CreateElasticsearchDomainRequest

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 CreateElasticsearchDomainRequest data as a hash:

{
  domain_name: "DomainName", # required
  elasticsearch_version: "ElasticsearchVersionString",
  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,
  },
  access_policies: "PolicyDocument",
  snapshot_options: {
    automated_snapshot_start_hour: 1,
  },
  vpc_options: {
    subnet_ids: ["String"],
    security_group_ids: ["String"],
  },
  encryption_at_rest_options: {
    enabled: false,
    kms_key_id: "KmsKeyId",
  },
  advanced_options: {
    "String" => "String",
  },
  log_publishing_options: {
    "INDEX_SLOW_LOGS" => {
      cloud_watch_logs_log_group_arn: "CloudWatchLogsLogGroupArn",
      enabled: false,
    },
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#access_policiesString

IAM access policy as a JSON-formatted string.

Returns:

  • (String)


231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 231

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

#advanced_optionsHash<String,String>

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


231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 231

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

#domain_nameString

The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Returns:

  • (String)


231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 231

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

#ebs_optionsTypes::EBSOptions

Options to enable, disable and specify the type and size of EBS storage volumes.

Returns:



231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 231

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

#elasticsearch_cluster_configTypes::ElasticsearchClusterConfig

Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.



231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 231

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

#elasticsearch_versionString

String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

Returns:

  • (String)


231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 231

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

#encryption_at_rest_optionsTypes::EncryptionAtRestOptions

Specifies the Encryption At Rest Options.



231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 231

class CreateElasticsearchDomainRequest < Struct.new(
  :domain_name,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :vpc_options,
  :encryption_at_rest_options,
  :advanced_options,
  :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:



231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 231

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

#snapshot_optionsTypes::SnapshotOptions

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



231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 231

class CreateElasticsearchDomainRequest < Struct.new(
  :domain_name,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :vpc_options,
  :encryption_at_rest_options,
  :advanced_options,
  :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:



231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 231

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