VectorsVectorBucket class
Resource for managing an Amazon S3 Vectors Vector Bucket.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.s3.VectorsVectorBucket("example", {vectorBucketName: "example-bucket"});
import pulumi
import pulumi_aws as aws
example = aws.s3.VectorsVectorBucket("example", vector_bucket_name="example-bucket")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.S3.VectorsVectorBucket("example", new()
{
VectorBucketName = "example-bucket",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := s3.NewVectorsVectorBucket(ctx, "example", &s3.VectorsVectorBucketArgs{
VectorBucketName: pulumi.String("example-bucket"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_s3_vectorsvectorbucket" "example" {
vector_bucket_name = "example-bucket"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.VectorsVectorBucket;
import com.pulumi.aws.s3.VectorsVectorBucketArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
var example = new VectorsVectorBucket("example", VectorsVectorBucketArgs.builder()
.vectorBucketName("example-bucket")
.build());
}
}
resources:
example:
type: aws:s3:VectorsVectorBucket
properties:
vectorBucketName: example-bucket
Encryption
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.s3.VectorsVectorBucket("example", {
encryptionConfigurations: [{
sseType: "aws:kms",
kmsKeyArn: exampleAwsKmsKey.arn,
}],
vectorBucketName: "example-bucket",
});
import pulumi
import pulumi_aws as aws
example = aws.s3.VectorsVectorBucket("example",
encryption_configurations=[{
"sse_type": "aws:kms",
"kms_key_arn": example_aws_kms_key["arn"],
}],
vector_bucket_name="example-bucket")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.S3.VectorsVectorBucket("example", new()
{
EncryptionConfigurations = new[]
{
new Aws.S3.Inputs.VectorsVectorBucketEncryptionConfigurationArgs
{
SseType = "aws:kms",
KmsKeyArn = exampleAwsKmsKey.Arn,
},
},
VectorBucketName = "example-bucket",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := s3.NewVectorsVectorBucket(ctx, "example", &s3.VectorsVectorBucketArgs{
EncryptionConfigurations: s3.VectorsVectorBucketEncryptionConfigurationArray{
&s3.VectorsVectorBucketEncryptionConfigurationArgs{
SseType: pulumi.String("aws:kms"),
KmsKeyArn: pulumi.Any(exampleAwsKmsKey.Arn),
},
},
VectorBucketName: pulumi.String("example-bucket"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_s3_vectorsvectorbucket" "example" {
encryption_configurations {
sse_type = "aws:kms"
kms_key_arn = exampleAwsKmsKey.arn
}
vector_bucket_name = "example-bucket"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.VectorsVectorBucket;
import com.pulumi.aws.s3.VectorsVectorBucketArgs;
import com.pulumi.aws.s3.inputs.VectorsVectorBucketEncryptionConfigurationArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
var example = new VectorsVectorBucket("example", VectorsVectorBucketArgs.builder()
.encryptionConfigurations(VectorsVectorBucketEncryptionConfigurationArgs.builder()
.sseType("aws:kms")
.kmsKeyArn(exampleAwsKmsKey.arn())
.build())
.vectorBucketName("example-bucket")
.build());
}
}
resources:
example:
type: aws:s3:VectorsVectorBucket
properties:
encryptionConfigurations:
- sseType: aws:kms
kmsKeyArn: ${exampleAwsKmsKey.arn}
vectorBucketName: example-bucket
Import
Identity Schema
Required
vectorBucketArn(String) ARN of the S3 Vectors Vector Bucket.
Using pulumi import, import S3 Vectors Vector Bucket using the vectorBucketArn. For example:
$ pulumi import aws:s3/vectorsVectorBucket:VectorsVectorBucket example arn:aws:s3vectors:us-west-2:123456789012:bucket/example-bucket
Constructors
- VectorsVectorBucket(String name, {VectorsVectorBucketArgs? args, CustomResourceOptions? options})
-
Creates a new VectorsVectorBucket.
nameThe Pulumi resource name.argsArguments used to configure this VectorsVectorBucket. The set of arguments for VectorsVectorBucket.optionsResource options controlling this resource's behavior. - VectorsVectorBucket.reference(String urn)
- Creates a typed reference to an existing VectorsVectorBucket resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
creationTime
↔ Output<
String> -
Date and time when the vector bucket was created.
latefinal
-
encryptionConfigurations
↔ Output<
List< VectorsVectorBucketEncryptionConfiguration> > -
Encryption configuration for the vector bucket. See
encryptionConfigurationbelow for more details.latefinal -
forceDestroy
↔ Output<
bool> -
Boolean that indicates all indexes and vectors should be deleted from the vector bucket when the vector bucket is destroyed so that the vector bucket can be destroyed without error. Once this parameter is set to
true, there must be a successfulpulumi uprun before a destroy is required to update this value in the resource state. Without a successfulpulumi upafter this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the vector bucket or destroying the vector bucket, this flag will not work.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vectorBucketArn
↔ Output<
String> -
ARN of the vector bucket.
latefinal
-
vectorBucketName
↔ Output<
String> -
Name of the vector bucket.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {VectorsVectorBucketState? state, CustomResourceOptions? options}) → VectorsVectorBucket -
Gets an existing VectorsVectorBucket resource's state with the given
nameandid.