VectorsVectorBucketPolicy class
Resource for managing an Amazon S3 Vectors Vector Bucket policy.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.s3.VectorsVectorBucketPolicy("example", {
vectorBucketArn: exampleAwsS3vectorsVectorBucket.arn,
policy: `{
\\"Version\\": \\"2012-10-17\\",
\\"Id\\": \\"writePolicy\\",
\\"Statement\\": [{
\\"Sid\\": \\"writeStatement\\",
\\"Effect\\": \\"Allow\\",
\\"Principal\\": {
\\"AWS\\": \\"123456789012\\"
},
\\"Action\\": [
\\"s3vectors:PutVectors\\"
],
\\"Resource\\": \\"*\\"
}]
}
`,
});
import pulumi
import pulumi_aws as aws
example = aws.s3.VectorsVectorBucketPolicy("example",
vector_bucket_arn=example_aws_s3vectors_vector_bucket["arn"],
policy="""{
\"Version\": \"2012-10-17\",
\"Id\": \"writePolicy\",
\"Statement\": [{
\"Sid\": \"writeStatement\",
\"Effect\": \"Allow\",
\"Principal\": {
\"AWS\": \"123456789012\"
},
\"Action\": [
\"s3vectors:PutVectors\"
],
\"Resource\": \"*\"
}]
}
""")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.S3.VectorsVectorBucketPolicy("example", new()
{
VectorBucketArn = exampleAwsS3vectorsVectorBucket.Arn,
Policy = @"{
\""Version\"": \""2012-10-17\"",
\""Id\"": \""writePolicy\"",
\""Statement\"": [{
\""Sid\"": \""writeStatement\"",
\""Effect\"": \""Allow\"",
\""Principal\"": {
\""AWS\"": \""123456789012\""
},
\""Action\"": [
\""s3vectors:PutVectors\""
],
\""Resource\"": \""*\""
}]
}
",
});
});
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.NewVectorsVectorBucketPolicy(ctx, "example", &s3.VectorsVectorBucketPolicyArgs{
VectorBucketArn: pulumi.Any(exampleAwsS3vectorsVectorBucket.Arn),
Policy: pulumi.String(`{
\"Version\": \"2012-10-17\",
\"Id\": \"writePolicy\",
\"Statement\": [{
\"Sid\": \"writeStatement\",
\"Effect\": \"Allow\",
\"Principal\": {
\"AWS\": \"123456789012\"
},
\"Action\": [
\"s3vectors:PutVectors\"
],
\"Resource\": \"*\"
}]
}
`),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_s3_vectorsvectorbucketpolicy" "example" {
vector_bucket_arn = exampleAwsS3vectorsVectorBucket.arn
policy = "{\n \\\"Version\\\": \\\"2012-10-17\\\",\n \\\"Id\\\": \\\"writePolicy\\\",\n \\\"Statement\\\": [{\n \\\"Sid\\\": \\\"writeStatement\\\",\n \\\"Effect\\\": \\\"Allow\\\",\n \\\"Principal\\\": {\n \\\"AWS\\\": \\\"123456789012\\\"\n },\n \\\"Action\\\": [\n \\\"s3vectors:PutVectors\\\"\n ],\n \\\"Resource\\\": \\\"*\\\"\n }]\n}\n"
}
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());
}
}
resources:
example:
type: aws:s3:VectorsVectorBucketPolicy
properties:
vectorBucketArn: ${exampleAwsS3vectorsVectorBucket.arn}
policy: |
{
\"Version\": \"2012-10-17\",
\"Id\": \"writePolicy\",
\"Statement\": [{
\"Sid\": \"writeStatement\",
\"Effect\": \"Allow\",
\"Principal\": {
\"AWS\": \"123456789012\"
},
\"Action\": [
\"s3vectors:PutVectors\"
],
\"Resource\": \"*\"
}]
}
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:
$ pulumi import aws:s3/vectorsVectorBucketPolicy:VectorsVectorBucketPolicy example arn:aws:s3vectors:us-west-2:123456789012:bucket/example-bucket
Constructors
- VectorsVectorBucketPolicy(String name, {VectorsVectorBucketPolicyArgs? args, CustomResourceOptions? options})
-
Creates a new VectorsVectorBucketPolicy.
nameThe Pulumi resource name.argsArguments used to configure this VectorsVectorBucketPolicy. The set of arguments for VectorsVectorBucketPolicy.optionsResource options controlling this resource's behavior. - VectorsVectorBucketPolicy.reference(String urn)
- Creates a typed reference to an existing VectorsVectorBucketPolicy resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- 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
-
policy
↔ Output<
String> -
Policy document.
latefinal
-
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
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vectorBucketArn
↔ Output<
String> -
ARN 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, {VectorsVectorBucketPolicyState? state, CustomResourceOptions? options}) → VectorsVectorBucketPolicy -
Gets an existing VectorsVectorBucketPolicy resource's state with the given
nameandid.