1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. oss
  5. BucketPublicAccessBlock
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

alicloud.oss.BucketPublicAccessBlock

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

    Provides a OSS Bucket Public Access Block resource. Blocking public access at the bucket-level.

    For information about OSS Bucket Public Access Block and how to use it, see What is Bucket Public Access Block.

    NOTE: Available since v1.224.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    import * as random from "@pulumi/random";
    
    const config = new pulumi.Config();
    const name = config.get("name") || "terraform-example";
    const _default = new random.index.Integer("default", {
        min: 10000,
        max: 99999,
    });
    const createBucket = new alicloud.oss.Bucket("CreateBucket", {
        storageClass: "Standard",
        bucket: `${name}-${_default.result}`,
    });
    const defaultBucketPublicAccessBlock = new alicloud.oss.BucketPublicAccessBlock("default", {
        bucket: createBucket.bucket,
        blockPublicAccess: true,
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    import pulumi_random as random
    
    config = pulumi.Config()
    name = config.get("name")
    if name is None:
        name = "terraform-example"
    default = random.index.Integer("default",
        min=10000,
        max=99999)
    create_bucket = alicloud.oss.Bucket("CreateBucket",
        storage_class="Standard",
        bucket=f"{name}-{default['result']}")
    default_bucket_public_access_block = alicloud.oss.BucketPublicAccessBlock("default",
        bucket=create_bucket.bucket,
        block_public_access=True)
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/oss"
    	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		name := "terraform-example"
    		if param := cfg.Get("name"); param != "" {
    			name = param
    		}
    		_, err := random.NewInteger(ctx, "default", &random.IntegerArgs{
    			Min: 10000,
    			Max: 99999,
    		})
    		if err != nil {
    			return err
    		}
    		createBucket, err := oss.NewBucket(ctx, "CreateBucket", &oss.BucketArgs{
    			StorageClass: pulumi.String("Standard"),
    			Bucket:       pulumi.String(fmt.Sprintf("%v-%v", name, _default.Result)),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = oss.NewBucketPublicAccessBlock(ctx, "default", &oss.BucketPublicAccessBlockArgs{
    			Bucket:            createBucket.Bucket,
    			BlockPublicAccess: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    using Random = Pulumi.Random;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var name = config.Get("name") ?? "terraform-example";
        var @default = new Random.Index.Integer("default", new()
        {
            Min = 10000,
            Max = 99999,
        });
    
        var createBucket = new AliCloud.Oss.Bucket("CreateBucket", new()
        {
            StorageClass = "Standard",
            BucketName = $"{name}-{@default.Result}",
        });
    
        var defaultBucketPublicAccessBlock = new AliCloud.Oss.BucketPublicAccessBlock("default", new()
        {
            Bucket = createBucket.BucketName,
            BlockPublicAccess = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.random.integer;
    import com.pulumi.random.IntegerArgs;
    import com.pulumi.alicloud.oss.Bucket;
    import com.pulumi.alicloud.oss.BucketArgs;
    import com.pulumi.alicloud.oss.BucketPublicAccessBlock;
    import com.pulumi.alicloud.oss.BucketPublicAccessBlockArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 config = ctx.config();
            final var name = config.get("name").orElse("terraform-example");
            var default_ = new Integer("default", IntegerArgs.builder()
                .min(10000)
                .max(99999)
                .build());
    
            var createBucket = new Bucket("createBucket", BucketArgs.builder()
                .storageClass("Standard")
                .bucket(String.format("%s-%s", name,default_.result()))
                .build());
    
            var defaultBucketPublicAccessBlock = new BucketPublicAccessBlock("defaultBucketPublicAccessBlock", BucketPublicAccessBlockArgs.builder()
                .bucket(createBucket.bucket())
                .blockPublicAccess(true)
                .build());
    
        }
    }
    
    configuration:
      name:
        type: string
        default: terraform-example
    resources:
      default:
        type: random:integer
        properties:
          min: 10000
          max: 99999
      createBucket:
        type: alicloud:oss:Bucket
        name: CreateBucket
        properties:
          storageClass: Standard
          bucket: ${name}-${default.result}
      defaultBucketPublicAccessBlock:
        type: alicloud:oss:BucketPublicAccessBlock
        name: default
        properties:
          bucket: ${createBucket.bucket}
          blockPublicAccess: true
    

    Create BucketPublicAccessBlock Resource

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

    Constructor syntax

    new BucketPublicAccessBlock(name: string, args: BucketPublicAccessBlockArgs, opts?: CustomResourceOptions);
    @overload
    def BucketPublicAccessBlock(resource_name: str,
                                args: BucketPublicAccessBlockArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def BucketPublicAccessBlock(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                block_public_access: Optional[bool] = None,
                                bucket: Optional[str] = None)
    func NewBucketPublicAccessBlock(ctx *Context, name string, args BucketPublicAccessBlockArgs, opts ...ResourceOption) (*BucketPublicAccessBlock, error)
    public BucketPublicAccessBlock(string name, BucketPublicAccessBlockArgs args, CustomResourceOptions? opts = null)
    public BucketPublicAccessBlock(String name, BucketPublicAccessBlockArgs args)
    public BucketPublicAccessBlock(String name, BucketPublicAccessBlockArgs args, CustomResourceOptions options)
    
    type: alicloud:oss:BucketPublicAccessBlock
    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 BucketPublicAccessBlockArgs
    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 BucketPublicAccessBlockArgs
    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 BucketPublicAccessBlockArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BucketPublicAccessBlockArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BucketPublicAccessBlockArgs
    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.

    var bucketPublicAccessBlockResource = new AliCloud.Oss.BucketPublicAccessBlock("bucketPublicAccessBlockResource", new()
    {
        BlockPublicAccess = false,
        Bucket = "string",
    });
    
    example, err := oss.NewBucketPublicAccessBlock(ctx, "bucketPublicAccessBlockResource", &oss.BucketPublicAccessBlockArgs{
    	BlockPublicAccess: pulumi.Bool(false),
    	Bucket:            pulumi.String("string"),
    })
    
    var bucketPublicAccessBlockResource = new BucketPublicAccessBlock("bucketPublicAccessBlockResource", BucketPublicAccessBlockArgs.builder()
        .blockPublicAccess(false)
        .bucket("string")
        .build());
    
    bucket_public_access_block_resource = alicloud.oss.BucketPublicAccessBlock("bucketPublicAccessBlockResource",
        block_public_access=False,
        bucket="string")
    
    const bucketPublicAccessBlockResource = new alicloud.oss.BucketPublicAccessBlock("bucketPublicAccessBlockResource", {
        blockPublicAccess: false,
        bucket: "string",
    });
    
    type: alicloud:oss:BucketPublicAccessBlock
    properties:
        blockPublicAccess: false
        bucket: string
    

    BucketPublicAccessBlock 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 BucketPublicAccessBlock resource accepts the following input properties:

    BlockPublicAccess bool
    Whether AlibabaCloud OSS should block public bucket policies and ACL for this bucket.
    Bucket string
    The name of the bucket.
    BlockPublicAccess bool
    Whether AlibabaCloud OSS should block public bucket policies and ACL for this bucket.
    Bucket string
    The name of the bucket.
    blockPublicAccess Boolean
    Whether AlibabaCloud OSS should block public bucket policies and ACL for this bucket.
    bucket String
    The name of the bucket.
    blockPublicAccess boolean
    Whether AlibabaCloud OSS should block public bucket policies and ACL for this bucket.
    bucket string
    The name of the bucket.
    block_public_access bool
    Whether AlibabaCloud OSS should block public bucket policies and ACL for this bucket.
    bucket str
    The name of the bucket.
    blockPublicAccess Boolean
    Whether AlibabaCloud OSS should block public bucket policies and ACL for this bucket.
    bucket String
    The name of the bucket.

    Outputs

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

    Look up Existing BucketPublicAccessBlock Resource

    Get an existing BucketPublicAccessBlock resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BucketPublicAccessBlockState, opts?: CustomResourceOptions): BucketPublicAccessBlock
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            block_public_access: Optional[bool] = None,
            bucket: Optional[str] = None) -> BucketPublicAccessBlock
    func GetBucketPublicAccessBlock(ctx *Context, name string, id IDInput, state *BucketPublicAccessBlockState, opts ...ResourceOption) (*BucketPublicAccessBlock, error)
    public static BucketPublicAccessBlock Get(string name, Input<string> id, BucketPublicAccessBlockState? state, CustomResourceOptions? opts = null)
    public static BucketPublicAccessBlock get(String name, Output<String> id, BucketPublicAccessBlockState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BlockPublicAccess bool
    Whether AlibabaCloud OSS should block public bucket policies and ACL for this bucket.
    Bucket string
    The name of the bucket.
    BlockPublicAccess bool
    Whether AlibabaCloud OSS should block public bucket policies and ACL for this bucket.
    Bucket string
    The name of the bucket.
    blockPublicAccess Boolean
    Whether AlibabaCloud OSS should block public bucket policies and ACL for this bucket.
    bucket String
    The name of the bucket.
    blockPublicAccess boolean
    Whether AlibabaCloud OSS should block public bucket policies and ACL for this bucket.
    bucket string
    The name of the bucket.
    block_public_access bool
    Whether AlibabaCloud OSS should block public bucket policies and ACL for this bucket.
    bucket str
    The name of the bucket.
    blockPublicAccess Boolean
    Whether AlibabaCloud OSS should block public bucket policies and ACL for this bucket.
    bucket String
    The name of the bucket.

    Import

    OSS Bucket Public Access Block can be imported using the id, e.g.

    $ pulumi import alicloud:oss/bucketPublicAccessBlock:BucketPublicAccessBlock example <id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi