Update Elasticsearch Domain Config
elasticsearchservice_update_elasticsearch_domain_config | R Documentation |
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances¶
Description¶
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
Usage¶
elasticsearchservice_update_elasticsearch_domain_config(DomainName,
ElasticsearchClusterConfig, EBSOptions, SnapshotOptions, VPCOptions,
CognitoOptions, AdvancedOptions, AccessPolicies, LogPublishingOptions,
DomainEndpointOptions, AdvancedSecurityOptions,
NodeToNodeEncryptionOptions, EncryptionAtRestOptions, AutoTuneOptions,
DryRun)
Arguments¶
DomainName
[required] The name of the Elasticsearch domain that you are updating.
ElasticsearchClusterConfig
The type and number of instances to instantiate for the domain cluster.
EBSOptions
Specify the type and size of the EBS volume that you want to use.
SnapshotOptions
Option to set the time, in UTC format, for 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.
AdvancedOptions
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 istrue
. See Configuration Advanced Options for more information.AccessPolicies
IAM access policy as a JSON-formatted string.
LogPublishingOptions
Map of
LogType
andLogPublishingOption
, each containing options to publish a given type of Elasticsearch log.DomainEndpointOptions
Options to specify configuration that will be applied to the domain endpoint.
AdvancedSecurityOptions
Specifies advanced security options.
NodeToNodeEncryptionOptions
Specifies the NodeToNodeEncryptionOptions.
EncryptionAtRestOptions
Specifies the Encryption At Rest Options.
AutoTuneOptions
Specifies Auto-Tune options.
DryRun
This flag, when set to True, specifies whether the
UpdateElasticsearchDomain
request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update.
Value¶
A list with the following syntax:
list(
DomainConfig = list(
ElasticsearchVersion = list(
Options = "string",
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
),
ElasticsearchClusterConfig = list(
Options = 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
)
),
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
),
EBSOptions = list(
Options = list(
EBSEnabled = TRUE|FALSE,
VolumeType = "standard"|"gp2"|"io1"|"gp3",
VolumeSize = 123,
Iops = 123,
Throughput = 123
),
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
),
AccessPolicies = list(
Options = "string",
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
),
SnapshotOptions = list(
Options = list(
AutomatedSnapshotStartHour = 123
),
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
),
VPCOptions = list(
Options = list(
VPCId = "string",
SubnetIds = list(
"string"
),
AvailabilityZones = list(
"string"
),
SecurityGroupIds = list(
"string"
)
),
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
),
CognitoOptions = list(
Options = list(
Enabled = TRUE|FALSE,
UserPoolId = "string",
IdentityPoolId = "string",
RoleArn = "string"
),
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
),
EncryptionAtRestOptions = list(
Options = list(
Enabled = TRUE|FALSE,
KmsKeyId = "string"
),
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
),
NodeToNodeEncryptionOptions = list(
Options = list(
Enabled = TRUE|FALSE
),
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
),
AdvancedOptions = list(
Options = list(
"string"
),
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
),
LogPublishingOptions = list(
Options = list(
list(
CloudWatchLogsLogGroupArn = "string",
Enabled = TRUE|FALSE
)
),
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
),
DomainEndpointOptions = list(
Options = 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"
),
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
),
AdvancedSecurityOptions = list(
Options = 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
),
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
),
AutoTuneOptions = list(
Options = list(
DesiredState = "ENABLED"|"DISABLED",
RollbackOnDisable = "NO_ROLLBACK"|"DEFAULT_ROLLBACK",
MaintenanceSchedules = list(
list(
StartAt = as.POSIXct(
"2015-01-01"
),
Duration = list(
Value = 123,
Unit = "HOURS"
),
CronExpressionForRecurrence = "string"
)
)
),
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
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",
PendingDeletion = TRUE|FALSE
)
),
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"
),
ModifyingProperties = list(
list(
Name = "string",
ActiveValue = "string",
PendingValue = "string",
ValueType = "PLAIN_TEXT"|"STRINGIFIED_JSON"
)
)
),
DryRunResults = list(
DeploymentType = "string",
Message = "string"
)
)
Request syntax¶
svc$update_elasticsearch_domain_config(
DomainName = "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
),
SnapshotOptions = list(
AutomatedSnapshotStartHour = 123
),
VPCOptions = list(
SubnetIds = list(
"string"
),
SecurityGroupIds = list(
"string"
)
),
CognitoOptions = list(
Enabled = TRUE|FALSE,
UserPoolId = "string",
IdentityPoolId = "string",
RoleArn = "string"
),
AdvancedOptions = list(
"string"
),
AccessPolicies = "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
),
NodeToNodeEncryptionOptions = list(
Enabled = TRUE|FALSE
),
EncryptionAtRestOptions = list(
Enabled = TRUE|FALSE,
KmsKeyId = "string"
),
AutoTuneOptions = list(
DesiredState = "ENABLED"|"DISABLED",
RollbackOnDisable = "NO_ROLLBACK"|"DEFAULT_ROLLBACK",
MaintenanceSchedules = list(
list(
StartAt = as.POSIXct(
"2015-01-01"
),
Duration = list(
Value = 123,
Unit = "HOURS"
),
CronExpressionForRecurrence = "string"
)
)
),
DryRun = TRUE|FALSE
)