alicloud.oss.BucketUserDefinedLogFields
Explore with Pulumi AI
Provides a OSS Bucket User Defined Log Fields resource. Used to personalize the user_defined_log_fields field in the Bucket real-time log.
For information about OSS Bucket User Defined Log Fields and how to use it, see What is Bucket User Defined Log Fields.
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 defaultBucketUserDefinedLogFields = new alicloud.oss.BucketUserDefinedLogFields("default", {
bucket: createBucket.bucket,
paramSets: [
"oss-example",
"example-para",
"abc",
],
headerSets: [
"def",
"example-header",
],
});
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_user_defined_log_fields = alicloud.oss.BucketUserDefinedLogFields("default",
bucket=create_bucket.bucket,
param_sets=[
"oss-example",
"example-para",
"abc",
],
header_sets=[
"def",
"example-header",
])
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.Sprintf("%v-%v", name, _default.Result),
})
if err != nil {
return err
}
_, err = oss.NewBucketUserDefinedLogFields(ctx, "default", &oss.BucketUserDefinedLogFieldsArgs{
Bucket: createBucket.Bucket,
ParamSets: pulumi.StringArray{
pulumi.String("oss-example"),
pulumi.String("example-para"),
pulumi.String("abc"),
},
HeaderSets: pulumi.StringArray{
pulumi.String("def"),
pulumi.String("example-header"),
},
})
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 defaultBucketUserDefinedLogFields = new AliCloud.Oss.BucketUserDefinedLogFields("default", new()
{
Bucket = createBucket.BucketName,
ParamSets = new[]
{
"oss-example",
"example-para",
"abc",
},
HeaderSets = new[]
{
"def",
"example-header",
},
});
});
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.BucketUserDefinedLogFields;
import com.pulumi.alicloud.oss.BucketUserDefinedLogFieldsArgs;
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 defaultBucketUserDefinedLogFields = new BucketUserDefinedLogFields("defaultBucketUserDefinedLogFields", BucketUserDefinedLogFieldsArgs.builder()
.bucket(createBucket.bucket())
.paramSets(
"oss-example",
"example-para",
"abc")
.headerSets(
"def",
"example-header")
.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}
defaultBucketUserDefinedLogFields:
type: alicloud:oss:BucketUserDefinedLogFields
name: default
properties:
bucket: ${createBucket.bucket}
paramSets:
- oss-example
- example-para
- abc
headerSets:
- def
- example-header
Create BucketUserDefinedLogFields Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BucketUserDefinedLogFields(name: string, args: BucketUserDefinedLogFieldsArgs, opts?: CustomResourceOptions);
@overload
def BucketUserDefinedLogFields(resource_name: str,
args: BucketUserDefinedLogFieldsArgs,
opts: Optional[ResourceOptions] = None)
@overload
def BucketUserDefinedLogFields(resource_name: str,
opts: Optional[ResourceOptions] = None,
bucket: Optional[str] = None,
header_sets: Optional[Sequence[str]] = None,
param_sets: Optional[Sequence[str]] = None)
func NewBucketUserDefinedLogFields(ctx *Context, name string, args BucketUserDefinedLogFieldsArgs, opts ...ResourceOption) (*BucketUserDefinedLogFields, error)
public BucketUserDefinedLogFields(string name, BucketUserDefinedLogFieldsArgs args, CustomResourceOptions? opts = null)
public BucketUserDefinedLogFields(String name, BucketUserDefinedLogFieldsArgs args)
public BucketUserDefinedLogFields(String name, BucketUserDefinedLogFieldsArgs args, CustomResourceOptions options)
type: alicloud:oss:BucketUserDefinedLogFields
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 BucketUserDefinedLogFieldsArgs
- 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 BucketUserDefinedLogFieldsArgs
- 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 BucketUserDefinedLogFieldsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BucketUserDefinedLogFieldsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BucketUserDefinedLogFieldsArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var bucketUserDefinedLogFieldsResource = new AliCloud.Oss.BucketUserDefinedLogFields("bucketUserDefinedLogFieldsResource", new()
{
Bucket = "string",
HeaderSets = new[]
{
"string",
},
ParamSets = new[]
{
"string",
},
});
example, err := oss.NewBucketUserDefinedLogFields(ctx, "bucketUserDefinedLogFieldsResource", &oss.BucketUserDefinedLogFieldsArgs{
Bucket: pulumi.String("string"),
HeaderSets: pulumi.StringArray{
pulumi.String("string"),
},
ParamSets: pulumi.StringArray{
pulumi.String("string"),
},
})
var bucketUserDefinedLogFieldsResource = new BucketUserDefinedLogFields("bucketUserDefinedLogFieldsResource", BucketUserDefinedLogFieldsArgs.builder()
.bucket("string")
.headerSets("string")
.paramSets("string")
.build());
bucket_user_defined_log_fields_resource = alicloud.oss.BucketUserDefinedLogFields("bucketUserDefinedLogFieldsResource",
bucket="string",
header_sets=["string"],
param_sets=["string"])
const bucketUserDefinedLogFieldsResource = new alicloud.oss.BucketUserDefinedLogFields("bucketUserDefinedLogFieldsResource", {
bucket: "string",
headerSets: ["string"],
paramSets: ["string"],
});
type: alicloud:oss:BucketUserDefinedLogFields
properties:
bucket: string
headerSets:
- string
paramSets:
- string
BucketUserDefinedLogFields Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The BucketUserDefinedLogFields resource accepts the following input properties:
- Bucket string
- The name of the bucket.
- Header
Sets List<string> - Container for custom request header configuration information.
- Param
Sets List<string> - Container for custom request parameters configuration information.
- Bucket string
- The name of the bucket.
- Header
Sets []string - Container for custom request header configuration information.
- Param
Sets []string - Container for custom request parameters configuration information.
- bucket String
- The name of the bucket.
- header
Sets List<String> - Container for custom request header configuration information.
- param
Sets List<String> - Container for custom request parameters configuration information.
- bucket string
- The name of the bucket.
- header
Sets string[] - Container for custom request header configuration information.
- param
Sets string[] - Container for custom request parameters configuration information.
- bucket str
- The name of the bucket.
- header_
sets Sequence[str] - Container for custom request header configuration information.
- param_
sets Sequence[str] - Container for custom request parameters configuration information.
- bucket String
- The name of the bucket.
- header
Sets List<String> - Container for custom request header configuration information.
- param
Sets List<String> - Container for custom request parameters configuration information.
Outputs
All input properties are implicitly available as output properties. Additionally, the BucketUserDefinedLogFields 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 BucketUserDefinedLogFields Resource
Get an existing BucketUserDefinedLogFields 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?: BucketUserDefinedLogFieldsState, opts?: CustomResourceOptions): BucketUserDefinedLogFields
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
bucket: Optional[str] = None,
header_sets: Optional[Sequence[str]] = None,
param_sets: Optional[Sequence[str]] = None) -> BucketUserDefinedLogFields
func GetBucketUserDefinedLogFields(ctx *Context, name string, id IDInput, state *BucketUserDefinedLogFieldsState, opts ...ResourceOption) (*BucketUserDefinedLogFields, error)
public static BucketUserDefinedLogFields Get(string name, Input<string> id, BucketUserDefinedLogFieldsState? state, CustomResourceOptions? opts = null)
public static BucketUserDefinedLogFields get(String name, Output<String> id, BucketUserDefinedLogFieldsState 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.
- Bucket string
- The name of the bucket.
- Header
Sets List<string> - Container for custom request header configuration information.
- Param
Sets List<string> - Container for custom request parameters configuration information.
- Bucket string
- The name of the bucket.
- Header
Sets []string - Container for custom request header configuration information.
- Param
Sets []string - Container for custom request parameters configuration information.
- bucket String
- The name of the bucket.
- header
Sets List<String> - Container for custom request header configuration information.
- param
Sets List<String> - Container for custom request parameters configuration information.
- bucket string
- The name of the bucket.
- header
Sets string[] - Container for custom request header configuration information.
- param
Sets string[] - Container for custom request parameters configuration information.
- bucket str
- The name of the bucket.
- header_
sets Sequence[str] - Container for custom request header configuration information.
- param_
sets Sequence[str] - Container for custom request parameters configuration information.
- bucket String
- The name of the bucket.
- header
Sets List<String> - Container for custom request header configuration information.
- param
Sets List<String> - Container for custom request parameters configuration information.
Import
OSS Bucket User Defined Log Fields can be imported using the id, e.g.
$ pulumi import alicloud:oss/bucketUserDefinedLogFields:BucketUserDefinedLogFields 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.