getBucketPolicy function

Future<GetBucketPolicyResult> getBucketPolicy(
  1. GetBucketPolicyArgs args, {
  2. InvokeOptions? options,
})

The bucket policy data source returns IAM policy of an S3 bucket.

Example Usage

The following example retrieves IAM policy of a specified S3 bucket.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.s3.getBucketPolicy({
    bucket: "example-bucket-name",
});
export const foo = example.then(example => example.policy);
import pulumi
import pulumi_aws as aws

example = aws.s3.get_bucket_policy(bucket="example-bucket-name")
pulumi.export("foo", example.policy)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = Aws.S3.GetBucketPolicy.Invoke(new()
    {
        Bucket = "example-bucket-name",
    });

    return new Dictionary<string, object?>
    {
        ["foo"] = example.Apply(getBucketPolicyResult => getBucketPolicyResult.Policy),
    };
});
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 {
		example, err := s3.LookupBucketPolicy(ctx, &s3.LookupBucketPolicyArgs{
			Bucket: "example-bucket-name",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("foo", example.Policy)
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_s3_getbucketpolicy" "example" {
  bucket = "example-bucket-name"
}

output "foo" {
  value = data.aws_s3_getbucketpolicy.example.policy
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.S3Functions;
import com.pulumi.aws.s3.inputs.GetBucketPolicyArgs;
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) {
        final var example = S3Functions.getBucketPolicy(GetBucketPolicyArgs.builder()
            .bucket("example-bucket-name")
            .build());

        ctx.export("foo", example.policy());
    }
}
variables:
  example:
    fn::invoke:
      function: aws:s3:getBucketPolicy
      arguments:
        bucket: example-bucket-name
outputs:
  foo: ${example.policy}

args Arguments passed to this invoke. Arguments for getBucketPolicy. options Invoke options controlling this call.

Implementation

Future<GetBucketPolicyResult> getBucketPolicy(
  GetBucketPolicyArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'aws:s3/getBucketPolicy:getBucketPolicy',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetBucketPolicyResult.fromMap(result);
}