Ledger class

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", {
    name: "sample-ledger",
    permissionsMode: "STANDARD",
});
import pulumi
import pulumi_aws as aws

sample_ledger = aws.qldb.Ledger("sample-ledger",
    name="sample-ledger",
    permissions_mode="STANDARD")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var sample_ledger = new Aws.Qldb.Ledger("sample-ledger", new()
    {
        Name = "sample-ledger",
        PermissionsMode = "STANDARD",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/qldb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := qldb.NewLedger(ctx, "sample-ledger", &qldb.LedgerArgs{
			Name:            pulumi.String("sample-ledger"),
			PermissionsMode: pulumi.String("STANDARD"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_qldb_ledger" "sample-ledger" {
  name             = "sample-ledger"
  permissions_mode = "STANDARD"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.qldb.Ledger;
import com.pulumi.aws.qldb.LedgerArgs;
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 sample_ledger = new Ledger("sample-ledger", LedgerArgs.builder()
            .name("sample-ledger")
            .permissionsMode("STANDARD")
            .build());

    }
}
resources:
  sample-ledger:
    type: aws:qldb:Ledger
    properties:
      name: sample-ledger
      permissionsMode: STANDARD

Import

Using pulumi import, import QLDB Ledgers using the name. For example:

$ pulumi import aws:qldb/ledger:Ledger sample-ledger sample-ledger

Constructors

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

Properties

arn ↔ Output<String>
The ARN of the QLDB Ledger
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
deletionProtection ↔ Output<bool?>
The deletion protection for the QLDB Ledger instance. By default it is true. To delete this resource via the provider, this value must be configured to false and applied first before attempting deletion.
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
kmsKey ↔ Output<String>
Key in KMS to use for encryption of data at rest in the ledger. For more information, see the AWS documentation. Valid values are "AWS_OWNED_KMS_KEY" to use an AWS KMS key that is owned and managed by AWS on your behalf, or the ARN of a valid symmetric customer managed KMS key.
latefinal
name ↔ Output<String>
The friendly name for the QLDB Ledger instance. By default generated by the provider.
latefinal
permissionsMode ↔ Output<String>
The permissions mode for the QLDB ledger instance. Specify either ALLOW_ALL or STANDARD.
latefinal
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
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
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, {LedgerState? state, CustomResourceOptions? options}) → Ledger
Gets an existing Ledger resource's state with the given name and id.