1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. oss
  5. BucketLogging
Alibaba Cloud v3.55.2 published on Thursday, May 23, 2024 by Pulumi

alicloud.oss.BucketLogging

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.55.2 published on Thursday, May 23, 2024 by Pulumi

    Provides a OSS Bucket Logging resource. After you enable and configure logging for a bucket, Object Storage Service (OSS) generates log objects based on a predefined naming convention. This way, access logs are generated and stored in the specified bucket on an hourly basis.

    For information about OSS Bucket Logging and how to use it, see What is Bucket Logging.

    NOTE: Available since v1.222.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 defaultBucketLogging = new alicloud.oss.BucketLogging("default", {
        bucket: createBucket.bucket,
        targetBucket: createBucket.bucket,
        targetPrefix: "log/",
    });
    
    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_logging = alicloud.oss.BucketLogging("default",
        bucket=create_bucket.bucket,
        target_bucket=create_bucket.bucket,
        target_prefix="log/")
    
    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.NewBucketLogging(ctx, "default", &oss.BucketLoggingArgs{
    			Bucket:       createBucket.Bucket,
    			TargetBucket: createBucket.Bucket,
    			TargetPrefix: pulumi.String("log/"),
    		})
    		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 defaultBucketLogging = new AliCloud.Oss.BucketLogging("default", new()
        {
            Bucket = createBucket.BucketName,
            TargetBucket = createBucket.BucketName,
            TargetPrefix = "log/",
        });
    
    });
    
    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.BucketLogging;
    import com.pulumi.alicloud.oss.BucketLoggingArgs;
    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 defaultBucketLogging = new BucketLogging("defaultBucketLogging", BucketLoggingArgs.builder()        
                .bucket(createBucket.bucket())
                .targetBucket(createBucket.bucket())
                .targetPrefix("log/")
                .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}
      defaultBucketLogging:
        type: alicloud:oss:BucketLogging
        name: default
        properties:
          bucket: ${createBucket.bucket}
          targetBucket: ${createBucket.bucket}
          targetPrefix: log/
    

    Create BucketLogging Resource

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

    Constructor syntax

    new BucketLogging(name: string, args: BucketLoggingArgs, opts?: CustomResourceOptions);
    @overload
    def BucketLogging(resource_name: str,
                      args: BucketLoggingInitArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def BucketLogging(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      bucket: Optional[str] = None,
                      target_bucket: Optional[str] = None,
                      target_prefix: Optional[str] = None)
    func NewBucketLogging(ctx *Context, name string, args BucketLoggingArgs, opts ...ResourceOption) (*BucketLogging, error)
    public BucketLogging(string name, BucketLoggingArgs args, CustomResourceOptions? opts = null)
    public BucketLogging(String name, BucketLoggingArgs args)
    public BucketLogging(String name, BucketLoggingArgs args, CustomResourceOptions options)
    
    type: alicloud:oss:BucketLogging
    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 BucketLoggingArgs
    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 BucketLoggingInitArgs
    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 BucketLoggingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BucketLoggingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BucketLoggingArgs
    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 bucketLoggingResource = new AliCloud.Oss.BucketLogging("bucketLoggingResource", new()
    {
        Bucket = "string",
        TargetBucket = "string",
        TargetPrefix = "string",
    });
    
    example, err := oss.NewBucketLogging(ctx, "bucketLoggingResource", &oss.BucketLoggingArgs{
    	Bucket:       pulumi.String("string"),
    	TargetBucket: pulumi.String("string"),
    	TargetPrefix: pulumi.String("string"),
    })
    
    var bucketLoggingResource = new BucketLogging("bucketLoggingResource", BucketLoggingArgs.builder()        
        .bucket("string")
        .targetBucket("string")
        .targetPrefix("string")
        .build());
    
    bucket_logging_resource = alicloud.oss.BucketLogging("bucketLoggingResource",
        bucket="string",
        target_bucket="string",
        target_prefix="string")
    
    const bucketLoggingResource = new alicloud.oss.BucketLogging("bucketLoggingResource", {
        bucket: "string",
        targetBucket: "string",
        targetPrefix: "string",
    });
    
    type: alicloud:oss:BucketLogging
    properties:
        bucket: string
        targetBucket: string
        targetPrefix: string
    

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

    Bucket string
    The name of the bucket.
    TargetBucket string
    The bucket that stores access logs.
    TargetPrefix string
    The prefix of the saved log objects. This element can be left empty.
    Bucket string
    The name of the bucket.
    TargetBucket string
    The bucket that stores access logs.
    TargetPrefix string
    The prefix of the saved log objects. This element can be left empty.
    bucket String
    The name of the bucket.
    targetBucket String
    The bucket that stores access logs.
    targetPrefix String
    The prefix of the saved log objects. This element can be left empty.
    bucket string
    The name of the bucket.
    targetBucket string
    The bucket that stores access logs.
    targetPrefix string
    The prefix of the saved log objects. This element can be left empty.
    bucket str
    The name of the bucket.
    target_bucket str
    The bucket that stores access logs.
    target_prefix str
    The prefix of the saved log objects. This element can be left empty.
    bucket String
    The name of the bucket.
    targetBucket String
    The bucket that stores access logs.
    targetPrefix String
    The prefix of the saved log objects. This element can be left empty.

    Outputs

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

    Get an existing BucketLogging 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?: BucketLoggingState, opts?: CustomResourceOptions): BucketLogging
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bucket: Optional[str] = None,
            target_bucket: Optional[str] = None,
            target_prefix: Optional[str] = None) -> BucketLogging
    func GetBucketLogging(ctx *Context, name string, id IDInput, state *BucketLoggingState, opts ...ResourceOption) (*BucketLogging, error)
    public static BucketLogging Get(string name, Input<string> id, BucketLoggingState? state, CustomResourceOptions? opts = null)
    public static BucketLogging get(String name, Output<String> id, BucketLoggingState 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:
    Bucket string
    The name of the bucket.
    TargetBucket string
    The bucket that stores access logs.
    TargetPrefix string
    The prefix of the saved log objects. This element can be left empty.
    Bucket string
    The name of the bucket.
    TargetBucket string
    The bucket that stores access logs.
    TargetPrefix string
    The prefix of the saved log objects. This element can be left empty.
    bucket String
    The name of the bucket.
    targetBucket String
    The bucket that stores access logs.
    targetPrefix String
    The prefix of the saved log objects. This element can be left empty.
    bucket string
    The name of the bucket.
    targetBucket string
    The bucket that stores access logs.
    targetPrefix string
    The prefix of the saved log objects. This element can be left empty.
    bucket str
    The name of the bucket.
    target_bucket str
    The bucket that stores access logs.
    target_prefix str
    The prefix of the saved log objects. This element can be left empty.
    bucket String
    The name of the bucket.
    targetBucket String
    The bucket that stores access logs.
    targetPrefix String
    The prefix of the saved log objects. This element can be left empty.

    Import

    OSS Bucket Logging can be imported using the id, e.g.

    $ pulumi import alicloud:oss/bucketLogging:BucketLogging 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.55.2 published on Thursday, May 23, 2024 by Pulumi