1. Pulumi Registry
  2. AWS Native
  3. API Docs
  4. opensearchserverless
  5. Collection
aws-native logo
AWS Native v0.49.0, Jan 26 23

aws-native.opensearchserverless.Collection

Amazon OpenSearchServerless collection resource

Create Collection Resource

new Collection(name: string, args?: CollectionArgs, opts?: CustomResourceOptions);
@overload
def Collection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               description: Optional[str] = None,
               name: Optional[str] = None,
               tags: Optional[Sequence[CollectionTagArgs]] = None,
               type: Optional[CollectionType] = None)
@overload
def Collection(resource_name: str,
               args: Optional[CollectionArgs] = None,
               opts: Optional[ResourceOptions] = None)
func NewCollection(ctx *Context, name string, args *CollectionArgs, opts ...ResourceOption) (*Collection, error)
public Collection(string name, CollectionArgs? args = null, CustomResourceOptions? opts = null)
public Collection(String name, CollectionArgs args)
public Collection(String name, CollectionArgs args, CustomResourceOptions options)

type: aws-native:opensearchserverless:Collection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CollectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args CollectionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args CollectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CollectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args CollectionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Collection Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Collection resource accepts the following input properties:

Description string

The description of the collection

Name string

The name of the collection.

The name must meet the following criteria: Unique to your account and AWS Region Starts with a lowercase letter Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-) Contains between 3 and 32 characters

Tags List<Pulumi.AwsNative.OpenSearchServerless.Inputs.CollectionTagArgs>

List of tags to be added to the resource

Type Pulumi.AwsNative.OpenSearchServerless.CollectionType
Description string

The description of the collection

Name string

The name of the collection.

The name must meet the following criteria: Unique to your account and AWS Region Starts with a lowercase letter Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-) Contains between 3 and 32 characters

Tags []CollectionTagArgs

List of tags to be added to the resource

Type CollectionType
description String

The description of the collection

name String

The name of the collection.

The name must meet the following criteria: Unique to your account and AWS Region Starts with a lowercase letter Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-) Contains between 3 and 32 characters

tags List<CollectionTagArgs>

List of tags to be added to the resource

type CollectionType
description string

The description of the collection

name string

The name of the collection.

The name must meet the following criteria: Unique to your account and AWS Region Starts with a lowercase letter Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-) Contains between 3 and 32 characters

tags CollectionTagArgs[]

List of tags to be added to the resource

type CollectionType
description str

The description of the collection

name str

The name of the collection.

The name must meet the following criteria: Unique to your account and AWS Region Starts with a lowercase letter Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-) Contains between 3 and 32 characters

tags Sequence[CollectionTagArgs]

List of tags to be added to the resource

type CollectionType
description String

The description of the collection

name String

The name of the collection.

The name must meet the following criteria: Unique to your account and AWS Region Starts with a lowercase letter Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-) Contains between 3 and 32 characters

tags List<Property Map>

List of tags to be added to the resource

type "SEARCH" | "TIMESERIES"

Outputs

All input properties are implicitly available as output properties. Additionally, the Collection resource produces the following output properties:

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.

Id string

The provider-assigned unique ID for this managed resource.

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.

Id string

The provider-assigned unique ID for this managed resource.

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.

id String

The provider-assigned unique ID for this managed resource.

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.

id string

The provider-assigned unique ID for this managed resource.

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.

id str

The provider-assigned unique ID for this managed resource.

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.

id String

The provider-assigned unique ID for this managed resource.

Supporting Types

CollectionTag

Key string

The key in the key-value pair

Value string

The value in the key-value pair

Key string

The key in the key-value pair

Value string

The value in the key-value pair

key String

The key in the key-value pair

value String

The value in the key-value pair

key string

The key in the key-value pair

value string

The value in the key-value pair

key str

The key in the key-value pair

value str

The value in the key-value pair

key String

The key in the key-value pair

value String

The value in the key-value pair

CollectionType

Search
SEARCH
Timeseries
TIMESERIES
CollectionTypeSearch
SEARCH
CollectionTypeTimeseries
TIMESERIES
Search
SEARCH
Timeseries
TIMESERIES
Search
SEARCH
Timeseries
TIMESERIES
SEARCH
SEARCH
TIMESERIES
TIMESERIES
"SEARCH"
SEARCH
"TIMESERIES"
TIMESERIES

Package Details

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