DomainState class

Input properties used for looking up and filtering Domain resources.

Constructors

DomainState({Input<String?>? accessPolicies, Input<Map<String, String>?>? advancedOptions, Input<DomainAdvancedSecurityOptions?>? advancedSecurityOptions, Input<DomainAimlOptions?>? aimlOptions, Input<String?>? arn, Input<DomainAutoTuneOptions?>? autoTuneOptions, Input<DomainClusterConfig?>? clusterConfig, Input<DomainCognitoOptions?>? cognitoOptions, Input<String?>? dashboardEndpoint, Input<String?>? dashboardEndpointV2, Input<DomainDeploymentStrategyOptions?>? deploymentStrategyOptions, Input<DomainDomainEndpointOptions?>? domainEndpointOptions, Input<String?>? domainEndpointV2HostedZoneId, Input<String?>? domainId, Input<String?>? domainName, Input<DomainEbsOptions?>? ebsOptions, Input<DomainEncryptAtRest?>? encryptAtRest, Input<String?>? endpoint, Input<String?>? endpointV2, Input<String?>? engineVersion, Input<DomainIdentityCenterOptions?>? identityCenterOptions, Input<String?>? ipAddressType, Input<List<DomainLogPublishingOption>?>? logPublishingOptions, Input<DomainNodeToNodeEncryption?>? nodeToNodeEncryption, Input<DomainOffPeakWindowOptions?>? offPeakWindowOptions, Input<String?>? region, Input<DomainSnapshotOptions?>? snapshotOptions, Input<DomainSoftwareUpdateOptions?>? softwareUpdateOptions, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<DomainVpcOptions?>? vpcOptions})
Creates a new DomainState. accessPolicies IAM policy document specifying the access policies for the domain. advancedOptions Key-value string pairs to specify advanced configuration options. Note that the values for these configuration options must be strings (wrapped in quotes) or they may be wrong and cause a perpetual diff, causing the provider to want to recreate your OpenSearch domain on every apply. advancedSecurityOptions Configuration block for fine-grained access control. Detailed below. aimlOptions Configuration block for parameters required to enable all machine learning features. Detailed below. arn ARN of the domain. autoTuneOptions Configuration block for the Auto-Tune options of the domain. Detailed below. clusterConfig Configuration block for the cluster of the domain. Detailed below. cognitoOptions Configuration block for authenticating dashboard with Cognito. Detailed below. dashboardEndpoint Domain-specific endpoint for Dashboard without https scheme. dashboardEndpointV2 V2 domain endpoint for Dashboard that works with both IPv4 and IPv6 addresses, without https scheme. deploymentStrategyOptions Configuration block for the deployment strategy options of the domain. Detailed below. domainEndpointOptions Configuration block for domain endpoint HTTP(S) related options. Detailed below. domainEndpointV2HostedZoneId Dual stack hosted zone ID for the domain. domainId Unique identifier for the domain. domainName Name of the domain. ebsOptions Configuration block for EBS related options, may be required based on chosen instance size. Detailed below. encryptAtRest Configuration block for encrypt at rest options. Only available for certain instance types. Detailed below. endpoint Domain-specific endpoint used to submit index, search, and data upload requests. endpointV2 V2 domain endpoint that works with both IPv4 and IPv6 addresses, used to submit index, search, and data upload requests. engineVersion Either Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. identityCenterOptions Configuration block for enabling and managing IAM Identity Center integration within a domain. Detailed below. ipAddressType The IP address type for the endpoint. Valid values are ipv4 and dualstack. logPublishingOptions Configuration block for publishing slow and application logs to CloudWatch Logs. This block can be declared multiple times, for each log_type, within the same resource. Detailed below. nodeToNodeEncryption Configuration block for node-to-node encryption options. Detailed below. offPeakWindowOptions Configuration to add Off Peak update options. (documentation). Detailed below. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. snapshotOptions Configuration block for snapshot related options. Detailed below. DEPRECATED. For domains running OpenSearch 5.3 and later, Amazon OpenSearch takes hourly automated snapshots, making this setting irrelevant. For domains running earlier versions, OpenSearch takes daily automated snapshots. softwareUpdateOptions Software update options for the domain. Detailed below. tags Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. vpcOptions Configuration block for VPC related options. Adding or removing this configuration forces a new resource (documentation). Detailed below.
const
DomainState.fromMap(Map<String, dynamic> map)
factory

