Package com.pulumi.aws.s3

Class VectorsVectorBucketPolicy

  • public class VectorsVectorBucketPolicy
extends com.pulumi.resources.CustomResource
    Resource for managing an Amazon S3 Vectors Vector Bucket policy. ## 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.VectorsVectorBucketPolicy;
 import com.pulumi.aws.s3.VectorsVectorBucketPolicyArgs;
 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 VectorsVectorBucketPolicy("example", VectorsVectorBucketPolicyArgs.builder()
             .vectorBucketArn(exampleAwsS3vectorsVectorBucket.arn())
             .policy("""
 {
   \"Version\": \"2012-10-17\",
   \"Id\": \"writePolicy\",
   \"Statement\": [{
     \"Sid\": \"writeStatement\",
     \"Effect\": \"Allow\",
     \"Principal\": {
       \"AWS\": \"123456789012\"
     },
     \"Action\": [
       \"s3vectors:PutVectors\"
     ],
     \"Resource\": \"*\"
   }]
 }
             """)
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `vectorBucketArn` (String) ARN of the S3 Vectors Vector Bucket. Using `pulumi import`, import S3 Vectors Vector Bucket policy using the `vectorBucketArn`. For example: ```sh $ pulumi import aws:s3/vectorsVectorBucketPolicy:VectorsVectorBucketPolicy 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
      static VectorsVectorBucketPolicy get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, VectorsVectorBucketPolicyState 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> policy()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> vectorBucketArn()  

      • 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

      • VectorsVectorBucketPolicy

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

      • VectorsVectorBucketPolicy

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

      • VectorsVectorBucketPolicy

        public VectorsVectorBucketPolicy​(java.lang.String name,
                                 VectorsVectorBucketPolicyArgs 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

      • policy

        public com.pulumi.core.Output<java.lang.String> policy()
        Returns:
        Policy document.

      • 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.

      • vectorBucketArn

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

      • get

        public static VectorsVectorBucketPolicy get​(java.lang.String name,
                                            com.pulumi.core.Output<java.lang.String> id,
                                            @Nullable
                                            VectorsVectorBucketPolicyState 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.