Class: Aws::OpenSearchService::Types::CreateDomainRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_policies ⇒ String

Identity and Access Management (IAM) policy document specifying the access policies for the new domain.

Returns:

  • (String) 


1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_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.

  • ‘“override_main_response_version”: “true” | “false”` - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

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


1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#advanced_security_options ⇒ Types::AdvancedSecurityOptionsInput

Options for fine-grained access control.

Returns:



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#aiml_options ⇒ Types::AIMLOptionsInput

Options for all machine learning features for the specified domain.

Returns:



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#auto_tune_options ⇒ Types::AutoTuneOptionsInput

Options for Auto-Tune.

Returns:



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_config ⇒ Types::ClusterConfig

Container for the cluster configuration of a domain.

Returns:



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#cognito_options ⇒ Types::CognitoOptions

Key-value pairs to configure Amazon Cognito authentication. For more information, see [Configuring Amazon Cognito authentication for OpenSearch Dashboards].

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

Returns:



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_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:



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

Returns:

  • (String) 


1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#ebs_options ⇒ Types::EBSOptions

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

Returns:



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_at_rest_options ⇒ Types::EncryptionAtRestOptions

Key-value pairs to enable encryption at rest.

Returns:



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, ‘OpenSearch_1.0` or `Elasticsearch_7.9`. For more information, see [Creating and managing Amazon OpenSearch Service domains].

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

Returns:

  • (String) 


1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address_type ⇒ String

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can’t change your address type later.

Returns:

  • (String) 


1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#log_publishing_options ⇒ Hash<String,Types::LogPublishingOption>

Key-value pairs to configure log publishing.

Returns:



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#node_to_node_encryption_options ⇒ Types::NodeToNodeEncryptionOptions

Enables node-to-node encryption.

Returns:



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#off_peak_window_options ⇒ Types::OffPeakWindowOptions

Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.

Returns:



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_options ⇒ Types::SnapshotOptions

DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.

Returns:



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#software_update_options ⇒ Types::SoftwareUpdateOptions

Software update options for the domain.

Returns:



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#tag_list ⇒ Array<Types::Tag>

List of tags to add to the domain upon creation.

Returns:



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_options ⇒ Types::VPCOptions

Container for the values required to configure VPC access domains. If you don’t specify these values, OpenSearch Service creates the domain with a public 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:



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1454

class CreateDomainRequest < Struct.new(
  :domain_name,
  :engine_version,
  :cluster_config,
  :ebs_options,
  :access_policies,
  :ip_address_type,
  :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,
  :tag_list,
  :auto_tune_options,
  :off_peak_window_options,
  :software_update_options,
  :aiml_options)
  SENSITIVE = []
  include Aws::Structure
end