Describe Domain Config
| opensearchservice_describe_domain_config | R Documentation |
Returns the configuration of an Amazon OpenSearch Service domain¶
Description¶
Returns the configuration of an Amazon OpenSearch Service domain.
Usage¶
Arguments¶
DomainName[required] Name of the OpenSearch Service domain configuration that you want to describe.
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
),
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"
)
),
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
),
JWTOptions = list(
Enabled = TRUE|FALSE,
SubjectKey = "string",
RolesKey = "string",
PublicKey = "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
)
),
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
),
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"
)
),
Status = list(
CreationDate = as.POSIXct(
"2015-01-01"
),
UpdateDate = as.POSIXct(
"2015-01-01"
),
UpdateVersion = 123,
State = "RequiresIndexDocuments"|"Processing"|"Active",
PendingDeletion = TRUE|FALSE
)
)
)
)