Package com.pulumi.aws.s3

Class VectorsVectorBucket

  • public class VectorsVectorBucket
extends com.pulumi.resources.CustomResource
    Resource for managing an Amazon S3 Vectors Vector Bucket. ## Example Usage ### Basic Usage 
     
 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());
 
     }
 }
    ### Encryption 
     
 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());
 
     }
 }
    ## 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: ```sh $ pulumi import aws:s3/vectorsVectorBucket:VectorsVectorBucket example arn:aws:s3vectors:us-west-2:123456789012:bucket/example-bucket ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> creationTime()  
      com.pulumi.core.Output<java.util.List<VectorsVectorBucketEncryptionConfiguration>> encryptionConfigurations()  
      com.pulumi.core.Output<java.lang.Boolean> forceDestroy()  
      static VectorsVectorBucket get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, VectorsVectorBucketState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> vectorBucketArn()  
      com.pulumi.core.Output<java.lang.String> vectorBucketName()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • VectorsVectorBucket

        public VectorsVectorBucket​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • VectorsVectorBucket

        public VectorsVectorBucket​(java.lang.String name,
                           VectorsVectorBucketArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • VectorsVectorBucket

        public VectorsVectorBucket​(java.lang.String name,
                           VectorsVectorBucketArgs args,
                           @Nullable
                           com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • creationTime

        public com.pulumi.core.Output<java.lang.String> creationTime()
        Returns:
        Date and time when the vector bucket was created.

      • encryptionConfigurations

        public com.pulumi.core.Output<java.util.List<VectorsVectorBucketEncryptionConfiguration>> encryptionConfigurations()
        Returns:
        Encryption configuration for the vector bucket. See `encryptionConfiguration` below for more details.

      • forceDestroy

        public com.pulumi.core.Output<java.lang.Boolean> forceDestroy()
        Returns:
        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 successful `pulumi up` run before a destroy is required to update this value in the resource state. Without a successful `pulumi up` after 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.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • vectorBucketArn

        public com.pulumi.core.Output<java.lang.String> vectorBucketArn()
        Returns:
        ARN of the vector bucket.

      • vectorBucketName

        public com.pulumi.core.Output<java.lang.String> vectorBucketName()
        Returns:
        Name of the vector bucket. The following arguments are optional:

      • get

        public static VectorsVectorBucket get​(java.lang.String name,
                                      com.pulumi.core.Output<java.lang.String> id,
                                      @Nullable
                                      VectorsVectorBucketState state,
                                      @Nullable
                                      com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.