Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. lightsail
  5. BucketAccessKey
AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws

aws.lightsail.BucketAccessKey

Explore with Pulumi AI

aws logo
AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws

    Manages a Lightsail bucket access key. Use this resource to create credentials that allow programmatic access to your Lightsail bucket via API requests.

    Example Usage

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

const example = new aws.lightsail.Bucket("example", {
    name: "example-bucket",
    bundleId: "small_1_0",
});
const exampleBucketAccessKey = new aws.lightsail.BucketAccessKey("example", {bucketName: example.id});

    import pulumi
import pulumi_aws as aws

example = aws.lightsail.Bucket("example",
    name="example-bucket",
    bundle_id="small_1_0")
example_bucket_access_key = aws.lightsail.BucketAccessKey("example", bucket_name=example.id)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lightsail"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := lightsail.NewBucket(ctx, "example", &lightsail.BucketArgs{
			Name:     pulumi.String("example-bucket"),
			BundleId: pulumi.String("small_1_0"),
		})
		if err != nil {
			return err
		}
		_, err = lightsail.NewBucketAccessKey(ctx, "example", &lightsail.BucketAccessKeyArgs{
			BucketName: example.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.LightSail.Bucket("example", new()
    {
        Name = "example-bucket",
        BundleId = "small_1_0",
    });

    var exampleBucketAccessKey = new Aws.LightSail.BucketAccessKey("example", new()
    {
        BucketName = example.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lightsail.Bucket;
import com.pulumi.aws.lightsail.BucketArgs;
import com.pulumi.aws.lightsail.BucketAccessKey;
import com.pulumi.aws.lightsail.BucketAccessKeyArgs;
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 example = new Bucket("example", BucketArgs.builder()
            .name("example-bucket")
            .bundleId("small_1_0")
            .build());

        var exampleBucketAccessKey = new BucketAccessKey("exampleBucketAccessKey", BucketAccessKeyArgs.builder()
            .bucketName(example.id())
            .build());

    }
}

    resources:
  example:
    type: aws:lightsail:Bucket
    properties:
      name: example-bucket
      bundleId: small_1_0
  exampleBucketAccessKey:
    type: aws:lightsail:BucketAccessKey
    name: example
    properties:
      bucketName: ${example.id}

    Create BucketAccessKey Resource

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

    Constructor syntax

    new BucketAccessKey(name: string, args: BucketAccessKeyArgs, opts?: CustomResourceOptions);
    @overload
def BucketAccessKey(resource_name: str,
                    args: BucketAccessKeyArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def BucketAccessKey(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    bucket_name: Optional[str] = None)
    func NewBucketAccessKey(ctx *Context, name string, args BucketAccessKeyArgs, opts ...ResourceOption) (*BucketAccessKey, error)
    public BucketAccessKey(string name, BucketAccessKeyArgs args, CustomResourceOptions? opts = null)
    public BucketAccessKey(String name, BucketAccessKeyArgs args)
public BucketAccessKey(String name, BucketAccessKeyArgs args, CustomResourceOptions options)

    type: aws:lightsail:BucketAccessKey
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 BucketAccessKeyArgs
    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 BucketAccessKeyArgs
    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 BucketAccessKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BucketAccessKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BucketAccessKeyArgs
    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 bucketAccessKeyResource = new Aws.LightSail.BucketAccessKey("bucketAccessKeyResource", new()
{
    BucketName = "string",
});

    example, err := lightsail.NewBucketAccessKey(ctx, "bucketAccessKeyResource", &lightsail.BucketAccessKeyArgs{
	BucketName: pulumi.String("string"),
})

    var bucketAccessKeyResource = new BucketAccessKey("bucketAccessKeyResource", BucketAccessKeyArgs.builder()
    .bucketName("string")
    .build());

    bucket_access_key_resource = aws.lightsail.BucketAccessKey("bucketAccessKeyResource", bucket_name="string")

    const bucketAccessKeyResource = new aws.lightsail.BucketAccessKey("bucketAccessKeyResource", {bucketName: "string"});

    type: aws:lightsail:BucketAccessKey
properties:
    bucketName: string

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

    BucketName string
    Name of the bucket that the access key will belong to and grant access to.
    BucketName string
    Name of the bucket that the access key will belong to and grant access to.
    bucketName String
    Name of the bucket that the access key will belong to and grant access to.
    bucketName string
    Name of the bucket that the access key will belong to and grant access to.
    bucket_name str
    Name of the bucket that the access key will belong to and grant access to.
    bucketName String
    Name of the bucket that the access key will belong to and grant access to.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BucketAccessKey resource produces the following output properties:

    AccessKeyId string
    Access key ID.
    CreatedAt string
    Date and time when the access key was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    SecretAccessKey string
    Secret access key used to sign requests. This attribute is not available for imported resources. Note that this will be written to the state file.
    Status string
    Status of the access key.
    AccessKeyId string
    Access key ID.
    CreatedAt string
    Date and time when the access key was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    SecretAccessKey string
    Secret access key used to sign requests. This attribute is not available for imported resources. Note that this will be written to the state file.
    Status string
    Status of the access key.
    accessKeyId String
    Access key ID.
    createdAt String
    Date and time when the access key was created.
    id String
    The provider-assigned unique ID for this managed resource.
    secretAccessKey String
    Secret access key used to sign requests. This attribute is not available for imported resources. Note that this will be written to the state file.
    status String
    Status of the access key.
    accessKeyId string
    Access key ID.
    createdAt string
    Date and time when the access key was created.
    id string
    The provider-assigned unique ID for this managed resource.
    secretAccessKey string
    Secret access key used to sign requests. This attribute is not available for imported resources. Note that this will be written to the state file.
    status string
    Status of the access key.
    access_key_id str
    Access key ID.
    created_at str
    Date and time when the access key was created.
    id str
    The provider-assigned unique ID for this managed resource.
    secret_access_key str
    Secret access key used to sign requests. This attribute is not available for imported resources. Note that this will be written to the state file.
    status str
    Status of the access key.
    accessKeyId String
    Access key ID.
    createdAt String
    Date and time when the access key was created.
    id String
    The provider-assigned unique ID for this managed resource.
    secretAccessKey String
    Secret access key used to sign requests. This attribute is not available for imported resources. Note that this will be written to the state file.
    status String
    Status of the access key.

    Look up Existing BucketAccessKey Resource

    Get an existing BucketAccessKey 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?: BucketAccessKeyState, opts?: CustomResourceOptions): BucketAccessKey
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_key_id: Optional[str] = None,
        bucket_name: Optional[str] = None,
        created_at: Optional[str] = None,
        secret_access_key: Optional[str] = None,
        status: Optional[str] = None) -> BucketAccessKey
    func GetBucketAccessKey(ctx *Context, name string, id IDInput, state *BucketAccessKeyState, opts ...ResourceOption) (*BucketAccessKey, error)
    public static BucketAccessKey Get(string name, Input<string> id, BucketAccessKeyState? state, CustomResourceOptions? opts = null)
    public static BucketAccessKey get(String name, Output<String> id, BucketAccessKeyState state, CustomResourceOptions options)
    resources:  _:    type: aws:lightsail:BucketAccessKey    get:      id: ${id}
    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:
    AccessKeyId string
    Access key ID.
    BucketName string
    Name of the bucket that the access key will belong to and grant access to.
    CreatedAt string
    Date and time when the access key was created.
    SecretAccessKey string
    Secret access key used to sign requests. This attribute is not available for imported resources. Note that this will be written to the state file.
    Status string
    Status of the access key.
    AccessKeyId string
    Access key ID.
    BucketName string
    Name of the bucket that the access key will belong to and grant access to.
    CreatedAt string
    Date and time when the access key was created.
    SecretAccessKey string
    Secret access key used to sign requests. This attribute is not available for imported resources. Note that this will be written to the state file.
    Status string
    Status of the access key.
    accessKeyId String
    Access key ID.
    bucketName String
    Name of the bucket that the access key will belong to and grant access to.
    createdAt String
    Date and time when the access key was created.
    secretAccessKey String
    Secret access key used to sign requests. This attribute is not available for imported resources. Note that this will be written to the state file.
    status String
    Status of the access key.
    accessKeyId string
    Access key ID.
    bucketName string
    Name of the bucket that the access key will belong to and grant access to.
    createdAt string
    Date and time when the access key was created.
    secretAccessKey string
    Secret access key used to sign requests. This attribute is not available for imported resources. Note that this will be written to the state file.
    status string
    Status of the access key.
    access_key_id str
    Access key ID.
    bucket_name str
    Name of the bucket that the access key will belong to and grant access to.
    created_at str
    Date and time when the access key was created.
    secret_access_key str
    Secret access key used to sign requests. This attribute is not available for imported resources. Note that this will be written to the state file.
    status str
    Status of the access key.
    accessKeyId String
    Access key ID.
    bucketName String
    Name of the bucket that the access key will belong to and grant access to.
    createdAt String
    Date and time when the access key was created.
    secretAccessKey String
    Secret access key used to sign requests. This attribute is not available for imported resources. Note that this will be written to the state file.
    status String
    Status of the access key.

    Import

    Using pulumi import, import aws_lightsail_bucket_access_key using the id attribute. For example:

    $ pulumi import aws:lightsail/bucketAccessKey:BucketAccessKey example example-bucket,AKIAIOSFODNN7EXAMPLE

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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi
    pulumi/pulumi-aws