aws-native.opensearchserverless.getCollection

AWS Cloud Control v1.60.0, Apr 6 26

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.60.0
published on Monday, Apr 6, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.60.0
published on Monday, Apr 6, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

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)
public static Output<GetCollectionResult> getCollection(GetCollectionArgs args, InvokeOptions options)

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
FipsEndpoints Pulumi.AwsNative.OpenSearchServerless.Outputs.CollectionFipsEndpoints
Id string: The identifier of the collection
KmsKeyArn string: Key Management Service key used to encrypt the collection.

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
FipsEndpoints CollectionFipsEndpoints
Id string: The identifier of the collection
KmsKeyArn string: Key Management Service key used to encrypt the collection.

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
fipsEndpoints CollectionFipsEndpoints
id String: The identifier of the collection
kmsKeyArn String: Key Management Service key used to encrypt the collection.

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
fipsEndpoints CollectionFipsEndpoints
id string: The identifier of the collection
kmsKeyArn string: Key Management Service key used to encrypt the collection.

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
fips_endpoints CollectionFipsEndpoints
id str: The identifier of the collection
kms_key_arn str: Key Management Service key used to encrypt the collection.

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
fipsEndpoints Property Map
id String: The identifier of the collection
kmsKeyArn String: Key Management Service key used to encrypt the collection.