Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.OpenSearch.Types.DomainStatus

Description

Synopsis

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

See: newDomainStatus smart constructor.

Constructors

DomainStatus'

Fields

eBSOptions :: Maybe EBSOptions
The EBSOptions for the specified domain.
engineVersion :: Maybe Text
nodeToNodeEncryptionOptions :: Maybe NodeToNodeEncryptionOptions
The status of the NodeToNodeEncryptionOptions.
accessPolicies :: Maybe Text
IAM access policy as a JSON-formatted string.
serviceSoftwareOptions :: Maybe ServiceSoftwareOptions
The current status of the domain's service software.
autoTuneOptions :: Maybe AutoTuneOptionsOutput
The current status of the domain's Auto-Tune options.
logPublishingOptions :: Maybe (HashMap LogType LogPublishingOption)
Log publishing options for the given domain.
advancedSecurityOptions :: Maybe AdvancedSecurityOptions
The current status of the domain's advanced security options.
created :: Maybe Bool
The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.
snapshotOptions :: Maybe SnapshotOptions
The status of the SnapshotOptions.
cognitoOptions :: Maybe CognitoOptions
The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
encryptionAtRestOptions :: Maybe EncryptionAtRestOptions
The status of the EncryptionAtRestOptions.
deleted :: Maybe 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.
vPCOptions :: Maybe VPCDerivedInfo
The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
endpoints :: Maybe (HashMap Text Text)
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'.
domainEndpointOptions :: Maybe DomainEndpointOptions
The current status of the domain's endpoint options.
processing :: Maybe Bool
The status of the domain configuration. True if Amazon OpenSearch Service is processing configuration changes. False if the configuration is active.
endpoint :: Maybe Text
The domain endpoint that you use to submit index and search requests.
upgradeProcessing :: Maybe Bool
The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.
advancedOptions :: Maybe (HashMap Text Text)
The status of the AdvancedOptions.
domainId :: Text
The unique identifier for the specified domain.
domainName :: Text
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).
arn :: Text
The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.
clusterConfig :: ClusterConfig
The type and number of instances in the domain.

Instances

Instances details

Eq DomainStatus Source #
Instance details Defined in Amazonka.OpenSearch.Types.DomainStatus Methods (==) :: DomainStatus -> DomainStatus -> Bool # (/=) :: DomainStatus -> DomainStatus -> Bool #
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 #
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 #
NFData DomainStatus Source #
Instance details Defined in Amazonka.OpenSearch.Types.DomainStatus Methods rnf :: DomainStatus -> () #
Hashable DomainStatus Source #
Instance details Defined in Amazonka.OpenSearch.Types.DomainStatus Methods hashWithSalt :: Int -> DomainStatus -> Int # hash :: DomainStatus -> Int #
FromJSON DomainStatus Source #
Instance details Defined in Amazonka.OpenSearch.Types.DomainStatus Methods parseJSON :: Value -> Parser DomainStatus # parseJSONList :: Value -> Parser [DomainStatus] #
type Rep DomainStatus Source #
Instance details Defined in Amazonka.OpenSearch.Types.DomainStatus type Rep DomainStatus = D1 ('MetaData "DomainStatus" "Amazonka.OpenSearch.Types.DomainStatus" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "DomainStatus'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "eBSOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EBSOptions)) :: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nodeToNodeEncryptionOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodeToNodeEncryptionOptions)))) :: (S1 ('MetaSel ('Just "accessPolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "serviceSoftwareOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceSoftwareOptions)) :: S1 ('MetaSel ('Just "autoTuneOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoTuneOptionsOutput))))) :: ((S1 ('MetaSel ('Just "logPublishingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap LogType LogPublishingOption))) :: (S1 ('MetaSel ('Just "advancedSecurityOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AdvancedSecurityOptions)) :: S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "snapshotOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SnapshotOptions)) :: (S1 ('MetaSel ('Just "cognitoOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CognitoOptions)) :: S1 ('MetaSel ('Just "encryptionAtRestOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAtRestOptions)))))) :: (((S1 ('MetaSel ('Just "deleted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "vPCOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VPCDerivedInfo)) :: S1 ('MetaSel ('Just "endpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: (S1 ('MetaSel ('Just "domainEndpointOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainEndpointOptions)) :: (S1 ('MetaSel ('Just "processing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "upgradeProcessing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "advancedOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: 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:eBSOptions:DomainStatus', domainStatus_eBSOptions - The EBSOptions for the specified domain.

$sel:engineVersion:DomainStatus', domainStatus_engineVersion - Undocumented member.

$sel:nodeToNodeEncryptionOptions:DomainStatus', domainStatus_nodeToNodeEncryptionOptions - The status of the NodeToNodeEncryptionOptions.

$sel:accessPolicies:DomainStatus', domainStatus_accessPolicies - IAM access policy as a JSON-formatted string.

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

$sel:autoTuneOptions:DomainStatus', domainStatus_autoTuneOptions - The current status of the domain's Auto-Tune options.

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

$sel:advancedSecurityOptions:DomainStatus', domainStatus_advancedSecurityOptions - The current status of the domain's advanced security options.

$sel:created:DomainStatus', domainStatus_created - The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.

$sel:snapshotOptions:DomainStatus', domainStatus_snapshotOptions - The status of the SnapshotOptions.

$sel:cognitoOptions:DomainStatus', domainStatus_cognitoOptions - The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

$sel:encryptionAtRestOptions:DomainStatus', domainStatus_encryptionAtRestOptions - The status of the EncryptionAtRestOptions.

$sel:deleted:DomainStatus', domainStatus_deleted - 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.

$sel:vPCOptions:DomainStatus', domainStatus_vPCOptions - The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

$sel:endpoints:DomainStatus', domainStatus_endpoints - 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'.

$sel:domainEndpointOptions:DomainStatus', domainStatus_domainEndpointOptions - The current status of the domain's endpoint options.

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

$sel:endpoint:DomainStatus', domainStatus_endpoint - The domain endpoint that you use to submit index and search requests.

$sel:upgradeProcessing:DomainStatus', domainStatus_upgradeProcessing - The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.

$sel:advancedOptions:DomainStatus', domainStatus_advancedOptions - The status of the AdvancedOptions.

$sel:domainId:DomainStatus', domainStatus_domainId - The unique identifier for the specified domain.

$sel:domainName:DomainStatus', domainStatus_domainName - 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).

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

$sel:clusterConfig:DomainStatus', domainStatus_clusterConfig - The type and number of instances in the domain.

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

The EBSOptions for the specified domain.

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

Undocumented member.

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

The status of the NodeToNodeEncryptionOptions.

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

IAM access policy as a JSON-formatted string.

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

The current status of the domain's service software.

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

The current status of the domain's Auto-Tune options.

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

Log publishing options for the given domain.

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

The current status of the domain's advanced security options.

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

The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.

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

The status of the SnapshotOptions.

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

The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

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

The status of the EncryptionAtRestOptions.

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

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.

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

The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

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

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'.

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

The current status of the domain's endpoint options.

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

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

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

The domain endpoint that you use to submit index and search requests.

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

The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.

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

The status of the AdvancedOptions.

domainStatus_domainId :: Lens' DomainStatus Text Source #

The unique identifier for the specified domain.

domainStatus_domainName :: Lens' DomainStatus Text Source #

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).

domainStatus_arn :: Lens' DomainStatus Text Source #

The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.

domainStatus_clusterConfig :: Lens' DomainStatus ClusterConfig Source #

The type and number of instances in the domain.