DomainStatus class
The current status of a domain.
Constructors
-
DomainStatus({required String arn, required ClusterConfig clusterConfig, required String domainId, required String domainName, String? accessPolicies, Map<
String, String> ? advancedOptions, AdvancedSecurityOptions? advancedSecurityOptions, AutoTuneOptionsOutput? autoTuneOptions, ChangeProgressDetails? changeProgressDetails, CognitoOptions? cognitoOptions, bool? created, bool? deleted, DomainEndpointOptions? domainEndpointOptions, EBSOptions? eBSOptions, EncryptionAtRestOptions? encryptionAtRestOptions, String? endpoint, Map<String, String> ? endpoints, String? engineVersion, Map<LogType, LogPublishingOption> ? logPublishingOptions, NodeToNodeEncryptionOptions? nodeToNodeEncryptionOptions, bool? processing, ServiceSoftwareOptions? serviceSoftwareOptions, SnapshotOptions? snapshotOptions, bool? upgradeProcessing, VPCDerivedInfo? vPCOptions}) -
DomainStatus.fromJson(Map<
String, dynamic> json) -
factory
Properties
- accessPolicies → String?
-
IAM access policy as a JSON-formatted string.
final
-
advancedOptions
→ Map<
String, String> ? -
The status of the
AdvancedOptions
.final - advancedSecurityOptions → AdvancedSecurityOptions?
-
The current status of the domain's advanced security options.
final
- arn → String
-
The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access
Management User Guide for more information.
final
- autoTuneOptions → AutoTuneOptionsOutput?
-
The current status of the domain's Auto-Tune options.
final
- changeProgressDetails → ChangeProgressDetails?
-
Specifies change details of the domain configuration change.
final
- clusterConfig → ClusterConfig
-
The type and number of instances in the domain.
final
- cognitoOptions → CognitoOptions?
-
The
CognitoOptions
for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.final - created → bool?
-
The domain creation status.
True
if the creation of a domain is complete.False
if domain creation is still in progress.final - deleted → bool?
-
The domain deletion status.
True
if a delete request has been received for the domain but resource cleanup is still in progress.False
if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.final - domainEndpointOptions → DomainEndpointOptions?
-
The current status of the domain's endpoint options.
final
- domainId → String
-
The unique identifier for the specified domain.
final
- domainName → String
-
The name of a domain. Domain names are unique across the domains owned by an
account within an AWS region. Domain names start with a letter or number and
can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
final
- eBSOptions → EBSOptions?
-
The
EBSOptions
for the specified domain.final - encryptionAtRestOptions → EncryptionAtRestOptions?
-
The status of the
EncryptionAtRestOptions
.final - endpoint → String?
-
The domain endpoint that you use to submit index and search requests.
final
-
endpoints
→ Map<
String, String> ? -
Map containing the domain endpoints used to submit index and search
requests. Example
key, value
:'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'
.final - engineVersion → String?
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
logPublishingOptions
→ Map<
LogType, LogPublishingOption> ? -
Log publishing options for the given domain.
final
- nodeToNodeEncryptionOptions → NodeToNodeEncryptionOptions?
-
The status of the
NodeToNodeEncryptionOptions
.final - processing → bool?
-
The status of the domain configuration.
True
if Amazon OpenSearch Service is processing configuration changes.False
if the configuration is active.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- serviceSoftwareOptions → ServiceSoftwareOptions?
-
The current status of the domain's service software.
final
- snapshotOptions → SnapshotOptions?
-
The status of the
SnapshotOptions
.final - upgradeProcessing → bool?
-
The status of a domain version upgrade.
True
if Amazon OpenSearch Service is undergoing a version upgrade.False
if the configuration is active.final - vPCOptions → VPCDerivedInfo?
-
The
VPCOptions
for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited