BucketAccessKey class

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)
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 main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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().ToIDOutput().ToStringOutput(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_lightsail_bucket" "example" {
  name      = "example-bucket"
  bundle_id = "small_1_0"
}
resource "aws_lightsail_bucketaccesskey" "example" {
  bucket_name = aws_lightsail_bucket.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.ArrayList;
import java.util.Arrays;
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}

Import

Using pulumi import, import aws.lightsail.BucketAccessKey using the id attribute. For example:

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

Constructors

BucketAccessKey(String name, {BucketAccessKeyArgs? args, CustomResourceOptions? options})
Creates a new BucketAccessKey. name The Pulumi resource name. args Arguments used to configure this BucketAccessKey. The set of arguments for BucketAccessKey. options Resource options controlling this resource's behavior.
BucketAccessKey.reference(String urn)
Creates a typed reference to an existing BucketAccessKey resource.

Properties

accessKeyId ↔ Output<String>
Access key ID.
latefinal
bucketName ↔ Output<String>
Name of the bucket that the access key will belong to and grant access to.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createdAt ↔ Output<String>
Date and time when the access key was created.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secretAccessKey ↔ Output<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.
latefinal
status ↔ Output<String>
Status of the access key.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {BucketAccessKeyState? state, CustomResourceOptions? options}) → BucketAccessKey
Gets an existing BucketAccessKey resource's state with the given name and id.