1. Packages
  2. AWS Native
  3. API Docs
  4. opensearchserverless
  5. getCollection

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

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

aws-native.opensearchserverless.getCollection

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

    Amazon OpenSearchServerless collection resource

    Using getCollection

    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 getCollection(args: GetCollectionArgs, opts?: InvokeOptions): Promise<GetCollectionResult>
    function getCollectionOutput(args: GetCollectionOutputArgs, opts?: InvokeOptions): Output<GetCollectionResult>
    def get_collection(id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetCollectionResult
    def get_collection_output(id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetCollectionResult]
    func LookupCollection(ctx *Context, args *LookupCollectionArgs, opts ...InvokeOption) (*LookupCollectionResult, error)
    func LookupCollectionOutput(ctx *Context, args *LookupCollectionOutputArgs, opts ...InvokeOption) LookupCollectionResultOutput

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

    public static class GetCollection 
    {
        public static Task<GetCollectionResult> InvokeAsync(GetCollectionArgs args, InvokeOptions? opts = null)
        public static Output<GetCollectionResult> Invoke(GetCollectionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCollectionResult> getCollection(GetCollectionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:opensearchserverless:getCollection
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The identifier of the collection
    Id string
    The identifier of the collection
    id String
    The identifier of the collection
    id string
    The identifier of the collection
    id str
    The identifier of the collection
    id String
    The identifier of the collection

    getCollection Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the collection.
    CollectionEndpoint string
    The endpoint for the collection.
    DashboardEndpoint string
    The OpenSearch Dashboards endpoint for the collection.
    Description string
    The description of the collection
    Id string
    The identifier of the collection
    StandbyReplicas Pulumi.AwsNative.OpenSearchServerless.CollectionStandbyReplicas
    Arn string
    The Amazon Resource Name (ARN) of the collection.
    CollectionEndpoint string
    The endpoint for the collection.
    DashboardEndpoint string
    The OpenSearch Dashboards endpoint for the collection.
    Description string
    The description of the collection
    Id string
    The identifier of the collection
    StandbyReplicas CollectionStandbyReplicas
    arn String
    The Amazon Resource Name (ARN) of the collection.
    collectionEndpoint String
    The endpoint for the collection.
    dashboardEndpoint String
    The OpenSearch Dashboards endpoint for the collection.
    description String
    The description of the collection
    id String
    The identifier of the collection
    standbyReplicas CollectionStandbyReplicas
    arn string
    The Amazon Resource Name (ARN) of the collection.
    collectionEndpoint string
    The endpoint for the collection.
    dashboardEndpoint string
    The OpenSearch Dashboards endpoint for the collection.
    description string
    The description of the collection
    id string
    The identifier of the collection
    standbyReplicas CollectionStandbyReplicas
    arn str
    The Amazon Resource Name (ARN) of the collection.
    collection_endpoint str
    The endpoint for the collection.
    dashboard_endpoint str
    The OpenSearch Dashboards endpoint for the collection.
    description str
    The description of the collection
    id str
    The identifier of the collection
    standby_replicas CollectionStandbyReplicas
    arn String
    The Amazon Resource Name (ARN) of the collection.
    collectionEndpoint String
    The endpoint for the collection.
    dashboardEndpoint String
    The OpenSearch Dashboards endpoint for the collection.
    description String
    The description of the collection
    id String
    The identifier of the collection
    standbyReplicas "ENABLED" | "DISABLED"

    Supporting Types

    CollectionStandbyReplicas

    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.103.0 published on Monday, Apr 22, 2024 by Pulumi