Properties

accessPolicies → Input<String?>?
IAM policy document specifying the access policies for the domain.
final
advancedOptions → Input<Map<String, String>?>?
Key-value string pairs to specify advanced configuration options. Note that the values for these configuration options must be strings (wrapped in quotes) or they may be wrong and cause a perpetual diff, causing the provider to want to recreate your OpenSearch domain on every apply.
final
advancedSecurityOptions → Input<DomainAdvancedSecurityOptions?>?
Configuration block for fine-grained access control. Detailed below.
final
aimlOptions → Input<DomainAimlOptions?>?
Configuration block for parameters required to enable all machine learning features. Detailed below.
final
arn → Input<String?>?
ARN of the domain.
final
autoTuneOptions → Input<DomainAutoTuneOptions?>?
Configuration block for the Auto-Tune options of the domain. Detailed below.
final
clusterConfig → Input<DomainClusterConfig?>?
Configuration block for the cluster of the domain. Detailed below.
final
cognitoOptions → Input<DomainCognitoOptions?>?
Configuration block for authenticating dashboard with Cognito. Detailed below.
final
dashboardEndpoint → Input<String?>?
Domain-specific endpoint for Dashboard without https scheme.
final
dashboardEndpointV2 → Input<String?>?
V2 domain endpoint for Dashboard that works with both IPv4 and IPv6 addresses, without https scheme.
final
deploymentStrategyOptions → Input<DomainDeploymentStrategyOptions?>?
Configuration block for the deployment strategy options of the domain. Detailed below.
final
domainEndpointOptions → Input<DomainDomainEndpointOptions?>?
Configuration block for domain endpoint HTTP(S) related options. Detailed below.
final
domainEndpointV2HostedZoneId → Input<String?>?
Dual stack hosted zone ID for the domain.
final
domainId → Input<String?>?
Unique identifier for the domain.
final
domainName → Input<String?>?
Name of the domain.
final
ebsOptions → Input<DomainEbsOptions?>?
Configuration block for EBS related options, may be required based on chosen instance size. Detailed below.
final
encryptAtRest → Input<DomainEncryptAtRest?>?
Configuration block for encrypt at rest options. Only available for certain instance types. Detailed below.
final
endpoint → Input<String?>?
Domain-specific endpoint used to submit index, search, and data upload requests.
final
endpointV2 → Input<String?>?
V2 domain endpoint that works with both IPv4 and IPv6 addresses, used to submit index, search, and data upload requests.
final
engineVersion → Input<String?>?
Either Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. See Creating and managing Amazon OpenSearch Service domains. Defaults to the lastest version of OpenSearch.
final
hashCode → int
The hash code for this object.
no setterinherited
identityCenterOptions → Input<DomainIdentityCenterOptions?>?
Configuration block for enabling and managing IAM Identity Center integration within a domain. Detailed below.
final
ipAddressType → Input<String?>?
The IP address type for the endpoint. Valid values are ipv4 and dualstack.
final
logPublishingOptions → Input<List<DomainLogPublishingOption>?>?
Configuration block for publishing slow and application logs to CloudWatch Logs. This block can be declared multiple times, for each log_type, within the same resource. Detailed below.
final
nodeToNodeEncryption → Input<DomainNodeToNodeEncryption?>?
Configuration block for node-to-node encryption options. Detailed below.
final
offPeakWindowOptions → Input<DomainOffPeakWindowOptions?>?
Configuration to add Off Peak update options. (documentation). Detailed below.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
snapshotOptions → Input<DomainSnapshotOptions?>?
Configuration block for snapshot related options. Detailed below. DEPRECATED. For domains running OpenSearch 5.3 and later, Amazon OpenSearch takes hourly automated snapshots, making this setting irrelevant. For domains running earlier versions, OpenSearch takes daily automated snapshots.
final
softwareUpdateOptions → Input<DomainSoftwareUpdateOptions?>?
Software update options for the domain. Detailed below.
final
tags → Input<Map<String, String>?>?
Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
vpcOptions → Input<DomainVpcOptions?>?
Configuration block for VPC related options. Adding or removing this configuration forces a new resource (documentation). Detailed below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited