AWS Classic v5.34.0, Mar 30 23

aws.lightsail.BucketAccessKey

Provides a lightsail bucket access key. This is a set of credentials that allow API requests to be made to the lightsail bucket.

Create BucketAccessKey Resource

new BucketAccessKey(name: string, args: BucketAccessKeyArgs, opts?: CustomResourceOptions);

@overload
def BucketAccessKey(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    bucket_name: Optional[str] = None)
@overload
def BucketAccessKey(resource_name: str,
                    args: BucketAccessKeyArgs,
                    opts: Optional[ResourceOptions] = 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.

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.

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

The BucketAccessKey resource accepts the following input properties:

BucketName string: The name of the bucket that the new access key will belong to, and grant access to.

BucketName string: The name of the bucket that the new access key will belong to, and grant access to.

bucketName String: The name of the bucket that the new access key will belong to, and grant access to.

bucketName string: The name of the bucket that the new access key will belong to, and grant access to.

bucket_name str: The name of the bucket that the new access key will belong to, and grant access to.

bucketName String: The name of the bucket that the new 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: The ID of the access key.
CreatedAt string: The timestamp when the access key was created.
Id string: The provider-assigned unique ID for this managed resource.
SecretAccessKey string: The 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: The status of the access key.

AccessKeyId string: The ID of the access key.
CreatedAt string: The timestamp when the access key was created.
Id string: The provider-assigned unique ID for this managed resource.
SecretAccessKey string: The 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: The status of the access key.

accessKeyId String: The ID of the access key.
createdAt String: The timestamp when the access key was created.
id String: The provider-assigned unique ID for this managed resource.
secretAccessKey String: The 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: The status of the access key.

accessKeyId string: The ID of the access key.
createdAt string: The timestamp when the access key was created.
id string: The provider-assigned unique ID for this managed resource.
secretAccessKey string: The 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: The status of the access key.

access_key_id str: The ID of the access key.
created_at str: The timestamp when the access key was created.
id str: The provider-assigned unique ID for this managed resource.
secret_access_key str: The 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: The status of the access key.

accessKeyId String: The ID of the access key.
createdAt String: The timestamp when the access key was created.
id String: The provider-assigned unique ID for this managed resource.
secretAccessKey String: The 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: The 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)

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:

AccessKeyId string: The ID of the access key.
BucketName string: The name of the bucket that the new access key will belong to, and grant access to.
CreatedAt string: The timestamp when the access key was created.
SecretAccessKey string: The 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: The status of the access key.

AccessKeyId string: The ID of the access key.
BucketName string: The name of the bucket that the new access key will belong to, and grant access to.
CreatedAt string: The timestamp when the access key was created.
SecretAccessKey string: The 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: The status of the access key.

accessKeyId String: The ID of the access key.
bucketName String: The name of the bucket that the new access key will belong to, and grant access to.
createdAt String: The timestamp when the access key was created.
secretAccessKey String: The 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: The status of the access key.

accessKeyId string: The ID of the access key.
bucketName string: The name of the bucket that the new access key will belong to, and grant access to.
createdAt string: The timestamp when the access key was created.
secretAccessKey string: The 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: The status of the access key.

access_key_id str: The ID of the access key.
bucket_name str: The name of the bucket that the new access key will belong to, and grant access to.
created_at str: The timestamp when the access key was created.
secret_access_key str: The 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: The status of the access key.

accessKeyId String: The ID of the access key.
bucketName String: The name of the bucket that the new access key will belong to, and grant access to.
createdAt String: The timestamp when the access key was created.
secretAccessKey String: The 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: The status of the access key.

Import

aws_lightsail_bucket_access_key can be imported by using the id attribute, e.g.,

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

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.