AWS Native

v0.29.0 published on Thursday, Sep 8, 2022 by Pulumi

getDomain

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
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
ServiceSoftwareOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainServiceSoftwareOptions
SnapshotOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainSnapshotOptions
Tags List<Pulumi.AwsNative.OpenSearchService.Outputs.DomainTag>

An arbitrary set of tags (key-value pairs) for this Domain.

VPCOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainVPCOptions

Supporting Types

DomainAdvancedSecurityOptionsInput

DomainClusterConfig

DomainCognitoOptions

Enabled bool
IdentityPoolId string
RoleArn string
UserPoolId string
Enabled bool
IdentityPoolId string
RoleArn string
UserPoolId string
enabled Boolean
identityPoolId String
roleArn String
userPoolId String
enabled boolean
identityPoolId string
roleArn string
userPoolId string
enabled Boolean
identityPoolId String
roleArn String
userPoolId String

DomainEBSOptions

eBSEnabled Boolean
iops Integer
throughput Integer
volumeSize Integer
volumeType String
eBSEnabled boolean
iops number
throughput number
volumeSize number
volumeType string
eBSEnabled Boolean
iops Number
throughput Number
volumeSize Number
volumeType String

DomainEncryptionAtRestOptions

Enabled bool
KmsKeyId string
Enabled bool
KmsKeyId string
enabled Boolean
kmsKeyId String
enabled boolean
kmsKeyId string
enabled Boolean
kmsKeyId String

DomainEndpointOptions

DomainMasterUserOptions

DomainNodeToNodeEncryptionOptions

Enabled bool
Enabled bool
enabled Boolean
enabled boolean
enabled bool
enabled Boolean

DomainServiceSoftwareOptions

DomainSnapshotOptions

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>

DomainZoneAwarenessConfig

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0