DomainArgs class
The set of arguments for Domain. The set of arguments for Domain.
Constructors
-
DomainArgs({Input<
String?> ? accessPolicies, Input<Map< ? advancedOptions, Input<String, String> ?>DomainAdvancedSecurityOptions?> ? advancedSecurityOptions, Input<DomainAimlOptions?> ? aimlOptions, Input<DomainAutoTuneOptions?> ? autoTuneOptions, Input<DomainClusterConfig?> ? clusterConfig, Input<DomainCognitoOptions?> ? cognitoOptions, Input<DomainDeploymentStrategyOptions?> ? deploymentStrategyOptions, Input<DomainDomainEndpointOptions?> ? domainEndpointOptions, Input<String?> ? domainName, Input<DomainEbsOptions?> ? ebsOptions, Input<DomainEncryptAtRest?> ? encryptAtRest, Input<String?> ? engineVersion, Input<DomainIdentityCenterOptions?> ? identityCenterOptions, Input<String?> ? ipAddressType, Input<List< ? logPublishingOptions, Input<DomainLogPublishingOption> ?>DomainNodeToNodeEncryption?> ? nodeToNodeEncryption, Input<DomainOffPeakWindowOptions?> ? offPeakWindowOptions, Input<String?> ? region, Input<DomainSnapshotOptions?> ? snapshotOptions, Input<DomainSoftwareUpdateOptions?> ? softwareUpdateOptions, Input<Map< ? tags, Input<String, String> ?>DomainVpcOptions?> ? vpcOptions}) -
Creates a new DomainArgs.
accessPoliciesIAM policy document specifying the access policies for the domain.advancedOptionsKey-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.advancedSecurityOptionsConfiguration block for fine-grained access control. Detailed below.aimlOptionsConfiguration block for parameters required to enable all machine learning features. Detailed below.autoTuneOptionsConfiguration block for the Auto-Tune options of the domain. Detailed below.clusterConfigConfiguration block for the cluster of the domain. Detailed below.cognitoOptionsConfiguration block for authenticating dashboard with Cognito. Detailed below.deploymentStrategyOptionsConfiguration block for the deployment strategy options of the domain. Detailed below.domainEndpointOptionsConfiguration block for domain endpoint HTTP(S) related options. Detailed below.domainNameName of the domain.ebsOptionsConfiguration block for EBS related options, may be required based on chosen instance size. Detailed below.encryptAtRestConfiguration block for encrypt at rest options. Only available for certain instance types. Detailed below.engineVersionEitherElasticsearch_X.YorOpenSearch_X.Yto specify the engine version for the Amazon OpenSearch Service domain. For example,OpenSearch_1.0orElasticsearch_7.9.identityCenterOptionsConfiguration block for enabling and managing IAM Identity Center integration within a domain. Detailed below.ipAddressTypeThe IP address type for the endpoint. Valid values areipv4anddualstack.logPublishingOptionsConfiguration 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.nodeToNodeEncryptionConfiguration block for node-to-node encryption options. Detailed below.offPeakWindowOptionsConfiguration to add Off Peak update options. (documentation). Detailed below.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.snapshotOptionsConfiguration 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.softwareUpdateOptionsSoftware update options for the domain. Detailed below.tagsMap of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.vpcOptionsConfiguration block for VPC related options. Adding or removing this configuration forces a new resource (documentation). Detailed below.const -
DomainArgs.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
-
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
-
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
-
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
-
engineVersion
→ Input<
String?> ? -
Either
Elasticsearch_X.YorOpenSearch_X.Yto specify the engine version for the Amazon OpenSearch Service domain. For example,OpenSearch_1.0orElasticsearch_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
ipv4anddualstack.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
-
Map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.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