1. Docs
2. Reference
3. API
4. @pulumi/aws
5. qldb

Module qldb

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

• Ledger

Functions

• getLedger

Others

• GetLedgerArgs
• GetLedgerResult
• LedgerArgs
• LedgerState

Resources

Resource Ledger

class Ledger extends CustomResource

Provides an AWS Quantum Ledger Database (QLDB) resource

NOTE: Deletion protection is enabled by default. To successfully delete this resource via this provider, deletionProtection = false must be applied before attempting deletion.

Example Usage

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

const sample_ledger = new aws.qldb.Ledger("sample-ledger", {});

constructor

new Ledger(name: string, args?: LedgerArgs, opts?: pulumi.CustomResourceOptions)

Create a Ledger resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: LedgerState, opts?: pulumi.CustomResourceOptions): Ledger

Get an existing Ledger resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Ledger

Returns true if the given object is an instance of Ledger. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the QLDB Ledger

property deletionProtection

public deletionProtection: pulumi.Output<boolean | undefined>;

The deletion protection for the QLDB Ledger instance. By default it is true. To delete this resource via this provider, this value must be configured to false and applied first before attempting deletion.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The friendly name for the QLDB Ledger instance. This is atuo generated by default.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value mapping of resource tags

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getLedger

getLedger(args: GetLedgerArgs, opts?: pulumi.InvokeOptions): Promise<GetLedgerResult>

Use this data source to fetch information about a Quantum Ledger Database.

Example Usage

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

const example = pulumi.output(aws.qldb.getLedger({
    name: "an_example_ledger",
}, { async: true }));

Others

interface GetLedgerArgs

interface GetLedgerArgs

A collection of arguments for invoking getLedger.

property name

name: string;

The friendly name of the ledger to match.

interface GetLedgerResult

interface GetLedgerResult

A collection of values returned by getLedger.

property arn

arn: string;

Amazon Resource Name (ARN) of the ledger.

property deletionProtection

deletionProtection: boolean;

Deletion protection on the QLDB Ledger instance. Set to true by default.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

interface LedgerArgs

interface LedgerArgs

The set of arguments for constructing a Ledger resource.

property deletionProtection

deletionProtection?: pulumi.Input<boolean>;

The deletion protection for the QLDB Ledger instance. By default it is true. To delete this resource via this provider, this value must be configured to false and applied first before attempting deletion.

property name

name?: pulumi.Input<string>;

The friendly name for the QLDB Ledger instance. This is atuo generated by default.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value mapping of resource tags

interface LedgerState

interface LedgerState

Input properties used for looking up and filtering Ledger resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the QLDB Ledger

property deletionProtection

deletionProtection?: pulumi.Input<boolean>;

The deletion protection for the QLDB Ledger instance. By default it is true. To delete this resource via this provider, this value must be configured to false and applied first before attempting deletion.

property name

name?: pulumi.Input<string>;

The friendly name for the QLDB Ledger instance. This is atuo generated by default.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value mapping of resource tags