Package com.pulumi.aws.opensearch.inputs
Class DomainState
- java.lang.Object
-
- com.pulumi.resources.InputArgs
-
- com.pulumi.resources.ResourceArgs
-
- com.pulumi.aws.opensearch.inputs.DomainState
-
public final class DomainState extends com.pulumi.resources.ResourceArgs
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDomainState.Builder
-
Field Summary
Fields Modifier and Type Field Description static DomainStateEmpty
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Optional<com.pulumi.core.Output<java.lang.String>>accessPolicies()java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>>advancedOptions()java.util.Optional<com.pulumi.core.Output<DomainAdvancedSecurityOptionsArgs>>advancedSecurityOptions()java.util.Optional<com.pulumi.core.Output<DomainAimlOptionsArgs>>aimlOptions()java.util.Optional<com.pulumi.core.Output<java.lang.String>>arn()java.util.Optional<com.pulumi.core.Output<DomainAutoTuneOptionsArgs>>autoTuneOptions()static DomainState.Builderbuilder()static DomainState.Builderbuilder(DomainState defaults)java.util.Optional<com.pulumi.core.Output<DomainClusterConfigArgs>>clusterConfig()java.util.Optional<com.pulumi.core.Output<DomainCognitoOptionsArgs>>cognitoOptions()java.util.Optional<com.pulumi.core.Output<java.lang.String>>dashboardEndpoint()java.util.Optional<com.pulumi.core.Output<java.lang.String>>dashboardEndpointV2()java.util.Optional<com.pulumi.core.Output<DomainDeploymentStrategyOptionsArgs>>deploymentStrategyOptions()java.util.Optional<com.pulumi.core.Output<DomainDomainEndpointOptionsArgs>>domainEndpointOptions()java.util.Optional<com.pulumi.core.Output<java.lang.String>>domainEndpointV2HostedZoneId()java.util.Optional<com.pulumi.core.Output<java.lang.String>>domainId()java.util.Optional<com.pulumi.core.Output<java.lang.String>>domainName()java.util.Optional<com.pulumi.core.Output<DomainEbsOptionsArgs>>ebsOptions()java.util.Optional<com.pulumi.core.Output<DomainEncryptAtRestArgs>>encryptAtRest()java.util.Optional<com.pulumi.core.Output<java.lang.String>>endpoint()java.util.Optional<com.pulumi.core.Output<java.lang.String>>endpointV2()java.util.Optional<com.pulumi.core.Output<java.lang.String>>engineVersion()java.util.Optional<com.pulumi.core.Output<DomainIdentityCenterOptionsArgs>>identityCenterOptions()java.util.Optional<com.pulumi.core.Output<java.lang.String>>ipAddressType()java.util.Optional<com.pulumi.core.Output<java.util.List<DomainLogPublishingOptionArgs>>>logPublishingOptions()java.util.Optional<com.pulumi.core.Output<DomainNodeToNodeEncryptionArgs>>nodeToNodeEncryption()java.util.Optional<com.pulumi.core.Output<DomainOffPeakWindowOptionsArgs>>offPeakWindowOptions()java.util.Optional<com.pulumi.core.Output<java.lang.String>>region()java.util.Optional<com.pulumi.core.Output<DomainSnapshotOptionsArgs>>snapshotOptions()java.util.Optional<com.pulumi.core.Output<DomainSoftwareUpdateOptionsArgs>>softwareUpdateOptions()java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>>tags()java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>>tagsAll()java.util.Optional<com.pulumi.core.Output<DomainVpcOptionsArgs>>vpcOptions()
-
-
-
Field Detail
-
Empty
public static final DomainState Empty
-
-
Method Detail
-
accessPolicies
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> accessPolicies()
- Returns:
- IAM policy document specifying the access policies for the domain.
-
advancedOptions
public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>> advancedOptions()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<DomainAdvancedSecurityOptionsArgs>> advancedSecurityOptions()
- Returns:
- Configuration block for [fine-grained access control](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html). Detailed below.
-
aimlOptions
public java.util.Optional<com.pulumi.core.Output<DomainAimlOptionsArgs>> aimlOptions()
- Returns:
- Configuration block for parameters required to enable all machine learning features. Detailed below.
-
arn
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
- Returns:
- ARN of the domain.
-
autoTuneOptions
public java.util.Optional<com.pulumi.core.Output<DomainAutoTuneOptionsArgs>> autoTuneOptions()
- Returns:
- Configuration block for the Auto-Tune options of the domain. Detailed below.
-
clusterConfig
public java.util.Optional<com.pulumi.core.Output<DomainClusterConfigArgs>> clusterConfig()
- Returns:
- Configuration block for the cluster of the domain. Detailed below.
-
cognitoOptions
public java.util.Optional<com.pulumi.core.Output<DomainCognitoOptionsArgs>> cognitoOptions()
- Returns:
- Configuration block for authenticating dashboard with Cognito. Detailed below.
-
dashboardEndpoint
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dashboardEndpoint()
- Returns:
- Domain-specific endpoint for Dashboard without HTTPS scheme.
-
dashboardEndpointV2
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dashboardEndpointV2()
- Returns:
- V2 domain endpoint for Dashboard that works with both IPv4 and IPv6 addresses, without HTTPS scheme.
-
deploymentStrategyOptions
public java.util.Optional<com.pulumi.core.Output<DomainDeploymentStrategyOptionsArgs>> deploymentStrategyOptions()
- Returns:
- Configuration block for the deployment strategy options of the domain. Detailed below.
-
domainEndpointOptions
public java.util.Optional<com.pulumi.core.Output<DomainDomainEndpointOptionsArgs>> domainEndpointOptions()
- Returns:
- Configuration block for domain endpoint HTTP(S) related options. Detailed below.
-
domainEndpointV2HostedZoneId
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> domainEndpointV2HostedZoneId()
- Returns:
- Dual stack hosted zone ID for the domain.
-
domainId
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> domainId()
- Returns:
- Unique identifier for the domain.
-
domainName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> domainName()
- Returns:
- Name of the domain. The following arguments are optional:
-
ebsOptions
public java.util.Optional<com.pulumi.core.Output<DomainEbsOptionsArgs>> ebsOptions()
- Returns:
- Configuration block for EBS related options, may be required based on chosen [instance size](https://aws.amazon.com/opensearch-service/pricing/). Detailed below.
-
encryptAtRest
public java.util.Optional<com.pulumi.core.Output<DomainEncryptAtRestArgs>> encryptAtRest()
- Returns:
- Configuration block for encrypt at rest options. Only available for [certain instance types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/encryption-at-rest.html). Detailed below.
-
endpoint
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpoint()
- Returns:
- Domain-specific endpoint used to submit index, search, and data upload requests.
-
endpointV2
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpointV2()
- Returns:
- V2 domain endpoint that works with both IPv4 and IPv6 addresses, used to submit index, search, and data upload requests.
-
engineVersion
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersion()
- Returns:
- 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](http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains). Defaults to the lastest version of OpenSearch.
-
identityCenterOptions
public java.util.Optional<com.pulumi.core.Output<DomainIdentityCenterOptionsArgs>> identityCenterOptions()
- Returns:
- Configuration block for enabling and managing IAM Identity Center integration within a domain. Detailed below.
-
ipAddressType
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> ipAddressType()
- Returns:
- The IP address type for the endpoint. Valid values are `ipv4` and `dualstack`.
-
logPublishingOptions
public java.util.Optional<com.pulumi.core.Output<java.util.List<DomainLogPublishingOptionArgs>>> logPublishingOptions()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<DomainNodeToNodeEncryptionArgs>> nodeToNodeEncryption()
- Returns:
- Configuration block for node-to-node encryption options. Detailed below.
-
offPeakWindowOptions
public java.util.Optional<com.pulumi.core.Output<DomainOffPeakWindowOptionsArgs>> offPeakWindowOptions()
- Returns:
- Configuration to add Off Peak update options. ([documentation](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html)). Detailed below.
-
region
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
- Returns:
- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
-
snapshotOptions
public java.util.Optional<com.pulumi.core.Output<DomainSnapshotOptionsArgs>> snapshotOptions()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<DomainSoftwareUpdateOptionsArgs>> softwareUpdateOptions()
- Returns:
- Software update options for the domain. Detailed below.
-
tags
public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>> tags()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>> tagsAll()
- Returns:
- Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
-
vpcOptions
public java.util.Optional<com.pulumi.core.Output<DomainVpcOptionsArgs>> vpcOptions()
- Returns:
- Configuration block for VPC related options. Adding or removing this configuration forces a new resource ([documentation](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html)). Detailed below.
-
builder
public static DomainState.Builder builder()
-
builder
public static DomainState.Builder builder(DomainState defaults)
-
-