Create Elasticsearch Domain
elasticsearchservice_create_elasticsearch_domain | R Documentation |
Creates a new Elasticsearch domain¶
Description¶
Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
Usage¶
elasticsearchservice_create_elasticsearch_domain(DomainName,
ElasticsearchVersion, ElasticsearchClusterConfig, EBSOptions,
AccessPolicies, SnapshotOptions, VPCOptions, CognitoOptions,
EncryptionAtRestOptions, NodeToNodeEncryptionOptions, AdvancedOptions,
LogPublishingOptions, DomainEndpointOptions, AdvancedSecurityOptions,
AutoTuneOptions, TagList)
Arguments¶
DomainName |
[required] 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). |
ElasticsearchVersion |
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. |
ElasticsearchClusterConfig |
Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster. |
EBSOptions |
Options to enable, disable and specify the type and size of EBS storage volumes. |
AccessPolicies |
IAM access policy as a JSON-formatted string. |
SnapshotOptions |
Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours. |
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 |
CognitoOptions |
Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana. |
EncryptionAtRestOptions |
Specifies the Encryption At Rest Options. |
NodeToNodeEncryptionOptions |
Specifies the NodeToNodeEncryptionOptions. |
AdvancedOptions |
Option to allow references to indices in an HTTP request body.
Must be |
LogPublishingOptions |
Map of |
DomainEndpointOptions |
Options to specify configuration that will be applied to the domain endpoint. |
AdvancedSecurityOptions |
Specifies advanced security options. |
AutoTuneOptions |
Specifies Auto-Tune options. |
TagList |
A list of |
Value¶
A list with the following syntax:
list(
DomainStatus = list(
DomainId = "string",
DomainName = "string",
ARN = "string",
Created = TRUE|FALSE,
Deleted = TRUE|FALSE,
Endpoint = "string",
Endpoints = list(
"string"
),
Processing = TRUE|FALSE,
UpgradeProcessing = TRUE|FALSE,
ElasticsearchVersion = "string",
ElasticsearchClusterConfig = list(
InstanceType = "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",
InstanceCount = 123,
DedicatedMasterEnabled = TRUE|FALSE,
ZoneAwarenessEnabled = TRUE|FALSE,
ZoneAwarenessConfig = list(
AvailabilityZoneCount = 123
),
DedicatedMasterType = "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",
DedicatedMasterCount = 123,
WarmEnabled = TRUE|FALSE,
WarmType = "ultrawarm1.medium.elasticsearch"|"ultrawarm1.large.elasticsearch",
WarmCount = 123,
ColdStorageOptions = list(
Enabled = TRUE|FALSE
)
),
EBSOptions = list(
EBSEnabled = TRUE|FALSE,
VolumeType = "standard"|"gp2"|"io1"|"gp3",
VolumeSize = 123,
Iops = 123,
Throughput = 123
),
AccessPolicies = "string",
SnapshotOptions = list(
AutomatedSnapshotStartHour = 123
),
VPCOptions = list(
VPCId = "string",
SubnetIds = list(
"string"
),
AvailabilityZones = list(
"string"
),
SecurityGroupIds = list(
"string"
)
),
CognitoOptions = list(
Enabled = TRUE|FALSE,
UserPoolId = "string",
IdentityPoolId = "string",
RoleArn = "string"
),
EncryptionAtRestOptions = list(
Enabled = TRUE|FALSE,
KmsKeyId = "string"
),
NodeToNodeEncryptionOptions = list(
Enabled = TRUE|FALSE
),
AdvancedOptions = list(
"string"
),
LogPublishingOptions = list(
list(
CloudWatchLogsLogGroupArn = "string",
Enabled = TRUE|FALSE
)
),
ServiceSoftwareOptions = list(
CurrentVersion = "string",
NewVersion = "string",
UpdateAvailable = TRUE|FALSE,
Cancellable = TRUE|FALSE,
UpdateStatus = "PENDING_UPDATE"|"IN_PROGRESS"|"COMPLETED"|"NOT_ELIGIBLE"|"ELIGIBLE",
Description = "string",
AutomatedUpdateDate = as.POSIXct(
"2015-01-01"
),
OptionalDeployment = TRUE|FALSE
),
DomainEndpointOptions = list(
EnforceHTTPS = TRUE|FALSE,
TLSSecurityPolicy = "Policy-Min-TLS-1-0-2019-07"|"Policy-Min-TLS-1-2-2019-07"|"Policy-Min-TLS-1-2-PFS-2023-10",
CustomEndpointEnabled = TRUE|FALSE,
CustomEndpoint = "string",
CustomEndpointCertificateArn = "string"
),
AdvancedSecurityOptions = list(
Enabled = TRUE|FALSE,
InternalUserDatabaseEnabled = TRUE|FALSE,
SAMLOptions = list(
Enabled = TRUE|FALSE,
Idp = list(
MetadataContent = "string",
EntityId = "string"
),
SubjectKey = "string",
RolesKey = "string",
SessionTimeoutMinutes = 123
),
AnonymousAuthDisableDate = as.POSIXct(
"2015-01-01"
),
AnonymousAuthEnabled = TRUE|FALSE
),
AutoTuneOptions = list(
State = "ENABLED"|"DISABLED"|"ENABLE_IN_PROGRESS"|"DISABLE_IN_PROGRESS"|"DISABLED_AND_ROLLBACK_SCHEDULED"|"DISABLED_AND_ROLLBACK_IN_PROGRESS"|"DISABLED_AND_ROLLBACK_COMPLETE"|"DISABLED_AND_ROLLBACK_ERROR"|"ERROR",
ErrorMessage = "string"
),
ChangeProgressDetails = list(
ChangeId = "string",
Message = "string",
ConfigChangeStatus = "Pending"|"Initializing"|"Validating"|"ValidationFailed"|"ApplyingChanges"|"Completed"|"PendingUserInput"|"Cancelled",
StartTime = as.POSIXct(
"2015-01-01"
),
LastUpdatedTime = as.POSIXct(
"2015-01-01"
),
InitiatedBy = "CUSTOMER"|"SERVICE"
),
DomainProcessingStatus = "Creating"|"Active"|"Modifying"|"UpgradingEngineVersion"|"UpdatingServiceSoftware"|"Isolated"|"Deleting",
ModifyingProperties = list(
list(
Name = "string",
ActiveValue = "string",
PendingValue = "string",
ValueType = "PLAIN_TEXT"|"STRINGIFIED_JSON"
)
)
)
)
Request syntax¶
svc$create_elasticsearch_domain(
DomainName = "string",
ElasticsearchVersion = "string",
ElasticsearchClusterConfig = list(
InstanceType = "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",
InstanceCount = 123,
DedicatedMasterEnabled = TRUE|FALSE,
ZoneAwarenessEnabled = TRUE|FALSE,
ZoneAwarenessConfig = list(
AvailabilityZoneCount = 123
),
DedicatedMasterType = "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",
DedicatedMasterCount = 123,
WarmEnabled = TRUE|FALSE,
WarmType = "ultrawarm1.medium.elasticsearch"|"ultrawarm1.large.elasticsearch",
WarmCount = 123,
ColdStorageOptions = list(
Enabled = TRUE|FALSE
)
),
EBSOptions = list(
EBSEnabled = TRUE|FALSE,
VolumeType = "standard"|"gp2"|"io1"|"gp3",
VolumeSize = 123,
Iops = 123,
Throughput = 123
),
AccessPolicies = "string",
SnapshotOptions = list(
AutomatedSnapshotStartHour = 123
),
VPCOptions = list(
SubnetIds = list(
"string"
),
SecurityGroupIds = list(
"string"
)
),
CognitoOptions = list(
Enabled = TRUE|FALSE,
UserPoolId = "string",
IdentityPoolId = "string",
RoleArn = "string"
),
EncryptionAtRestOptions = list(
Enabled = TRUE|FALSE,
KmsKeyId = "string"
),
NodeToNodeEncryptionOptions = list(
Enabled = TRUE|FALSE
),
AdvancedOptions = list(
"string"
),
LogPublishingOptions = list(
list(
CloudWatchLogsLogGroupArn = "string",
Enabled = TRUE|FALSE
)
),
DomainEndpointOptions = list(
EnforceHTTPS = TRUE|FALSE,
TLSSecurityPolicy = "Policy-Min-TLS-1-0-2019-07"|"Policy-Min-TLS-1-2-2019-07"|"Policy-Min-TLS-1-2-PFS-2023-10",
CustomEndpointEnabled = TRUE|FALSE,
CustomEndpoint = "string",
CustomEndpointCertificateArn = "string"
),
AdvancedSecurityOptions = list(
Enabled = TRUE|FALSE,
InternalUserDatabaseEnabled = TRUE|FALSE,
MasterUserOptions = list(
MasterUserARN = "string",
MasterUserName = "string",
MasterUserPassword = "string"
),
SAMLOptions = list(
Enabled = TRUE|FALSE,
Idp = list(
MetadataContent = "string",
EntityId = "string"
),
MasterUserName = "string",
MasterBackendRole = "string",
SubjectKey = "string",
RolesKey = "string",
SessionTimeoutMinutes = 123
),
AnonymousAuthEnabled = TRUE|FALSE
),
AutoTuneOptions = list(
DesiredState = "ENABLED"|"DISABLED",
MaintenanceSchedules = list(
list(
StartAt = as.POSIXct(
"2015-01-01"
),
Duration = list(
Value = 123,
Unit = "HOURS"
),
CronExpressionForRecurrence = "string"
)
)
),
TagList = list(
list(
Key = "string",
Value = "string"
)
)
)