1. Packages
  2. AWS Native
  3. API Docs
  4. s3express
  5. BucketPolicy

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.s3express.BucketPolicy

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    Resource Type definition for AWS::S3Express::BucketPolicy.

    Create BucketPolicy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new BucketPolicy(name: string, args: BucketPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def BucketPolicy(resource_name: str,
                     args: BucketPolicyArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def BucketPolicy(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     bucket: Optional[str] = None,
                     policy_document: Optional[Any] = None)
    func NewBucketPolicy(ctx *Context, name string, args BucketPolicyArgs, opts ...ResourceOption) (*BucketPolicy, error)
    public BucketPolicy(string name, BucketPolicyArgs args, CustomResourceOptions? opts = null)
    public BucketPolicy(String name, BucketPolicyArgs args)
    public BucketPolicy(String name, BucketPolicyArgs args, CustomResourceOptions options)
    
    type: aws-native:s3express:BucketPolicy
    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 BucketPolicyArgs
    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 BucketPolicyArgs
    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 BucketPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BucketPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BucketPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const aws_nativeBucketPolicyResource = new aws_native.s3express.BucketPolicy("aws-nativeBucketPolicyResource", {
        bucket: "string",
        policyDocument: "any",
    });
    
    Coming soon!
    

    BucketPolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The BucketPolicy resource accepts the following input properties:

    Bucket string
    The name of the S3 directory bucket to which the policy applies.
    PolicyDocument object

    A policy document containing permissions to add to the specified 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.

    Search the CloudFormation User Guide for AWS::S3Express::BucketPolicy for more information about the expected schema for this property.

    Bucket string
    The name of the S3 directory bucket to which the policy applies.
    PolicyDocument interface{}

    A policy document containing permissions to add to the specified 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.

    Search the CloudFormation User Guide for AWS::S3Express::BucketPolicy for more information about the expected schema for this property.

    bucket String
    The name of the S3 directory bucket to which the policy applies.
    policyDocument Object

    A policy document containing permissions to add to the specified 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.

    Search the CloudFormation User Guide for AWS::S3Express::BucketPolicy for more information about the expected schema for this property.

    bucket string
    The name of the S3 directory bucket to which the policy applies.
    policyDocument any

    A policy document containing permissions to add to the specified 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.

    Search the CloudFormation User Guide for AWS::S3Express::BucketPolicy for more information about the expected schema for this property.

    bucket str
    The name of the S3 directory bucket to which the policy applies.
    policy_document Any

    A policy document containing permissions to add to the specified 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.

    Search the CloudFormation User Guide for AWS::S3Express::BucketPolicy for more information about the expected schema for this property.

    bucket String
    The name of the S3 directory bucket to which the policy applies.
    policyDocument Any

    A policy document containing permissions to add to the specified 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.

    Search the CloudFormation User Guide for AWS::S3Express::BucketPolicy for more information about the expected schema for this property.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BucketPolicy 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
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi