AWS v6.55.0 published on Monday, Oct 7, 2024 by Pulumi
aws.opensearch.getServerlessCollection
Explore with Pulumi AI
Data source for managing an AWS OpenSearch Serverless Collection.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.opensearch.getServerlessCollection({
name: "example",
});
import pulumi
import pulumi_aws as aws
example = aws.opensearch.get_serverless_collection(name="example")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/opensearch"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := opensearch.LookupServerlessCollection(ctx, &opensearch.LookupServerlessCollectionArgs{
Name: pulumi.StringRef("example"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.OpenSearch.GetServerlessCollection.Invoke(new()
{
Name = "example",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.opensearch.OpensearchFunctions;
import com.pulumi.aws.opensearch.inputs.GetServerlessCollectionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = OpensearchFunctions.getServerlessCollection(GetServerlessCollectionArgs.builder()
.name("example")
.build());
}
}
variables:
example:
fn::invoke:
Function: aws:opensearch:getServerlessCollection
Arguments:
name: example
Using getServerlessCollection
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 getServerlessCollection(args: GetServerlessCollectionArgs, opts?: InvokeOptions): Promise<GetServerlessCollectionResult>
function getServerlessCollectionOutput(args: GetServerlessCollectionOutputArgs, opts?: InvokeOptions): Output<GetServerlessCollectionResult>
def get_serverless_collection(id: Optional[str] = None,
name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetServerlessCollectionResult
def get_serverless_collection_output(id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetServerlessCollectionResult]
func LookupServerlessCollection(ctx *Context, args *LookupServerlessCollectionArgs, opts ...InvokeOption) (*LookupServerlessCollectionResult, error)
func LookupServerlessCollectionOutput(ctx *Context, args *LookupServerlessCollectionOutputArgs, opts ...InvokeOption) LookupServerlessCollectionResultOutput
> Note: This function is named LookupServerlessCollection
in the Go SDK.
public static class GetServerlessCollection
{
public static Task<GetServerlessCollectionResult> InvokeAsync(GetServerlessCollectionArgs args, InvokeOptions? opts = null)
public static Output<GetServerlessCollectionResult> Invoke(GetServerlessCollectionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetServerlessCollectionResult> getServerlessCollection(GetServerlessCollectionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:opensearch/getServerlessCollection:getServerlessCollection
arguments:
# arguments dictionary
The following arguments are supported:
getServerlessCollection Result
The following output properties are available:
- Arn string
- Amazon Resource Name (ARN) of the collection.
- Collection
Endpoint string - Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
- Created
Date string - Date the Collection was created.
- Dashboard
Endpoint string - Collection-specific endpoint used to access OpenSearch Dashboards.
- Description string
- Description of the collection.
- Failure
Code string - A failure code associated with the collection.
- Failure
Message string - Id string
- Kms
Key stringArn - The ARN of the Amazon Web Services KMS key used to encrypt the collection.
- Last
Modified stringDate - Date the Collection was last modified.
- Name string
- Standby
Replicas string - Indicates whether standby replicas should be used for a collection.
- Dictionary<string, string>
- A map of tags to assign to the collection.
- Type string
- Type of collection.
- Arn string
- Amazon Resource Name (ARN) of the collection.
- Collection
Endpoint string - Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
- Created
Date string - Date the Collection was created.
- Dashboard
Endpoint string - Collection-specific endpoint used to access OpenSearch Dashboards.
- Description string
- Description of the collection.
- Failure
Code string - A failure code associated with the collection.
- Failure
Message string - Id string
- Kms
Key stringArn - The ARN of the Amazon Web Services KMS key used to encrypt the collection.
- Last
Modified stringDate - Date the Collection was last modified.
- Name string
- Standby
Replicas string - Indicates whether standby replicas should be used for a collection.
- map[string]string
- A map of tags to assign to the collection.
- Type string
- Type of collection.
- arn String
- Amazon Resource Name (ARN) of the collection.
- collection
Endpoint String - Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
- created
Date String - Date the Collection was created.
- dashboard
Endpoint String - Collection-specific endpoint used to access OpenSearch Dashboards.
- description String
- Description of the collection.
- failure
Code String - A failure code associated with the collection.
- failure
Message String - id String
- kms
Key StringArn - The ARN of the Amazon Web Services KMS key used to encrypt the collection.
- last
Modified StringDate - Date the Collection was last modified.
- name String
- standby
Replicas String - Indicates whether standby replicas should be used for a collection.
- Map<String,String>
- A map of tags to assign to the collection.
- type String
- Type of collection.
- arn string
- Amazon Resource Name (ARN) of the collection.
- collection
Endpoint string - Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
- created
Date string - Date the Collection was created.
- dashboard
Endpoint string - Collection-specific endpoint used to access OpenSearch Dashboards.
- description string
- Description of the collection.
- failure
Code string - A failure code associated with the collection.
- failure
Message string - id string
- kms
Key stringArn - The ARN of the Amazon Web Services KMS key used to encrypt the collection.
- last
Modified stringDate - Date the Collection was last modified.
- name string
- standby
Replicas string - Indicates whether standby replicas should be used for a collection.
- {[key: string]: string}
- A map of tags to assign to the collection.
- type string
- Type of collection.
- arn str
- Amazon Resource Name (ARN) of the collection.
- collection_
endpoint str - Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
- created_
date str - Date the Collection was created.
- dashboard_
endpoint str - Collection-specific endpoint used to access OpenSearch Dashboards.
- description str
- Description of the collection.
- failure_
code str - A failure code associated with the collection.
- failure_
message str - id str
- kms_
key_ strarn - The ARN of the Amazon Web Services KMS key used to encrypt the collection.
- last_
modified_ strdate - Date the Collection was last modified.
- name str
- standby_
replicas str - Indicates whether standby replicas should be used for a collection.
- Mapping[str, str]
- A map of tags to assign to the collection.
- type str
- Type of collection.
- arn String
- Amazon Resource Name (ARN) of the collection.
- collection
Endpoint String - Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
- created
Date String - Date the Collection was created.
- dashboard
Endpoint String - Collection-specific endpoint used to access OpenSearch Dashboards.
- description String
- Description of the collection.
- failure
Code String - A failure code associated with the collection.
- failure
Message String - id String
- kms
Key StringArn - The ARN of the Amazon Web Services KMS key used to encrypt the collection.
- last
Modified StringDate - Date the Collection was last modified.
- name String
- standby
Replicas String - Indicates whether standby replicas should be used for a collection.
- Map<String>
- A map of tags to assign to the collection.
- type String
- Type of collection.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.