1. Packages
  2. AWS Native
  3. API Docs
  4. opensearchservice
  5. getDomain

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

aws-native.opensearchservice.getDomain

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

    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
    Search the CloudFormation User Guide for AWS::OpenSearchService::Domain for more information about the expected schema for this property.
    AdvancedOptions Dictionary<string, string>
    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
    DomainEndpointV2 string
    DomainEndpoints Dictionary<string, string>
    EbsOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainEbsOptions
    EncryptionAtRestOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainEncryptionAtRestOptions
    EngineVersion string
    Id string
    IpAddressType string
    LogPublishingOptions Dictionary<string, Pulumi.AwsNative.OpenSearchService.Outputs.DomainLogPublishingOption>
    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.Outputs.Tag>
    An arbitrary set of tags (key-value pairs) for this Domain.
    VpcOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainVpcOptions
    AccessPolicies interface{}
    Search the CloudFormation User Guide for AWS::OpenSearchService::Domain for more information about the expected schema for this property.
    AdvancedOptions map[string]string
    AdvancedSecurityOptions DomainAdvancedSecurityOptionsInput
    Arn string
    ClusterConfig DomainClusterConfig
    CognitoOptions DomainCognitoOptions
    DomainArn string
    DomainEndpoint string
    DomainEndpointOptions DomainEndpointOptions
    DomainEndpointV2 string
    DomainEndpoints map[string]string
    EbsOptions DomainEbsOptions
    EncryptionAtRestOptions DomainEncryptionAtRestOptions
    EngineVersion string
    Id string
    IpAddressType string
    LogPublishingOptions map[string]DomainLogPublishingOption
    NodeToNodeEncryptionOptions DomainNodeToNodeEncryptionOptions
    OffPeakWindowOptions DomainOffPeakWindowOptions
    ServiceSoftwareOptions DomainServiceSoftwareOptions
    SnapshotOptions DomainSnapshotOptions
    SoftwareUpdateOptions DomainSoftwareUpdateOptions
    Tags Tag
    An arbitrary set of tags (key-value pairs) for this Domain.
    VpcOptions DomainVpcOptions
    accessPolicies Object
    Search the CloudFormation User Guide for AWS::OpenSearchService::Domain for more information about the expected schema for this property.
    advancedOptions Map<String,String>
    advancedSecurityOptions DomainAdvancedSecurityOptionsInput
    arn String
    clusterConfig DomainClusterConfig
    cognitoOptions DomainCognitoOptions
    domainArn String
    domainEndpoint String
    domainEndpointOptions DomainEndpointOptions
    domainEndpointV2 String
    domainEndpoints Map<String,String>
    ebsOptions DomainEbsOptions
    encryptionAtRestOptions DomainEncryptionAtRestOptions
    engineVersion String
    id String
    ipAddressType String
    logPublishingOptions Map<String,DomainLogPublishingOption>
    nodeToNodeEncryptionOptions DomainNodeToNodeEncryptionOptions
    offPeakWindowOptions DomainOffPeakWindowOptions
    serviceSoftwareOptions DomainServiceSoftwareOptions
    snapshotOptions DomainSnapshotOptions
    softwareUpdateOptions DomainSoftwareUpdateOptions
    tags List<Tag>
    An arbitrary set of tags (key-value pairs) for this Domain.
    vpcOptions DomainVpcOptions
    accessPolicies any
    Search the CloudFormation User Guide for AWS::OpenSearchService::Domain for more information about the expected schema for this property.
    advancedOptions {[key: string]: string}
    advancedSecurityOptions DomainAdvancedSecurityOptionsInput
    arn string
    clusterConfig DomainClusterConfig
    cognitoOptions DomainCognitoOptions
    domainArn string
    domainEndpoint string
    domainEndpointOptions DomainEndpointOptions
    domainEndpointV2 string
    domainEndpoints {[key: string]: string}
    ebsOptions DomainEbsOptions
    encryptionAtRestOptions DomainEncryptionAtRestOptions
    engineVersion string
    id string
    ipAddressType string
    logPublishingOptions {[key: string]: DomainLogPublishingOption}
    nodeToNodeEncryptionOptions DomainNodeToNodeEncryptionOptions
    offPeakWindowOptions DomainOffPeakWindowOptions
    serviceSoftwareOptions DomainServiceSoftwareOptions
    snapshotOptions DomainSnapshotOptions
    softwareUpdateOptions DomainSoftwareUpdateOptions
    tags Tag[]
    An arbitrary set of tags (key-value pairs) for this Domain.
    vpcOptions DomainVpcOptions
    access_policies Any
    Search the CloudFormation User Guide for AWS::OpenSearchService::Domain for more information about the expected schema for this property.
    advanced_options Mapping[str, str]
    advanced_security_options DomainAdvancedSecurityOptionsInput
    arn str
    cluster_config DomainClusterConfig
    cognito_options DomainCognitoOptions
    domain_arn str
    domain_endpoint str
    domain_endpoint_options DomainEndpointOptions
    domain_endpoint_v2 str
    domain_endpoints Mapping[str, str]
    ebs_options DomainEbsOptions
    encryption_at_rest_options DomainEncryptionAtRestOptions
    engine_version str
    id str
    ip_address_type str
    log_publishing_options Mapping[str, DomainLogPublishingOption]
    node_to_node_encryption_options DomainNodeToNodeEncryptionOptions
    off_peak_window_options DomainOffPeakWindowOptions
    service_software_options DomainServiceSoftwareOptions
    snapshot_options DomainSnapshotOptions
    software_update_options DomainSoftwareUpdateOptions
    tags Sequence[root_Tag]
    An arbitrary set of tags (key-value pairs) for this Domain.
    vpc_options DomainVpcOptions
    accessPolicies Any
    Search the CloudFormation User Guide for AWS::OpenSearchService::Domain for more information about the expected schema for this property.
    advancedOptions Map<String>
    advancedSecurityOptions Property Map
    arn String
    clusterConfig Property Map
    cognitoOptions Property Map
    domainArn String
    domainEndpoint String
    domainEndpointOptions Property Map
    domainEndpointV2 String
    domainEndpoints Map<String>
    ebsOptions Property Map
    encryptionAtRestOptions Property Map
    engineVersion String
    id String
    ipAddressType String
    logPublishingOptions Map<Property Map>
    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

    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

    DomainColdStorageOptions

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

    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

    DomainIdp

    DomainLogPublishingOption

    DomainMasterUserOptions

    DomainNodeToNodeEncryptionOptions

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

    DomainOffPeakWindow

    DomainOffPeakWindowOptions

    DomainSamlOptions

    DomainServiceSoftwareOptions

    DomainSnapshotOptions

    DomainSoftwareUpdateOptions

    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

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi