Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.OpenSearch.Types.DomainStatus

Description

Synopsis

data DomainStatus = DomainStatus' {
- accessPolicies :: Maybe Text
- advancedOptions :: Maybe (HashMap Text Text)
- advancedSecurityOptions :: Maybe AdvancedSecurityOptions
- autoTuneOptions :: Maybe AutoTuneOptionsOutput
- changeProgressDetails :: Maybe ChangeProgressDetails
- cognitoOptions :: Maybe CognitoOptions
- created :: Maybe Bool
- deleted :: Maybe Bool
- domainEndpointOptions :: Maybe DomainEndpointOptions
- eBSOptions :: Maybe EBSOptions
- encryptionAtRestOptions :: Maybe EncryptionAtRestOptions
- endpoint :: Maybe Text
- endpoints :: Maybe (HashMap Text Text)
- engineVersion :: Maybe Text
- logPublishingOptions :: Maybe (HashMap LogType LogPublishingOption)
- nodeToNodeEncryptionOptions :: Maybe NodeToNodeEncryptionOptions
- processing :: Maybe Bool
- serviceSoftwareOptions :: Maybe ServiceSoftwareOptions
- snapshotOptions :: Maybe SnapshotOptions
- upgradeProcessing :: Maybe Bool
- vPCOptions :: Maybe VPCDerivedInfo
- domainId :: Text
- domainName :: Text
- arn :: Text
- clusterConfig :: ClusterConfig
}
newDomainStatus :: Text -> Text -> Text -> ClusterConfig -> DomainStatus
domainStatus_accessPolicies :: Lens' DomainStatus (Maybe Text)
domainStatus_advancedOptions :: Lens' DomainStatus (Maybe (HashMap Text Text))
domainStatus_advancedSecurityOptions :: Lens' DomainStatus (Maybe AdvancedSecurityOptions)
domainStatus_autoTuneOptions :: Lens' DomainStatus (Maybe AutoTuneOptionsOutput)
domainStatus_changeProgressDetails :: Lens' DomainStatus (Maybe ChangeProgressDetails)
domainStatus_cognitoOptions :: Lens' DomainStatus (Maybe CognitoOptions)
domainStatus_created :: Lens' DomainStatus (Maybe Bool)
domainStatus_deleted :: Lens' DomainStatus (Maybe Bool)
domainStatus_domainEndpointOptions :: Lens' DomainStatus (Maybe DomainEndpointOptions)
domainStatus_eBSOptions :: Lens' DomainStatus (Maybe EBSOptions)
domainStatus_encryptionAtRestOptions :: Lens' DomainStatus (Maybe EncryptionAtRestOptions)
domainStatus_endpoint :: Lens' DomainStatus (Maybe Text)
domainStatus_endpoints :: Lens' DomainStatus (Maybe (HashMap Text Text))
domainStatus_engineVersion :: Lens' DomainStatus (Maybe Text)
domainStatus_logPublishingOptions :: Lens' DomainStatus (Maybe (HashMap LogType LogPublishingOption))
domainStatus_nodeToNodeEncryptionOptions :: Lens' DomainStatus (Maybe NodeToNodeEncryptionOptions)
domainStatus_processing :: Lens' DomainStatus (Maybe Bool)
domainStatus_serviceSoftwareOptions :: Lens' DomainStatus (Maybe ServiceSoftwareOptions)
domainStatus_snapshotOptions :: Lens' DomainStatus (Maybe SnapshotOptions)
domainStatus_upgradeProcessing :: Lens' DomainStatus (Maybe Bool)
domainStatus_vPCOptions :: Lens' DomainStatus (Maybe VPCDerivedInfo)
domainStatus_domainId :: Lens' DomainStatus Text
domainStatus_domainName :: Lens' DomainStatus Text
domainStatus_arn :: Lens' DomainStatus Text
domainStatus_clusterConfig :: Lens' DomainStatus ClusterConfig

Documentation

data DomainStatus Source #

The current status of an OpenSearch Service domain.

See: newDomainStatus smart constructor.

Constructors

DomainStatus'

Fields

accessPolicies :: Maybe Text
Identity and Access Management (IAM) policy document specifying the access policies for the domain.
advancedOptions :: Maybe (HashMap Text Text)
Key-value pairs that specify advanced configuration options.
advancedSecurityOptions :: Maybe AdvancedSecurityOptions
Settings for fine-grained access control.
autoTuneOptions :: Maybe AutoTuneOptionsOutput
Auto-Tune settings for the domain.
changeProgressDetails :: Maybe ChangeProgressDetails
Information about a configuration change happening on the domain.
cognitoOptions :: Maybe CognitoOptions
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
created :: Maybe Bool
Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.
deleted :: Maybe Bool
Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.
domainEndpointOptions :: Maybe DomainEndpointOptions
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
eBSOptions :: Maybe EBSOptions
Container for EBS-based storage settings for the domain.
encryptionAtRestOptions :: Maybe EncryptionAtRestOptions
Encryption at rest settings for the domain.
endpoint :: Maybe Text
Domain-specific endpoint used to submit index, search, and data upload requests to the domain.
endpoints :: Maybe (HashMap Text Text)
The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.
engineVersion :: Maybe Text
Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.
logPublishingOptions :: Maybe (HashMap LogType LogPublishingOption)
Log publishing options for the domain.
nodeToNodeEncryptionOptions :: Maybe NodeToNodeEncryptionOptions
Whether node-to-node encryption is enabled or disabled.
processing :: Maybe Bool
The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.
serviceSoftwareOptions :: Maybe ServiceSoftwareOptions
The current status of the domain's service software.
snapshotOptions :: Maybe SnapshotOptions
DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
upgradeProcessing :: Maybe Bool
The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.
vPCOptions :: Maybe VPCDerivedInfo
The VPC configuration for the domain.
domainId :: Text
Unique identifier for the domain.
domainName :: Text
Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.
arn :: Text
The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.
clusterConfig :: ClusterConfig
Container for the cluster configuration of the domain.

