AWS Native v0.63.0, May 25 23

aws-native.opensearchservice.getDomain

Explore with Pulumi AI

An example resource schema demonstrating some basic constructs and validation rules.

Using getDomain

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDomain(args: GetDomainArgs, opts?: InvokeOptions): Promise<GetDomainResult>
function getDomainOutput(args: GetDomainOutputArgs, opts?: InvokeOptions): Output<GetDomainResult>

def get_domain(domain_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetDomainResult
def get_domain_output(domain_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetDomainResult]

func LookupDomain(ctx *Context, args *LookupDomainArgs, opts ...InvokeOption) (*LookupDomainResult, error)
func LookupDomainOutput(ctx *Context, args *LookupDomainOutputArgs, opts ...InvokeOption) LookupDomainResultOutput

> Note: This function is named LookupDomain in the Go SDK.

public static class GetDomain 
{
    public static Task<GetDomainResult> InvokeAsync(GetDomainArgs args, InvokeOptions? opts = null)
    public static Output<GetDomainResult> Invoke(GetDomainInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:opensearchservice:getDomain
  arguments:
    # arguments dictionary

The following arguments are supported:

DomainName string

DomainName string

domainName String

domainName string

domain_name str

domainName String

getDomain Result

The following output properties are available:

AccessPolicies object
AdvancedOptions object
AdvancedSecurityOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainAdvancedSecurityOptionsInput
Arn string
ClusterConfig Pulumi.AwsNative.OpenSearchService.Outputs.DomainClusterConfig
CognitoOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainCognitoOptions
DomainArn string
DomainEndpoint string
DomainEndpointOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainEndpointOptions
DomainEndpoints object
EBSOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainEBSOptions
EncryptionAtRestOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainEncryptionAtRestOptions
EngineVersion string
Id string
LogPublishingOptions object
NodeToNodeEncryptionOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainNodeToNodeEncryptionOptions
OffPeakWindowOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainOffPeakWindowOptions
ServiceSoftwareOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainServiceSoftwareOptions
SnapshotOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainSnapshotOptions
SoftwareUpdateOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainSoftwareUpdateOptions
Tags List<Pulumi.AwsNative.OpenSearchService.Outputs.DomainTag>: An arbitrary set of tags (key-value pairs) for this Domain.
VPCOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainVPCOptions

AccessPolicies interface{}
AdvancedOptions interface{}
AdvancedSecurityOptions DomainAdvancedSecurityOptionsInput
Arn string
ClusterConfig DomainClusterConfig
CognitoOptions DomainCognitoOptions
DomainArn string
DomainEndpoint string
DomainEndpointOptions DomainEndpointOptions
DomainEndpoints interface{}
EBSOptions DomainEBSOptions
EncryptionAtRestOptions DomainEncryptionAtRestOptions
EngineVersion string
Id string
LogPublishingOptions interface{}
NodeToNodeEncryptionOptions DomainNodeToNodeEncryptionOptions
OffPeakWindowOptions DomainOffPeakWindowOptions
ServiceSoftwareOptions DomainServiceSoftwareOptions
SnapshotOptions DomainSnapshotOptions
SoftwareUpdateOptions DomainSoftwareUpdateOptions
Tags []DomainTag: An arbitrary set of tags (key-value pairs) for this Domain.
VPCOptions DomainVPCOptions

accessPolicies Any
advancedOptions Any
advancedSecurityOptions Property Map
arn String
clusterConfig Property Map
cognitoOptions Property Map
domainArn String
domainEndpoint String
domainEndpointOptions Property Map
domainEndpoints Any
eBSOptions Property Map
encryptionAtRestOptions Property Map
engineVersion String
id String
logPublishingOptions Any
nodeToNodeEncryptionOptions Property Map
offPeakWindowOptions Property Map
serviceSoftwareOptions Property Map
snapshotOptions Property Map
softwareUpdateOptions Property Map
tags List<Property Map>: An arbitrary set of tags (key-value pairs) for this Domain.
vPCOptions Property Map

Supporting Types

enabled Boolean
kmsKeyId String

enabled boolean
kmsKeyId string

enabled bool
kms_key_id str

enabled Boolean
kmsKeyId String

CustomEndpoint string
CustomEndpointCertificateArn string
CustomEndpointEnabled bool
EnforceHTTPS bool
TLSSecurityPolicy string

customEndpoint String
customEndpointCertificateArn String
customEndpointEnabled Boolean
enforceHTTPS Boolean
tLSSecurityPolicy String

customEndpoint string
customEndpointCertificateArn string
customEndpointEnabled boolean
enforceHTTPS boolean
tLSSecurityPolicy string

custom_endpoint str
custom_endpoint_certificate_arn str
custom_endpoint_enabled bool
enforce_https bool
t_ls_security_policy str

customEndpoint String
customEndpointCertificateArn String
customEndpointEnabled Boolean
enforceHTTPS Boolean
tLSSecurityPolicy String

DomainIdp

EntityId string
MetadataContent string

EntityId string
MetadataContent string

entityId String
metadataContent String

entityId string
metadataContent string

entity_id str
metadata_content str

entityId String
metadataContent String

DomainMasterUserOptions

MasterUserARN string
MasterUserName string
MasterUserPassword string

MasterUserARN string
MasterUserName string
MasterUserPassword string

masterUserARN String
masterUserName String
masterUserPassword String

masterUserARN string
masterUserName string
masterUserPassword string

master_user_arn str
master_user_name str
master_user_password str

masterUserARN String
masterUserName String
masterUserPassword String

DomainNodeToNodeEncryptionOptions

Enabled bool

Enabled bool

enabled Boolean

enabled boolean

enabled bool

enabled Boolean

DomainOffPeakWindow

WindowStartTime Pulumi.AwsNative.OpenSearchService.Inputs.DomainWindowStartTime

WindowStartTime DomainWindowStartTime

windowStartTime DomainWindowStartTime

windowStartTime DomainWindowStartTime

window_start_time DomainWindowStartTime

windowStartTime Property Map

DomainOffPeakWindowOptions

Enabled bool
OffPeakWindow Pulumi.AwsNative.OpenSearchService.Inputs.DomainOffPeakWindow

Enabled bool
OffPeakWindow DomainOffPeakWindow

enabled Boolean
offPeakWindow DomainOffPeakWindow

enabled boolean
offPeakWindow DomainOffPeakWindow

enabled bool
off_peak_window DomainOffPeakWindow

enabled Boolean
offPeakWindow Property Map

DomainSAMLOptions

Enabled bool
Idp Pulumi.AwsNative.OpenSearchService.Inputs.DomainIdp
MasterBackendRole string
MasterUserName string
RolesKey string
SessionTimeoutMinutes int
SubjectKey string

Enabled bool
Idp DomainIdp
MasterBackendRole string
MasterUserName string
RolesKey string
SessionTimeoutMinutes int
SubjectKey string

enabled Boolean
idp DomainIdp
masterBackendRole String
masterUserName String
rolesKey String
sessionTimeoutMinutes Integer
subjectKey String

enabled boolean
idp DomainIdp
masterBackendRole string
masterUserName string
rolesKey string
sessionTimeoutMinutes number
subjectKey string

enabled bool
idp DomainIdp
master_backend_role str
master_user_name str
roles_key str
session_timeout_minutes int
subject_key str

enabled Boolean
idp Property Map
masterBackendRole String
masterUserName String
rolesKey String
sessionTimeoutMinutes Number
subjectKey String

DomainServiceSoftwareOptions

AutomatedUpdateDate string
Cancellable bool
CurrentVersion string
Description string
NewVersion string
OptionalDeployment bool
UpdateAvailable bool
UpdateStatus string

AutomatedUpdateDate string
Cancellable bool
CurrentVersion string
Description string
NewVersion string
OptionalDeployment bool
UpdateAvailable bool
UpdateStatus string

automatedUpdateDate String
cancellable Boolean
currentVersion String
description String
newVersion String
optionalDeployment Boolean
updateAvailable Boolean
updateStatus String

automatedUpdateDate string
cancellable boolean
currentVersion string
description string
newVersion string
optionalDeployment boolean
updateAvailable boolean
updateStatus string

automated_update_date str
cancellable bool
current_version str
description str
new_version str
optional_deployment bool
update_available bool
update_status str

automatedUpdateDate String
cancellable Boolean
currentVersion String
description String
newVersion String
optionalDeployment Boolean
updateAvailable Boolean
updateStatus String

DomainSnapshotOptions

AutomatedSnapshotStartHour int

AutomatedSnapshotStartHour int

automatedSnapshotStartHour Integer

automatedSnapshotStartHour number

automated_snapshot_start_hour int

automatedSnapshotStartHour Number

DomainSoftwareUpdateOptions

AutoSoftwareUpdateEnabled bool

AutoSoftwareUpdateEnabled bool

autoSoftwareUpdateEnabled Boolean

autoSoftwareUpdateEnabled boolean

auto_software_update_enabled bool

autoSoftwareUpdateEnabled Boolean

DomainTag

Key string: The value of the tag.
Value string: The key of the tag.

Key string: The value of the tag.
Value string: The key of the tag.

key String: The value of the tag.
value String: The key of the tag.

key string: The value of the tag.
value string: The key of the tag.

key str: The value of the tag.
value str: The key of the tag.

key String: The value of the tag.
value String: The key of the tag.

DomainVPCOptions

SecurityGroupIds List<string>
SubnetIds List<string>

SecurityGroupIds []string
SubnetIds []string

securityGroupIds List<String>
subnetIds List<String>

securityGroupIds string[]
subnetIds string[]

security_group_ids Sequence[str]
subnet_ids Sequence[str]

securityGroupIds List<String>
subnetIds List<String>

DomainWindowStartTime

Hours int
Minutes int

Hours int
Minutes int

hours Integer
minutes Integer

hours number
minutes number

hours int
minutes int

hours Number
minutes Number

DomainZoneAwarenessConfig

AvailabilityZoneCount int

AvailabilityZoneCount int

availabilityZoneCount Integer

availabilityZoneCount number

availability_zone_count int

availabilityZoneCount Number

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0