We recommend new projects start with resources from the AWS provider.
aws-native.s3vectors.VectorBucketPolicy
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::S3Vectors::VectorBucketPolicy
Create VectorBucketPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VectorBucketPolicy(name: string, args: VectorBucketPolicyArgs, opts?: CustomResourceOptions);@overload
def VectorBucketPolicy(resource_name: str,
args: VectorBucketPolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def VectorBucketPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
policy: Optional[VectorBucketPolicyPolicyArgs] = None,
vector_bucket_arn: Optional[str] = None,
vector_bucket_name: Optional[str] = None)func NewVectorBucketPolicy(ctx *Context, name string, args VectorBucketPolicyArgs, opts ...ResourceOption) (*VectorBucketPolicy, error)public VectorBucketPolicy(string name, VectorBucketPolicyArgs args, CustomResourceOptions? opts = null)
public VectorBucketPolicy(String name, VectorBucketPolicyArgs args)
public VectorBucketPolicy(String name, VectorBucketPolicyArgs args, CustomResourceOptions options)
type: aws-native:s3vectors:VectorBucketPolicy
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 VectorBucketPolicyArgs
- 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 VectorBucketPolicyArgs
- 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 VectorBucketPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VectorBucketPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VectorBucketPolicyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
VectorBucketPolicy 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 VectorBucketPolicy resource accepts the following input properties:
- Policy
Pulumi.
Aws Native. S3Vectors. Inputs. Vector Bucket Policy Policy - A policy document containing permissions to add to the specified vector bucket. In IAM , you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM .
- Vector
Bucket stringArn - The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.
- Vector
Bucket stringName - The name of the S3 vector bucket to which the policy applies.
- Policy
Vector
Bucket Policy Policy Args - A policy document containing permissions to add to the specified vector bucket. In IAM , you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM .
- Vector
Bucket stringArn - The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.
- Vector
Bucket stringName - The name of the S3 vector bucket to which the policy applies.
- policy
Vector
Bucket Policy Policy - A policy document containing permissions to add to the specified vector bucket. In IAM , you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM .
- vector
Bucket StringArn - The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.
- vector
Bucket StringName - The name of the S3 vector bucket to which the policy applies.
- policy
Vector
Bucket Policy Policy - A policy document containing permissions to add to the specified vector bucket. In IAM , you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM .
- vector
Bucket stringArn - The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.
- vector
Bucket stringName - The name of the S3 vector bucket to which the policy applies.
- policy
Vector
Bucket Policy Policy Args - A policy document containing permissions to add to the specified vector bucket. In IAM , you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM .
- vector_
bucket_ strarn - The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.
- vector_
bucket_ strname - The name of the S3 vector bucket to which the policy applies.
- policy Property Map
- A policy document containing permissions to add to the specified vector bucket. In IAM , you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM .
- vector
Bucket StringArn - The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.
- vector
Bucket StringName - The name of the S3 vector bucket to which the policy applies.
Outputs
All input properties are implicitly available as output properties. Additionally, the VectorBucketPolicy resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
