volcengine.tos.BucketPolicy
Explore with Pulumi AI
Provides a resource to manage tos bucket policy
Example Usage
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Volcengine = Pulumi.Volcengine;
return await Deployment.RunAsync(() =>
{
var @default = new Volcengine.Tos.BucketPolicy("default", new()
{
BucketName = "tf-acc-test-bucket",
Policy = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["Statement"] = new[]
{
new Dictionary<string, object?>
{
["Sid"] = "test",
["Effect"] = "Allow",
["Principal"] = new[]
{
"AccountId/subUserName",
},
["Action"] = new[]
{
"tos:List*",
},
["Resource"] = new[]
{
"trn:tos:::tf-acc-test-bucket",
},
},
},
}),
});
});
package main
import (
"encoding/json"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/tos"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
tmpJSON0, err := json.Marshal(map[string]interface{}{
"Statement": []map[string]interface{}{
map[string]interface{}{
"Sid": "test",
"Effect": "Allow",
"Principal": []string{
"AccountId/subUserName",
},
"Action": []string{
"tos:List*",
},
"Resource": []string{
"trn:tos:::tf-acc-test-bucket",
},
},
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = tos.NewBucketPolicy(ctx, "default", &tos.BucketPolicyArgs{
BucketName: pulumi.String("tf-acc-test-bucket"),
Policy: pulumi.String(json0),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.tos.BucketPolicy;
import com.pulumi.volcengine.tos.BucketPolicyArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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) {
var default_ = new BucketPolicy("default", BucketPolicyArgs.builder()
.bucketName("tf-acc-test-bucket")
.policy(serializeJson(
jsonObject(
jsonProperty("Statement", jsonArray(jsonObject(
jsonProperty("Sid", "test"),
jsonProperty("Effect", "Allow"),
jsonProperty("Principal", jsonArray("AccountId/subUserName")),
jsonProperty("Action", jsonArray("tos:List*")),
jsonProperty("Resource", jsonArray("trn:tos:::tf-acc-test-bucket"))
)))
)))
.build());
}
}
import pulumi
import json
import pulumi_volcengine as volcengine
default = volcengine.tos.BucketPolicy("default",
bucket_name="tf-acc-test-bucket",
policy=json.dumps({
"Statement": [{
"Sid": "test",
"Effect": "Allow",
"Principal": ["AccountId/subUserName"],
"Action": ["tos:List*"],
"Resource": ["trn:tos:::tf-acc-test-bucket"],
}],
}))
import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@volcengine/pulumi";
const _default = new volcengine.tos.BucketPolicy("default", {
bucketName: "tf-acc-test-bucket",
policy: JSON.stringify({
Statement: [{
Sid: "test",
Effect: "Allow",
Principal: ["AccountId/subUserName"],
Action: ["tos:List*"],
Resource: ["trn:tos:::tf-acc-test-bucket"],
}],
}),
});
resources:
default:
type: volcengine:tos:BucketPolicy
properties:
bucketName: tf-acc-test-bucket
policy:
fn::toJSON:
Statement:
- Sid: test
Effect: Allow
Principal:
- AccountId/subUserName
Action:
- tos:List*
Resource:
- trn:tos:::tf-acc-test-bucket
Create BucketPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BucketPolicy(name: string, args: BucketPolicyArgs, opts?: CustomResourceOptions);
@overload
def BucketPolicy(resource_name: str,
args: BucketPolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def BucketPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
bucket_name: Optional[str] = None,
policy: Optional[str] = None)
func NewBucketPolicy(ctx *Context, name string, args BucketPolicyArgs, opts ...ResourceOption) (*BucketPolicy, error)
public BucketPolicy(string name, BucketPolicyArgs args, CustomResourceOptions? opts = null)
public BucketPolicy(String name, BucketPolicyArgs args)
public BucketPolicy(String name, BucketPolicyArgs args, CustomResourceOptions options)
type: volcengine:tos:BucketPolicy
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 BucketPolicyArgs
- 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 BucketPolicyArgs
- 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 BucketPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BucketPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BucketPolicyArgs
- 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 bucketPolicyResource = new Volcengine.Tos.BucketPolicy("bucketPolicyResource", new()
{
BucketName = "string",
Policy = "string",
});
example, err := tos.NewBucketPolicy(ctx, "bucketPolicyResource", &tos.BucketPolicyArgs{
BucketName: pulumi.String("string"),
Policy: pulumi.String("string"),
})
var bucketPolicyResource = new BucketPolicy("bucketPolicyResource", BucketPolicyArgs.builder()
.bucketName("string")
.policy("string")
.build());
bucket_policy_resource = volcengine.tos.BucketPolicy("bucketPolicyResource",
bucket_name="string",
policy="string")
const bucketPolicyResource = new volcengine.tos.BucketPolicy("bucketPolicyResource", {
bucketName: "string",
policy: "string",
});
type: volcengine:tos:BucketPolicy
properties:
bucketName: string
policy: string
BucketPolicy 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 BucketPolicy resource accepts the following input properties:
- Bucket
Name string - The name of the bucket.
- Policy string
- The policy document. This is a JSON formatted string. For more information about building Volcengine IAM policy documents with Terraform, see the Volcengine IAM Policy Document Guide.
- Bucket
Name string - The name of the bucket.
- Policy string
- The policy document. This is a JSON formatted string. For more information about building Volcengine IAM policy documents with Terraform, see the Volcengine IAM Policy Document Guide.
- bucket
Name String - The name of the bucket.
- policy String
- The policy document. This is a JSON formatted string. For more information about building Volcengine IAM policy documents with Terraform, see the Volcengine IAM Policy Document Guide.
- bucket
Name string - The name of the bucket.
- policy string
- The policy document. This is a JSON formatted string. For more information about building Volcengine IAM policy documents with Terraform, see the Volcengine IAM Policy Document Guide.
- bucket_
name str - The name of the bucket.
- policy str
- The policy document. This is a JSON formatted string. For more information about building Volcengine IAM policy documents with Terraform, see the Volcengine IAM Policy Document Guide.
- bucket
Name String - The name of the bucket.
- policy String
- The policy document. This is a JSON formatted string. For more information about building Volcengine IAM policy documents with Terraform, see the Volcengine IAM Policy Document Guide.
Outputs
All input properties are implicitly available as output properties. Additionally, the BucketPolicy 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 BucketPolicy Resource
Get an existing BucketPolicy 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?: BucketPolicyState, opts?: CustomResourceOptions): BucketPolicy
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
bucket_name: Optional[str] = None,
policy: Optional[str] = None) -> BucketPolicy
func GetBucketPolicy(ctx *Context, name string, id IDInput, state *BucketPolicyState, opts ...ResourceOption) (*BucketPolicy, error)
public static BucketPolicy Get(string name, Input<string> id, BucketPolicyState? state, CustomResourceOptions? opts = null)
public static BucketPolicy get(String name, Output<String> id, BucketPolicyState 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
Name string - The name of the bucket.
- Policy string
- The policy document. This is a JSON formatted string. For more information about building Volcengine IAM policy documents with Terraform, see the Volcengine IAM Policy Document Guide.
- Bucket
Name string - The name of the bucket.
- Policy string
- The policy document. This is a JSON formatted string. For more information about building Volcengine IAM policy documents with Terraform, see the Volcengine IAM Policy Document Guide.
- bucket
Name String - The name of the bucket.
- policy String
- The policy document. This is a JSON formatted string. For more information about building Volcengine IAM policy documents with Terraform, see the Volcengine IAM Policy Document Guide.
- bucket
Name string - The name of the bucket.
- policy string
- The policy document. This is a JSON formatted string. For more information about building Volcengine IAM policy documents with Terraform, see the Volcengine IAM Policy Document Guide.
- bucket_
name str - The name of the bucket.
- policy str
- The policy document. This is a JSON formatted string. For more information about building Volcengine IAM policy documents with Terraform, see the Volcengine IAM Policy Document Guide.
- bucket
Name String - The name of the bucket.
- policy String
- The policy document. This is a JSON formatted string. For more information about building Volcengine IAM policy documents with Terraform, see the Volcengine IAM Policy Document Guide.
Import
Tos Bucket can be imported using the id, e.g.
$ pulumi import volcengine:tos/bucketPolicy:BucketPolicy default bucketName:policy
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- volcengine volcengine/pulumi-volcengine
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
volcengine
Terraform Provider.