We recommend new projects start with resources from the AWS provider.
aws-native.s3vectors.VectorBucket
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::S3Vectors::VectorBucket
Create VectorBucket Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VectorBucket(name: string, args?: VectorBucketArgs, opts?: CustomResourceOptions);@overload
def VectorBucket(resource_name: str,
args: Optional[VectorBucketArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def VectorBucket(resource_name: str,
opts: Optional[ResourceOptions] = None,
encryption_configuration: Optional[VectorBucketEncryptionConfigurationArgs] = None,
vector_bucket_name: Optional[str] = None)func NewVectorBucket(ctx *Context, name string, args *VectorBucketArgs, opts ...ResourceOption) (*VectorBucket, error)public VectorBucket(string name, VectorBucketArgs? args = null, CustomResourceOptions? opts = null)
public VectorBucket(String name, VectorBucketArgs args)
public VectorBucket(String name, VectorBucketArgs args, CustomResourceOptions options)
type: aws-native:s3vectors:VectorBucket
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args VectorBucketArgs
- 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 VectorBucketArgs
- 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 VectorBucketArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VectorBucketArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VectorBucketArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
VectorBucket Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The VectorBucket resource accepts the following input properties:
- Encryption
Configuration Pulumi.Aws Native. S3Vectors. Inputs. Vector Bucket Encryption Configuration - The encryption configuration for the vector bucket.
- Vector
Bucket stringName A name for the vector bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). The bucket name must be unique in the same AWS account for each AWS Region. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name.
The bucket name must be between 3 and 63 characters long and must not contain uppercase characters or underscores.
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
- Encryption
Configuration VectorBucket Encryption Configuration Args - The encryption configuration for the vector bucket.
- Vector
Bucket stringName A name for the vector bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). The bucket name must be unique in the same AWS account for each AWS Region. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name.
The bucket name must be between 3 and 63 characters long and must not contain uppercase characters or underscores.
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
- encryption
Configuration VectorBucket Encryption Configuration - The encryption configuration for the vector bucket.
- vector
Bucket StringName A name for the vector bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). The bucket name must be unique in the same AWS account for each AWS Region. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name.
The bucket name must be between 3 and 63 characters long and must not contain uppercase characters or underscores.
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
- encryption
Configuration VectorBucket Encryption Configuration - The encryption configuration for the vector bucket.
- vector
Bucket stringName A name for the vector bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). The bucket name must be unique in the same AWS account for each AWS Region. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name.
The bucket name must be between 3 and 63 characters long and must not contain uppercase characters or underscores.
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
- encryption_
configuration VectorBucket Encryption Configuration Args - The encryption configuration for the vector bucket.
- vector_
bucket_ strname A name for the vector bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). The bucket name must be unique in the same AWS account for each AWS Region. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name.
The bucket name must be between 3 and 63 characters long and must not contain uppercase characters or underscores.
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
- encryption
Configuration Property Map - The encryption configuration for the vector bucket.
- vector
Bucket StringName A name for the vector bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). The bucket name must be unique in the same AWS account for each AWS Region. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name.
The bucket name must be between 3 and 63 characters long and must not contain uppercase characters or underscores.
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.
Outputs
All input properties are implicitly available as output properties. Additionally, the VectorBucket resource produces the following output properties:
- Creation
Time string Returns the date and time when the vector bucket was created.
Example:
2024-12-21T10:30:00Z- Id string
- The provider-assigned unique ID for this managed resource.
- Vector
Bucket stringArn Returns the Amazon Resource Name (ARN) of the specified vector bucket.
Example:
arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket
- Creation
Time string Returns the date and time when the vector bucket was created.
Example:
2024-12-21T10:30:00Z- Id string
- The provider-assigned unique ID for this managed resource.
- Vector
Bucket stringArn Returns the Amazon Resource Name (ARN) of the specified vector bucket.
Example:
arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket
- creation
Time String Returns the date and time when the vector bucket was created.
Example:
2024-12-21T10:30:00Z- id String
- The provider-assigned unique ID for this managed resource.
- vector
Bucket StringArn Returns the Amazon Resource Name (ARN) of the specified vector bucket.
Example:
arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket
- creation
Time string Returns the date and time when the vector bucket was created.
Example:
2024-12-21T10:30:00Z- id string
- The provider-assigned unique ID for this managed resource.
- vector
Bucket stringArn Returns the Amazon Resource Name (ARN) of the specified vector bucket.
Example:
arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket
- creation_
time str Returns the date and time when the vector bucket was created.
Example:
2024-12-21T10:30:00Z- id str
- The provider-assigned unique ID for this managed resource.
- vector_
bucket_ strarn Returns the Amazon Resource Name (ARN) of the specified vector bucket.
Example:
arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket
- creation
Time String Returns the date and time when the vector bucket was created.
Example:
2024-12-21T10:30:00Z- id String
- The provider-assigned unique ID for this managed resource.
- vector
Bucket StringArn Returns the Amazon Resource Name (ARN) of the specified vector bucket.
Example:
arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket
Supporting Types
VectorBucketEncryptionConfiguration, VectorBucketEncryptionConfigurationArgs
The encryption configuration for the vector bucket.- Kms
Key stringArn - AWS Key Management Service (KMS) customer managed key ID to use for the encryption configuration. This parameter is allowed if and only if sseType is set to aws:kms
- Sse
Type Pulumi.Aws Native. S3Vectors. Vector Bucket Encryption Configuration Sse Type - The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.
- Kms
Key stringArn - AWS Key Management Service (KMS) customer managed key ID to use for the encryption configuration. This parameter is allowed if and only if sseType is set to aws:kms
- Sse
Type VectorBucket Encryption Configuration Sse Type - The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.
- kms
Key StringArn - AWS Key Management Service (KMS) customer managed key ID to use for the encryption configuration. This parameter is allowed if and only if sseType is set to aws:kms
- sse
Type VectorBucket Encryption Configuration Sse Type - The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.
- kms
Key stringArn - AWS Key Management Service (KMS) customer managed key ID to use for the encryption configuration. This parameter is allowed if and only if sseType is set to aws:kms
- sse
Type VectorBucket Encryption Configuration Sse Type - The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.
- kms_
key_ strarn - AWS Key Management Service (KMS) customer managed key ID to use for the encryption configuration. This parameter is allowed if and only if sseType is set to aws:kms
- sse_
type VectorBucket Encryption Configuration Sse Type - The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.
- kms
Key StringArn - AWS Key Management Service (KMS) customer managed key ID to use for the encryption configuration. This parameter is allowed if and only if sseType is set to aws:kms
- sse
Type "AES256" | "aws:kms" - The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.
VectorBucketEncryptionConfigurationSseType, VectorBucketEncryptionConfigurationSseTypeArgs
- Aes256
- AES256
- Awskms
- aws:kms
- Vector
Bucket Encryption Configuration Sse Type Aes256 - AES256
- Vector
Bucket Encryption Configuration Sse Type Awskms - aws:kms
- Aes256
- AES256
- Awskms
- aws:kms
- Aes256
- AES256
- Awskms
- aws:kms
- AES256
- AES256
- AWSKMS
- aws:kms
- "AES256"
- AES256
- "aws:kms"
- aws:kms
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
