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

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

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.

    Using getBucketPolicy

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBucketPolicy(args: GetBucketPolicyArgs, opts?: InvokeOptions): Promise<GetBucketPolicyResult>
    function getBucketPolicyOutput(args: GetBucketPolicyOutputArgs, opts?: InvokeOptions): Output<GetBucketPolicyResult>
    def get_bucket_policy(bucket: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetBucketPolicyResult
    def get_bucket_policy_output(bucket: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetBucketPolicyResult]
    func LookupBucketPolicy(ctx *Context, args *LookupBucketPolicyArgs, opts ...InvokeOption) (*LookupBucketPolicyResult, error)
    func LookupBucketPolicyOutput(ctx *Context, args *LookupBucketPolicyOutputArgs, opts ...InvokeOption) LookupBucketPolicyResultOutput

    > Note: This function is named LookupBucketPolicy in the Go SDK.

    public static class GetBucketPolicy 
    {
        public static Task<GetBucketPolicyResult> InvokeAsync(GetBucketPolicyArgs args, InvokeOptions? opts = null)
        public static Output<GetBucketPolicyResult> Invoke(GetBucketPolicyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBucketPolicyResult> getBucketPolicy(GetBucketPolicyArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:s3express:getBucketPolicy
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Bucket string
    The name of the S3 directory bucket to which the policy applies.
    Bucket string
    The name of the S3 directory bucket to which the policy applies.
    bucket String
    The name of the S3 directory bucket to which the policy applies.
    bucket string
    The name of the S3 directory bucket to which the policy applies.
    bucket str
    The name of the S3 directory bucket to which the policy applies.
    bucket String
    The name of the S3 directory bucket to which the policy applies.

    getBucketPolicy Result

    The following output properties are available:

    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.

    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.

    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.

    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.

    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.

    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.

    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