Modifies the cluster configuration of the specified Amazon OpenSearch Service domain¶
Description¶
Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
Usage¶
opensearchservice_update_domain_config(DomainName, ClusterConfig,
EBSOptions, SnapshotOptions, VPCOptions, CognitoOptions,
AdvancedOptions, AccessPolicies, IPAddressType, LogPublishingOptions,
EncryptionAtRestOptions, DomainEndpointOptions,
NodeToNodeEncryptionOptions, AdvancedSecurityOptions,
IdentityCenterOptions, AutoTuneOptions, DryRun, DryRunMode,
OffPeakWindowOptions, SoftwareUpdateOptions, AIMLOptions,
DeploymentStrategyOptions, AutomatedSnapshotPauseOptions, UseCase,
EngineMode, AcceptedWarnings)
Arguments¶
-
DomainName[required] The name of the domain that you're updating.
-
ClusterConfigChanges that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
-
EBSOptionsThe type and size of the EBS volume to attach to instances in the domain.
-
SnapshotOptionsOption to set the time, in UTC format, for the daily automated snapshot. Default value is
0hours. -
VPCOptionsOptions to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
-
CognitoOptionsKey-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
-
AdvancedOptionsKey-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 aTooManyClauseserror.
For more information, see Advanced cluster parameters.
-
AccessPoliciesIdentity and Access Management (IAM) access policy as a JSON-formatted string.
-
IPAddressTypeSpecify 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 your IP address type is currently set to dual stack, you can't change it.
-
LogPublishingOptionsOptions to publish OpenSearch logs to Amazon CloudWatch Logs.
-
EncryptionAtRestOptionsEncryption at rest options for the domain.
-
DomainEndpointOptionsAdditional options for the domain endpoint, such as whether to require HTTPS for all traffic.
-
NodeToNodeEncryptionOptionsNode-to-node encryption options for the domain.
-
AdvancedSecurityOptionsOptions for fine-grained access control.
-
IdentityCenterOptionsSettings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources. This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.
-
AutoTuneOptionsOptions for Auto-Tune.
-
DryRunThis flag, when set to True, specifies whether the
UpdateDomainrequest should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause. -
DryRunModeThe type of dry run to perform.
Basiconly returns the type of deployment (blue/green or dynamic) that the update will cause.Verboseruns an additional check to validate the changes you're making. For more information, see Validating a domain update.
-
OffPeakWindowOptionsOff-peak window options for the domain.
-
SoftwareUpdateOptionsService software update options for the domain.
-
AIMLOptionsOptions for all machine learning features for the specified domain.
-
DeploymentStrategyOptionsSpecifies the deployment strategy options for the domain.
-
AutomatedSnapshotPauseOptionsSpecifies the automated snapshot pause options for the domain.
Suspending snapshots reduces data protection. You cannot restore your domain to points in time when snapshots are suspended. Use this feature only for short-term operational needs such as migrations or maintenance windows.
Maximum suspension duration: 3 days.
-
UseCaseThe primary use case for the domain. For valid values, see
DomainUseCase. -
EngineModeThe engine mode for the domain. The engine mode can't be changed after the domain is created. For valid values, see
EngineMode. -
AcceptedWarningsA list of advisory warning codes to accept for this configuration change. By default, any advisory warning blocks the change. Include the code of each warning you want to accept so the change can proceed. You can find warning codes in the
ValidationFailureslist returned bydescribe_domain_change_progressanddescribe_dry_run_progress. Critical validation failures cannot be accepted and always block the change. If you omit this parameter or pass an empty list, all warnings block the change. For more information, see Validating a domain update.
Value¶
A list with the following syntax:
list(
DomainConfig = list(
EngineVersion = 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
)
),
ClusterConfig = list(
Options = list(
InstanceType = "m3.medium.search"|"m3.large.search"|"m3.xlarge.search"|"m3.2xlarge.search"|"m4.large.search"|"m4.xlarge.search"|"m4.2xlarge.search"|"m4.4xlarge.search"|"m4.10xlarge.search"|"m5.large.search"|"m5.xlarge.search"|"m5.2xlarge.search"|"m5.4xlarge.search"|"m5.12xlarge.search"|"m5.24xlarge.search"|"r5.large.search"|"r5.xlarge.search"|"r5.2xlarge.search"|"r5.4xlarge.search"|"r5.12xlarge.search"|"r5.24xlarge.search"|"c5.large.search"|"c5.xlarge.search"|"c5.2xlarge.search"|"c5.4xlarge.search"|"c5.9xlarge.search"|"c5.18xlarge.search"|"t3.nano.search"|"t3.micro.search"|"t3.small.search"|"t3.medium.search"|"t3.large.search"|"t3.xlarge.search"|"t3.2xlarge.search"|"or1.medium.search"|"or1.large.search"|"or1.xlarge.search"|"or1.2xlarge.search"|"or1.4xlarge.search"|"or1.8xlarge.search"|"or1.12xlarge.search"|"or1.16xlarge.search"|"ultrawarm1.medium.search"|"ultrawarm1.large.search"|"ultrawarm1.xlarge.search"|"t2.micro.search"|"t2.small.search"|"t2.medium.search"|"r3.large.search"|"r3.xlarge.search"|"r3.2xlarge.search"|"r3.4xlarge.search"|"r3.8xlarge.search"|"i2.xlarge.search"|"i2.2xlarge.search"|"d2.xlarge.search"|"d2.2xlarge.search"|"d2.4xlarge.search"|"d2.8xlarge.search"|"c4.large.search"|"c4.xlarge.search"|"c4.2xlarge.search"|"c4.4xlarge.search"|"c4.8xlarge.search"|"r4.large.search"|"r4.xlarge.search"|"r4.2xlarge.search"|"r4.4xlarge.search"|"r4.8xlarge.search"|"r4.16xlarge.search"|"i3.large.search"|"i3.xlarge.search"|"i3.2xlarge.search"|"i3.4xlarge.search"|"i3.8xlarge.search"|"i3.16xlarge.search"|"r6g.large.search"|"r6g.xlarge.search"|"r6g.2xlarge.search"|"r6g.4xlarge.search"|"r6g.8xlarge.search"|"r6g.12xlarge.search"|"m6g.large.search"|"m6g.xlarge.search"|"m6g.2xlarge.search"|"m6g.4xlarge.search"|"m6g.8xlarge.search"|"m6g.12xlarge.search"|"c6g.large.search"|"c6g.xlarge.search"|"c6g.2xlarge.search"|"c6g.4xlarge.search"|"c6g.8xlarge.search"|"c6g.12xlarge.search"|"r6gd.large.search"|"r6gd.xlarge.search"|"r6gd.2xlarge.search"|"r6gd.4xlarge.search"|"r6gd.8xlarge.search"|"r6gd.12xlarge.search"|"r6gd.16xlarge.search"|"t4g.small.search"|"t4g.medium.search",
InstanceCount = 123,
DedicatedMasterEnabled = TRUE|FALSE,
ZoneAwarenessEnabled = TRUE|FALSE,
ZoneAwarenessConfig = list(
AvailabilityZoneCount = 123
),
DedicatedMasterType = "m3.medium.search"|"m3.large.search"|"m3.xlarge.search"|"m3.2xlarge.search"|"m4.large.search"|"m4.xlarge.search"|"m4.2xlarge.search"|"m4.4xlarge.search"|"m4.10xlarge.search"|"m5.large.search"|"m5.xlarge.search"|"m5.2xlarge.search"|"m5.4xlarge.search"|"m5.12xlarge.search"|"m5.24xlarge.search"|"r5.large.search"|"r5.xlarge.search"|"r5.2xlarge.search"|"r5.4xlarge.search"|"r5.12xlarge.search"|"r5.24xlarge.search"|"c5.large.search"|"c5.xlarge.search"|"c5.2xlarge.search"|"c5.4xlarge.search"|"c5.9xlarge.search"|"c5.18xlarge.search"|"t3.nano.search"|"t3.micro.search"|"t3.small.search"|"t3.medium.search"|"t3.large.search"|"t3.xlarge.search"|"t3.2xlarge.search"|"or1.medium.search"|"or1.large.search"|"or1.xlarge.search"|"or1.2xlarge.search"|"or1.4xlarge.search"|"or1.8xlarge.search"|"or1.12xlarge.search"|"or1.16xlarge.search"|"ultrawarm1.medium.search"|"ultrawarm1.large.search"|"ultrawarm1.xlarge.search"|"t2.micro.search"|"t2.small.search"|"t2.medium.search"|"r3.large.search"|"r3.xlarge.search"|"r3.2xlarge.search"|"r3.4xlarge.search"|"r3.8xlarge.search"|"i2.xlarge.search"|"i2.2xlarge.search"|"d2.xlarge.search"|"d2.2xlarge.search"|"d2.4xlarge.search"|"d2.8xlarge.search"|"c4.large.search"|"c4.xlarge.search"|"c4.2xlarge.search"|"c4.4xlarge.search"|"c4.8xlarge.search"|"r4.large.search"|"r4.xlarge.search"|"r4.2xlarge.search"|"r4.4xlarge.search"|"r4.8xlarge.search"|"r4.16xlarge.search"|"i3.large.search"|"i3.xlarge.search"|"i3.2xlarge.search"|"i3.4xlarge.search"|"i3.8xlarge.search"|"i3.16xlarge.search"|"r6g.large.search"|"r6g.xlarge.search"|"r6g.2xlarge.search"|"r6g.4xlarge.search"|"r6g.8xlarge.search"|"r6g.12xlarge.search"|"m6g.large.search"|"m6g.xlarge.search"|"m6g.2xlarge.search"|"m6g.4xlarge.search"|"m6g.8xlarge.search"|"m6g.12xlarge.search"|"c6g.large.search"|"c6g.xlarge.search"|"c6g.2xlarge.search"|"c6g.4xlarge.search"|"c6g.8xlarge.search"|"c6g.12xlarge.search"|"r6gd.large.search"|"r6gd.xlarge.search"|"r6gd.2xlarge.search"|"r6gd.4xlarge.search"|"r6gd.8xlarge.search"|"r6gd.12xlarge.search"|"r6gd.16xlarge.search"|"t4g.small.search"|"t4g.medium.search",
DedicatedMasterCount = 123,
WarmEnabled = TRUE|FALSE,
WarmType = "ultrawarm1.medium.search"|"ultrawarm1.large.search"|"ultrawarm1.xlarge.search",
WarmCount = 123,
ColdStorageOptions = list(
Enabled = TRUE|FALSE
),
MultiAZWithStandbyEnabled = TRUE|FALSE,
NodeOptions = list(
list(
NodeType = "coordinator",
NodeConfig = list(
Enabled = TRUE|FALSE,
Type = "m3.medium.search"|"m3.large.search"|"m3.xlarge.search"|"m3.2xlarge.search"|"m4.large.search"|"m4.xlarge.search"|"m4.2xlarge.search"|"m4.4xlarge.search"|"m4.10xlarge.search"|"m5.large.search"|"m5.xlarge.search"|"m5.2xlarge.search"|"m5.4xlarge.search"|"m5.12xlarge.search"|"m5.24xlarge.search"|"r5.large.search"|"r5.xlarge.search"|"r5.2xlarge.search"|"r5.4xlarge.search"|"r5.12xlarge.search"|"r5.24xlarge.search"|"c5.large.search"|"c5.xlarge.search"|"c5.2xlarge.search"|"c5.4xlarge.search"|"c5.9xlarge.search"|"c5.18xlarge.search"|"t3.nano.search"|"t3.micro.search"|"t3.small.search"|"t3.medium.search"|"t3.large.search"|"t3.xlarge.search"|"t3.2xlarge.search"|"or1.medium.search"|"or1.large.search"|"or1.xlarge.search"|"or1.2xlarge.search"|"or1.4xlarge.search"|"or1.8xlarge.search"|"or1.12xlarge.search"|"or1.16xlarge.search"|"ultrawarm1.medium.search"|"ultrawarm1.large.search"|"ultrawarm1.xlarge.search"|"t2.micro.search"|"t2.small.search"|"t2.medium.search"|"r3.large.search"|"r3.xlarge.search"|"r3.2xlarge.search"|"r3.4xlarge.search"|"r3.8xlarge.search"|"i2.xlarge.search"|"i2.2xlarge.search"|"d2.xlarge.search"|"d2.2xlarge.search"|"d2.4xlarge.search"|"d2.8xlarge.search"|"c4.large.search"|"c4.xlarge.search"|"c4.2xlarge.search"|"c4.4xlarge.search"|"c4.8xlarge.search"|"r4.large.search"|"r4.xlarge.search"|"r4.2xlarge.search"|"r4.4xlarge.search"|"r4.8xlarge.search"|"r4.16xlarge.search"|"i3.large.search"|"i3.xlarge.search"|"i3.2xlarge.search"|"i3.4xlarge.search"|"i3.8xlarge.search"|"i3.16xlarge.search"|"r6g.large.search"|"r6g.xlarge.search"|"r6g.2xlarge.search"|"r6g.4xlarge.search"|"r6g.8xlarge.search"|"r6g.12xlarge.search"|"m6g.large.search"|"m6g.xlarge.search"|"m6g.2xlarge.search"|"m6g.4xlarge.search"|"m6g.8xlarge.search"|"m6g.12xlarge.search"|"c6g.large.search"|"c6g.xlarge.search"|"c6g.2xlarge.search"|"c6g.4xlarge.search"|"c6g.8xlarge.search"|"c6g.12xlarge.search"|"r6gd.large.search"|"r6gd.xlarge.search"|"r6gd.2xlarge.search"|"r6gd.4xlarge.search"|"r6gd.8xlarge.search"|"r6gd.12xlarge.search"|"r6gd.16xlarge.search"|"t4g.small.search"|"t4g.medium.search",
Count = 123
)
)
)
),
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
)
),
IPAddressType = list(
Options = "ipv4"|"dualstack",
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"
),
EgressEnabled = 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
)
),
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"|"Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08",
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
),
JWTOptions = list(
Enabled = TRUE|FALSE,
SubjectKey = "string",
RolesKey = "string",
JwksUrl = "string",
PublicKey = "string"
),
IAMFederationOptions = list(
Enabled = TRUE|FALSE,
SubjectKey = "string",
RolesKey = "string"
),
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
)
),
IdentityCenterOptions = list(
Options = list(
EnabledAPIAccess = TRUE|FALSE,
IdentityCenterInstanceARN = "string",
IdentityCenterInstanceRegion = "string",
SubjectKey = "UserName"|"UserId"|"Email",
RolesKey = "GroupName"|"GroupId",
IdentityCenterApplicationARN = "string",
IdentityStoreId = "string"
),
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"
)
),
UseOffPeakWindow = TRUE|FALSE
),
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",
InitiatedBy = "CUSTOMER"|"SERVICE",
StartTime = as.POSIXct(
"2015-01-01"
),
LastUpdatedTime = as.POSIXct(
"2015-01-01"
)
),
OffPeakWindowOptions = list(
Options = list(
Enabled = TRUE|FALSE,
OffPeakWindow = list(
WindowStartTime = list(
Hours = 123,
Minutes = 123
)
)
),
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
),
SoftwareUpdateOptions = list(
Options = list(
AutoSoftwareUpdateEnabled = TRUE|FALSE,
UseLatestServiceSoftwareForBlueGreen = 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
)
),
ModifyingProperties = list(
list(
Name = "string",
ActiveValue = "string",
PendingValue = "string",
ValueType = "PLAIN_TEXT"|"STRINGIFIED_JSON"
)
),
AIMLOptions = list(
Options = list(
NaturalLanguageQueryGenerationOptions = list(
DesiredState = "ENABLED"|"DISABLED",
CurrentState = "NOT_ENABLED"|"ENABLE_COMPLETE"|"ENABLE_IN_PROGRESS"|"ENABLE_FAILED"|"DISABLE_COMPLETE"|"DISABLE_IN_PROGRESS"|"DISABLE_FAILED"
),
S3VectorsEngine = list(
Enabled = TRUE|FALSE
),
ServerlessVectorAcceleration = 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
)
),
DeploymentStrategyOptions = list(
Options = list(
DeploymentStrategy = "Default"|"CapacityOptimized"
),
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
),
AutomatedSnapshotPauseOptions = list(
Options = list(
Enabled = TRUE|FALSE,
StartTime = as.POSIXct(
"2015-01-01"
),
EndTime = as.POSIXct(
"2015-01-01"
),
State = "Active"|"Completed"|"Scheduled"|"Disabled"
),
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
),
UseCase = list(
Options = "SEARCH"|"VECTOR"|"OBSERVABILITY"|"MIXED",
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
),
EngineMode = list(
Options = "GENERAL"|"OPTIMIZED",
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
)
),
DryRunResults = list(
DeploymentType = "string",
Message = "string"
),
DryRunProgressStatus = list(
DryRunId = "string",
DryRunStatus = "string",
CreationDate = "string",
UpdateDate = "string",
ValidationFailures = list(
list(
Code = "string",
Message = "string",
Severity = "Critical"|"Warning"
)
),
AcceptedWarnings = list(
"string"
)
)
)
Request syntax¶
svc$update_domain_config(
DomainName = "string",
ClusterConfig = list(
InstanceType = "m3.medium.search"|"m3.large.search"|"m3.xlarge.search"|"m3.2xlarge.search"|"m4.large.search"|"m4.xlarge.search"|"m4.2xlarge.search"|"m4.4xlarge.search"|"m4.10xlarge.search"|"m5.large.search"|"m5.xlarge.search"|"m5.2xlarge.search"|"m5.4xlarge.search"|"m5.12xlarge.search"|"m5.24xlarge.search"|"r5.large.search"|"r5.xlarge.search"|"r5.2xlarge.search"|"r5.4xlarge.search"|"r5.12xlarge.search"|"r5.24xlarge.search"|"c5.large.search"|"c5.xlarge.search"|"c5.2xlarge.search"|"c5.4xlarge.search"|"c5.9xlarge.search"|"c5.18xlarge.search"|"t3.nano.search"|"t3.micro.search"|"t3.small.search"|"t3.medium.search"|"t3.large.search"|"t3.xlarge.search"|"t3.2xlarge.search"|"or1.medium.search"|"or1.large.search"|"or1.xlarge.search"|"or1.2xlarge.search"|"or1.4xlarge.search"|"or1.8xlarge.search"|"or1.12xlarge.search"|"or1.16xlarge.search"|"ultrawarm1.medium.search"|"ultrawarm1.large.search"|"ultrawarm1.xlarge.search"|"t2.micro.search"|"t2.small.search"|"t2.medium.search"|"r3.large.search"|"r3.xlarge.search"|"r3.2xlarge.search"|"r3.4xlarge.search"|"r3.8xlarge.search"|"i2.xlarge.search"|"i2.2xlarge.search"|"d2.xlarge.search"|"d2.2xlarge.search"|"d2.4xlarge.search"|"d2.8xlarge.search"|"c4.large.search"|"c4.xlarge.search"|"c4.2xlarge.search"|"c4.4xlarge.search"|"c4.8xlarge.search"|"r4.large.search"|"r4.xlarge.search"|"r4.2xlarge.search"|"r4.4xlarge.search"|"r4.8xlarge.search"|"r4.16xlarge.search"|"i3.large.search"|"i3.xlarge.search"|"i3.2xlarge.search"|"i3.4xlarge.search"|"i3.8xlarge.search"|"i3.16xlarge.search"|"r6g.large.search"|"r6g.xlarge.search"|"r6g.2xlarge.search"|"r6g.4xlarge.search"|"r6g.8xlarge.search"|"r6g.12xlarge.search"|"m6g.large.search"|"m6g.xlarge.search"|"m6g.2xlarge.search"|"m6g.4xlarge.search"|"m6g.8xlarge.search"|"m6g.12xlarge.search"|"c6g.large.search"|"c6g.xlarge.search"|"c6g.2xlarge.search"|"c6g.4xlarge.search"|"c6g.8xlarge.search"|"c6g.12xlarge.search"|"r6gd.large.search"|"r6gd.xlarge.search"|"r6gd.2xlarge.search"|"r6gd.4xlarge.search"|"r6gd.8xlarge.search"|"r6gd.12xlarge.search"|"r6gd.16xlarge.search"|"t4g.small.search"|"t4g.medium.search",
InstanceCount = 123,
DedicatedMasterEnabled = TRUE|FALSE,
ZoneAwarenessEnabled = TRUE|FALSE,
ZoneAwarenessConfig = list(
AvailabilityZoneCount = 123
),
DedicatedMasterType = "m3.medium.search"|"m3.large.search"|"m3.xlarge.search"|"m3.2xlarge.search"|"m4.large.search"|"m4.xlarge.search"|"m4.2xlarge.search"|"m4.4xlarge.search"|"m4.10xlarge.search"|"m5.large.search"|"m5.xlarge.search"|"m5.2xlarge.search"|"m5.4xlarge.search"|"m5.12xlarge.search"|"m5.24xlarge.search"|"r5.large.search"|"r5.xlarge.search"|"r5.2xlarge.search"|"r5.4xlarge.search"|"r5.12xlarge.search"|"r5.24xlarge.search"|"c5.large.search"|"c5.xlarge.search"|"c5.2xlarge.search"|"c5.4xlarge.search"|"c5.9xlarge.search"|"c5.18xlarge.search"|"t3.nano.search"|"t3.micro.search"|"t3.small.search"|"t3.medium.search"|"t3.large.search"|"t3.xlarge.search"|"t3.2xlarge.search"|"or1.medium.search"|"or1.large.search"|"or1.xlarge.search"|"or1.2xlarge.search"|"or1.4xlarge.search"|"or1.8xlarge.search"|"or1.12xlarge.search"|"or1.16xlarge.search"|"ultrawarm1.medium.search"|"ultrawarm1.large.search"|"ultrawarm1.xlarge.search"|"t2.micro.search"|"t2.small.search"|"t2.medium.search"|"r3.large.search"|"r3.xlarge.search"|"r3.2xlarge.search"|"r3.4xlarge.search"|"r3.8xlarge.search"|"i2.xlarge.search"|"i2.2xlarge.search"|"d2.xlarge.search"|"d2.2xlarge.search"|"d2.4xlarge.search"|"d2.8xlarge.search"|"c4.large.search"|"c4.xlarge.search"|"c4.2xlarge.search"|"c4.4xlarge.search"|"c4.8xlarge.search"|"r4.large.search"|"r4.xlarge.search"|"r4.2xlarge.search"|"r4.4xlarge.search"|"r4.8xlarge.search"|"r4.16xlarge.search"|"i3.large.search"|"i3.xlarge.search"|"i3.2xlarge.search"|"i3.4xlarge.search"|"i3.8xlarge.search"|"i3.16xlarge.search"|"r6g.large.search"|"r6g.xlarge.search"|"r6g.2xlarge.search"|"r6g.4xlarge.search"|"r6g.8xlarge.search"|"r6g.12xlarge.search"|"m6g.large.search"|"m6g.xlarge.search"|"m6g.2xlarge.search"|"m6g.4xlarge.search"|"m6g.8xlarge.search"|"m6g.12xlarge.search"|"c6g.large.search"|"c6g.xlarge.search"|"c6g.2xlarge.search"|"c6g.4xlarge.search"|"c6g.8xlarge.search"|"c6g.12xlarge.search"|"r6gd.large.search"|"r6gd.xlarge.search"|"r6gd.2xlarge.search"|"r6gd.4xlarge.search"|"r6gd.8xlarge.search"|"r6gd.12xlarge.search"|"r6gd.16xlarge.search"|"t4g.small.search"|"t4g.medium.search",
DedicatedMasterCount = 123,
WarmEnabled = TRUE|FALSE,
WarmType = "ultrawarm1.medium.search"|"ultrawarm1.large.search"|"ultrawarm1.xlarge.search",
WarmCount = 123,
ColdStorageOptions = list(
Enabled = TRUE|FALSE
),
MultiAZWithStandbyEnabled = TRUE|FALSE,
NodeOptions = list(
list(
NodeType = "coordinator",
NodeConfig = list(
Enabled = TRUE|FALSE,
Type = "m3.medium.search"|"m3.large.search"|"m3.xlarge.search"|"m3.2xlarge.search"|"m4.large.search"|"m4.xlarge.search"|"m4.2xlarge.search"|"m4.4xlarge.search"|"m4.10xlarge.search"|"m5.large.search"|"m5.xlarge.search"|"m5.2xlarge.search"|"m5.4xlarge.search"|"m5.12xlarge.search"|"m5.24xlarge.search"|"r5.large.search"|"r5.xlarge.search"|"r5.2xlarge.search"|"r5.4xlarge.search"|"r5.12xlarge.search"|"r5.24xlarge.search"|"c5.large.search"|"c5.xlarge.search"|"c5.2xlarge.search"|"c5.4xlarge.search"|"c5.9xlarge.search"|"c5.18xlarge.search"|"t3.nano.search"|"t3.micro.search"|"t3.small.search"|"t3.medium.search"|"t3.large.search"|"t3.xlarge.search"|"t3.2xlarge.search"|"or1.medium.search"|"or1.large.search"|"or1.xlarge.search"|"or1.2xlarge.search"|"or1.4xlarge.search"|"or1.8xlarge.search"|"or1.12xlarge.search"|"or1.16xlarge.search"|"ultrawarm1.medium.search"|"ultrawarm1.large.search"|"ultrawarm1.xlarge.search"|"t2.micro.search"|"t2.small.search"|"t2.medium.search"|"r3.large.search"|"r3.xlarge.search"|"r3.2xlarge.search"|"r3.4xlarge.search"|"r3.8xlarge.search"|"i2.xlarge.search"|"i2.2xlarge.search"|"d2.xlarge.search"|"d2.2xlarge.search"|"d2.4xlarge.search"|"d2.8xlarge.search"|"c4.large.search"|"c4.xlarge.search"|"c4.2xlarge.search"|"c4.4xlarge.search"|"c4.8xlarge.search"|"r4.large.search"|"r4.xlarge.search"|"r4.2xlarge.search"|"r4.4xlarge.search"|"r4.8xlarge.search"|"r4.16xlarge.search"|"i3.large.search"|"i3.xlarge.search"|"i3.2xlarge.search"|"i3.4xlarge.search"|"i3.8xlarge.search"|"i3.16xlarge.search"|"r6g.large.search"|"r6g.xlarge.search"|"r6g.2xlarge.search"|"r6g.4xlarge.search"|"r6g.8xlarge.search"|"r6g.12xlarge.search"|"m6g.large.search"|"m6g.xlarge.search"|"m6g.2xlarge.search"|"m6g.4xlarge.search"|"m6g.8xlarge.search"|"m6g.12xlarge.search"|"c6g.large.search"|"c6g.xlarge.search"|"c6g.2xlarge.search"|"c6g.4xlarge.search"|"c6g.8xlarge.search"|"c6g.12xlarge.search"|"r6gd.large.search"|"r6gd.xlarge.search"|"r6gd.2xlarge.search"|"r6gd.4xlarge.search"|"r6gd.8xlarge.search"|"r6gd.12xlarge.search"|"r6gd.16xlarge.search"|"t4g.small.search"|"t4g.medium.search",
Count = 123
)
)
)
),
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"
),
EgressEnabled = TRUE|FALSE
),
CognitoOptions = list(
Enabled = TRUE|FALSE,
UserPoolId = "string",
IdentityPoolId = "string",
RoleArn = "string"
),
AdvancedOptions = list(
"string"
),
AccessPolicies = "string",
IPAddressType = "ipv4"|"dualstack",
LogPublishingOptions = list(
list(
CloudWatchLogsLogGroupArn = "string",
Enabled = TRUE|FALSE
)
),
EncryptionAtRestOptions = list(
Enabled = TRUE|FALSE,
KmsKeyId = "string"
),
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"|"Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08",
CustomEndpointEnabled = TRUE|FALSE,
CustomEndpoint = "string",
CustomEndpointCertificateArn = "string"
),
NodeToNodeEncryptionOptions = list(
Enabled = TRUE|FALSE
),
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
),
JWTOptions = list(
Enabled = TRUE|FALSE,
SubjectKey = "string",
RolesKey = "string",
JwksUrl = "string",
PublicKey = "string"
),
IAMFederationOptions = list(
Enabled = TRUE|FALSE,
SubjectKey = "string",
RolesKey = "string"
),
AnonymousAuthEnabled = TRUE|FALSE
),
IdentityCenterOptions = list(
EnabledAPIAccess = TRUE|FALSE,
IdentityCenterInstanceARN = "string",
IdentityCenterInstanceRegion = "string",
SubjectKey = "UserName"|"UserId"|"Email",
RolesKey = "GroupName"|"GroupId"
),
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"
)
),
UseOffPeakWindow = TRUE|FALSE
),
DryRun = TRUE|FALSE,
DryRunMode = "Basic"|"Verbose",
OffPeakWindowOptions = list(
Enabled = TRUE|FALSE,
OffPeakWindow = list(
WindowStartTime = list(
Hours = 123,
Minutes = 123
)
)
),
SoftwareUpdateOptions = list(
AutoSoftwareUpdateEnabled = TRUE|FALSE,
UseLatestServiceSoftwareForBlueGreen = TRUE|FALSE
),
AIMLOptions = list(
NaturalLanguageQueryGenerationOptions = list(
DesiredState = "ENABLED"|"DISABLED"
),
S3VectorsEngine = list(
Enabled = TRUE|FALSE
),
ServerlessVectorAcceleration = list(
Enabled = TRUE|FALSE
)
),
DeploymentStrategyOptions = list(
DeploymentStrategy = "Default"|"CapacityOptimized"
),
AutomatedSnapshotPauseOptions = list(
Enabled = TRUE|FALSE,
StartTime = as.POSIXct(
"2015-01-01"
),
EndTime = as.POSIXct(
"2015-01-01"
)
),
UseCase = "SEARCH"|"VECTOR"|"OBSERVABILITY"|"MIXED",
EngineMode = "GENERAL"|"OPTIMIZED",
AcceptedWarnings = list(
"string"
)
)