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

Inherits:

Struct

• Object
• Struct
• Aws::ElasticsearchService::Types::CreateElasticsearchDomainRequest

Includes:

Structure

Defined in:

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, 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,
  },
  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"],
  },
  cognito_options: {
    enabled: false,
    user_pool_id: "UserPoolId",
    identity_pool_id: "IdentityPoolId",
    role_arn: "RoleArn",
  },
  encryption_at_rest_options: {
    enabled: false,
    kms_key_id: "KmsKeyId",
  },
  node_to_node_encryption_options: {
    enabled: false,
  },
  advanced_options: {
    "String" => "String",
  },
  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
  },
  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",
    },
  },
}

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #access_policies ⇒ String

  IAM access policy as a JSON-formatted string.

• #advanced_options ⇒ Hash<String,String>

  Option to allow references to indices in an HTTP request body.

• #advanced_security_options ⇒ Types::AdvancedSecurityOptionsInput

  Specifies advanced security 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 creating.

• #ebs_options ⇒ Types::EBSOptions

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

• #elasticsearch_cluster_config ⇒ Types::ElasticsearchClusterConfig

  Configuration options for an Elasticsearch domain.

• #elasticsearch_version ⇒ String

  String of format X.Y to specify version for the Elasticsearch domain eg.

• #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 time, in UTC format, of 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.

Returns:

• (String)

# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 576

class CreateElasticsearchDomainRequest < Struct.new(
  :domain_name,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :domain_endpoint_options,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#advanced_options ⇒ Hash<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.

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 576

class CreateElasticsearchDomainRequest < Struct.new(
  :domain_name,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :domain_endpoint_options,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#advanced_security_options ⇒ Types::AdvancedSecurityOptionsInput

Specifies advanced security options.

Returns:

• (Types::AdvancedSecurityOptionsInput)

# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 576

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

Returns:

• (Types::CognitoOptions)

# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 576

class CreateElasticsearchDomainRequest < Struct.new(
  :domain_name,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :domain_endpoint_options,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#domain_endpoint_options ⇒ Types::DomainEndpointOptions

Options to specify configuration that will be applied to the domain endpoint.

Returns:

• (Types::DomainEndpointOptions)

# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 576

class CreateElasticsearchDomainRequest < Struct.new(
  :domain_name,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :domain_endpoint_options,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

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 lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Returns:

• (String)

# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 576

class CreateElasticsearchDomainRequest < Struct.new(
  :domain_name,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :domain_endpoint_options,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#ebs_options ⇒ Types::EBSOptions

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

Returns:

• (Types::EBSOptions)

# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 576

class CreateElasticsearchDomainRequest < Struct.new(
  :domain_name,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :domain_endpoint_options,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#elasticsearch_cluster_config ⇒ Types::ElasticsearchClusterConfig

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

Returns:

• (Types::ElasticsearchClusterConfig)

# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 576

class CreateElasticsearchDomainRequest < Struct.new(
  :domain_name,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :domain_endpoint_options,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#elasticsearch_version ⇒ String

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

[1]: docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains

Returns:

• (String)

# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 576

class CreateElasticsearchDomainRequest < Struct.new(
  :domain_name,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :domain_endpoint_options,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_at_rest_options ⇒ Types::EncryptionAtRestOptions

Specifies the Encryption At Rest Options.

Returns:

• (Types::EncryptionAtRestOptions)

# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 576

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

Returns:

• (Hash<String,Types::LogPublishingOption>)

# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 576

class CreateElasticsearchDomainRequest < Struct.new(
  :domain_name,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :domain_endpoint_options,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#node_to_node_encryption_options ⇒ Types::NodeToNodeEncryptionOptions

Specifies the NodeToNodeEncryptionOptions.

Returns:

• (Types::NodeToNodeEncryptionOptions)

# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 576

class CreateElasticsearchDomainRequest < Struct.new(
  :domain_name,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :domain_endpoint_options,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_options ⇒ Types::SnapshotOptions

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

Returns:

• (Types::SnapshotOptions)

# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 576

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

Returns:

• (Types::VPCOptions)

# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 576

class CreateElasticsearchDomainRequest < Struct.new(
  :domain_name,
  :elasticsearch_version,
  :elasticsearch_cluster_config,
  :ebs_options,
  :access_policies,
  :snapshot_options,
  :vpc_options,
  :cognito_options,
  :encryption_at_rest_options,
  :node_to_node_encryption_options,
  :advanced_options,
  :log_publishing_options,
  :domain_endpoint_options,
  :advanced_security_options)
  SENSITIVE = []
  include Aws::Structure
end