Instances

Instances details

FromJSON DomainStatus Source #
Instance details Defined in Amazonka.OpenSearch.Types.DomainStatus Methods parseJSON :: Value -> Parser DomainStatus # parseJSONList :: Value -> Parser [DomainStatus] #
Generic DomainStatus Source #
Instance details Defined in Amazonka.OpenSearch.Types.DomainStatus Associated Types type Rep DomainStatus :: Type -> Type # Methods from :: DomainStatus -> Rep DomainStatus x # to :: Rep DomainStatus x -> DomainStatus #
Read DomainStatus Source #
Instance details Defined in Amazonka.OpenSearch.Types.DomainStatus Methods readsPrec :: Int -> ReadS DomainStatus # readList :: ReadS [DomainStatus] # readPrec :: ReadPrec DomainStatus # readListPrec :: ReadPrec [DomainStatus] #
Show DomainStatus Source #
Instance details Defined in Amazonka.OpenSearch.Types.DomainStatus Methods showsPrec :: Int -> DomainStatus -> ShowS # show :: DomainStatus -> String # showList :: [DomainStatus] -> ShowS #
NFData DomainStatus Source #
Instance details Defined in Amazonka.OpenSearch.Types.DomainStatus Methods rnf :: DomainStatus -> () #
Eq DomainStatus Source #
Instance details Defined in Amazonka.OpenSearch.Types.DomainStatus Methods (==) :: DomainStatus -> DomainStatus -> Bool # (/=) :: DomainStatus -> DomainStatus -> Bool #
Hashable DomainStatus Source #
Instance details Defined in Amazonka.OpenSearch.Types.DomainStatus Methods hashWithSalt :: Int -> DomainStatus -> Int # hash :: DomainStatus -> Int #
type Rep DomainStatus Source #
Instance details Defined in Amazonka.OpenSearch.Types.DomainStatus type Rep DomainStatus = D1 ('MetaData "DomainStatus" "Amazonka.OpenSearch.Types.DomainStatus" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "DomainStatus'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "accessPolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "advancedOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "advancedSecurityOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AdvancedSecurityOptions)))) :: (S1 ('MetaSel ('Just "autoTuneOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoTuneOptionsOutput)) :: (S1 ('MetaSel ('Just "changeProgressDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChangeProgressDetails)) :: S1 ('MetaSel ('Just "cognitoOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CognitoOptions))))) :: ((S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "deleted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "domainEndpointOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainEndpointOptions)))) :: (S1 ('MetaSel ('Just "eBSOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EBSOptions)) :: (S1 ('MetaSel ('Just "encryptionAtRestOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAtRestOptions)) :: S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "endpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "logPublishingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap LogType LogPublishingOption))))) :: (S1 ('MetaSel ('Just "nodeToNodeEncryptionOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodeToNodeEncryptionOptions)) :: (S1 ('MetaSel ('Just "processing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "serviceSoftwareOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceSoftwareOptions))))) :: ((S1 ('MetaSel ('Just "snapshotOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SnapshotOptions)) :: (S1 ('MetaSel ('Just "upgradeProcessing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "vPCOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VPCDerivedInfo)))) :: ((S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "clusterConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ClusterConfig)))))))

newDomainStatus Source #

Arguments

:: Text	`$sel:domainId:DomainStatus'`
-> Text	`$sel:domainName:DomainStatus'`
-> Text	`$sel:arn:DomainStatus'`
-> ClusterConfig	`$sel:clusterConfig:DomainStatus'`
-> DomainStatus

Create a value of DomainStatus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessPolicies:DomainStatus', domainStatus_accessPolicies - Identity and Access Management (IAM) policy document specifying the access policies for the domain.

$sel:advancedOptions:DomainStatus', domainStatus_advancedOptions - Key-value pairs that specify advanced configuration options.

$sel:advancedSecurityOptions:DomainStatus', domainStatus_advancedSecurityOptions - Settings for fine-grained access control.

$sel:autoTuneOptions:DomainStatus', domainStatus_autoTuneOptions - Auto-Tune settings for the domain.

$sel:changeProgressDetails:DomainStatus', domainStatus_changeProgressDetails - Information about a configuration change happening on the domain.

$sel:cognitoOptions:DomainStatus', domainStatus_cognitoOptions - Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

$sel:created:DomainStatus', domainStatus_created - Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

$sel:deleted:DomainStatus', domainStatus_deleted - Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

$sel:domainEndpointOptions:DomainStatus', domainStatus_domainEndpointOptions - Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

$sel:eBSOptions:DomainStatus', domainStatus_eBSOptions - Container for EBS-based storage settings for the domain.

$sel:encryptionAtRestOptions:DomainStatus', domainStatus_encryptionAtRestOptions - Encryption at rest settings for the domain.

$sel:endpoint:DomainStatus', domainStatus_endpoint - Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

$sel:endpoints:DomainStatus', domainStatus_endpoints - The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

$sel:engineVersion:DomainStatus', domainStatus_engineVersion - Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

$sel:logPublishingOptions:DomainStatus', domainStatus_logPublishingOptions - Log publishing options for the domain.

$sel:nodeToNodeEncryptionOptions:DomainStatus', domainStatus_nodeToNodeEncryptionOptions - Whether node-to-node encryption is enabled or disabled.

$sel:processing:DomainStatus', domainStatus_processing - The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

$sel:serviceSoftwareOptions:DomainStatus', domainStatus_serviceSoftwareOptions - The current status of the domain's service software.

$sel:snapshotOptions:DomainStatus', domainStatus_snapshotOptions - DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

$sel:upgradeProcessing:DomainStatus', domainStatus_upgradeProcessing - The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

$sel:vPCOptions:DomainStatus', domainStatus_vPCOptions - The VPC configuration for the domain.

$sel:domainId:DomainStatus', domainStatus_domainId - Unique identifier for the domain.

$sel:domainName:DomainStatus', domainStatus_domainName - Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

$sel:arn:DomainStatus', domainStatus_arn - The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

$sel:clusterConfig:DomainStatus', domainStatus_clusterConfig - Container for the cluster configuration of the domain.

domainStatus_accessPolicies :: Lens' DomainStatus (Maybe Text) Source #

Identity and Access Management (IAM) policy document specifying the access policies for the domain.

domainStatus_advancedOptions :: Lens' DomainStatus (Maybe (HashMap Text Text)) Source #

Key-value pairs that specify advanced configuration options.

domainStatus_advancedSecurityOptions :: Lens' DomainStatus (Maybe AdvancedSecurityOptions) Source #

Settings for fine-grained access control.

domainStatus_autoTuneOptions :: Lens' DomainStatus (Maybe AutoTuneOptionsOutput) Source #

Auto-Tune settings for the domain.

domainStatus_changeProgressDetails :: Lens' DomainStatus (Maybe ChangeProgressDetails) Source #

Information about a configuration change happening on the domain.

domainStatus_cognitoOptions :: Lens' DomainStatus (Maybe CognitoOptions) Source #

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

domainStatus_created :: Lens' DomainStatus (Maybe Bool) Source #

Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

domainStatus_deleted :: Lens' DomainStatus (Maybe Bool) Source #

Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

domainStatus_domainEndpointOptions :: Lens' DomainStatus (Maybe DomainEndpointOptions) Source #

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

domainStatus_eBSOptions :: Lens' DomainStatus (Maybe EBSOptions) Source #

Container for EBS-based storage settings for the domain.

domainStatus_encryptionAtRestOptions :: Lens' DomainStatus (Maybe EncryptionAtRestOptions) Source #

Encryption at rest settings for the domain.

domainStatus_endpoint :: Lens' DomainStatus (Maybe Text) Source #

Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

domainStatus_endpoints :: Lens' DomainStatus (Maybe (HashMap Text Text)) Source #

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

domainStatus_engineVersion :: Lens' DomainStatus (Maybe Text) Source #

Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

domainStatus_logPublishingOptions :: Lens' DomainStatus (Maybe (HashMap LogType LogPublishingOption)) Source #

Log publishing options for the domain.

domainStatus_nodeToNodeEncryptionOptions :: Lens' DomainStatus (Maybe NodeToNodeEncryptionOptions) Source #

Whether node-to-node encryption is enabled or disabled.

domainStatus_processing :: Lens' DomainStatus (Maybe Bool) Source #

The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

domainStatus_serviceSoftwareOptions :: Lens' DomainStatus (Maybe ServiceSoftwareOptions) Source #

The current status of the domain's service software.

domainStatus_snapshotOptions :: Lens' DomainStatus (Maybe SnapshotOptions) Source #

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

domainStatus_upgradeProcessing :: Lens' DomainStatus (Maybe Bool) Source #

The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

domainStatus_vPCOptions :: Lens' DomainStatus (Maybe VPCDerivedInfo) Source #

The VPC configuration for the domain.

domainStatus_domainId :: Lens' DomainStatus Text Source #

Unique identifier for the domain.

domainStatus_domainName :: Lens' DomainStatus Text Source #

Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

domainStatus_arn :: Lens' DomainStatus Text Source #

The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

domainStatus_clusterConfig :: Lens' DomainStatus ClusterConfig Source #

Container for the cluster configuration of the domain.