1. Packages
  2. AWS Classic
  3. API Docs
  4. qldb
  5. Ledger

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.qldb.Ledger

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Provides an AWS Quantum Ledger Database (QLDB) resource

    NOTE: Deletion protection is enabled by default. To successfully delete this resource via this provider, deletion_protection = 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")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/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
    	})
    }
    
    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 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.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 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
    

    Create Ledger Resource

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

    Constructor syntax

    new Ledger(name: string, args: LedgerArgs, opts?: CustomResourceOptions);
    @overload
    def Ledger(resource_name: str,
               args: LedgerArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Ledger(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               permissions_mode: Optional[str] = None,
               deletion_protection: Optional[bool] = None,
               kms_key: Optional[str] = None,
               name: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None)
    func NewLedger(ctx *Context, name string, args LedgerArgs, opts ...ResourceOption) (*Ledger, error)
    public Ledger(string name, LedgerArgs args, CustomResourceOptions? opts = null)
    public Ledger(String name, LedgerArgs args)
    public Ledger(String name, LedgerArgs args, CustomResourceOptions options)
    
    type: aws:qldb:Ledger
    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 LedgerArgs
    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 LedgerArgs
    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 LedgerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LedgerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LedgerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var ledgerResource = new Aws.Qldb.Ledger("ledgerResource", new()
    {
        PermissionsMode = "string",
        DeletionProtection = false,
        KmsKey = "string",
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := qldb.NewLedger(ctx, "ledgerResource", &qldb.LedgerArgs{
    	PermissionsMode:    pulumi.String("string"),
    	DeletionProtection: pulumi.Bool(false),
    	KmsKey:             pulumi.String("string"),
    	Name:               pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var ledgerResource = new Ledger("ledgerResource", LedgerArgs.builder()
        .permissionsMode("string")
        .deletionProtection(false)
        .kmsKey("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    ledger_resource = aws.qldb.Ledger("ledgerResource",
        permissions_mode="string",
        deletion_protection=False,
        kms_key="string",
        name="string",
        tags={
            "string": "string",
        })
    
    const ledgerResource = new aws.qldb.Ledger("ledgerResource", {
        permissionsMode: "string",
        deletionProtection: false,
        kmsKey: "string",
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:qldb:Ledger
    properties:
        deletionProtection: false
        kmsKey: string
        name: string
        permissionsMode: string
        tags:
            string: string
    

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

    PermissionsMode string
    The permissions mode for the QLDB ledger instance. Specify either ALLOW_ALL or STANDARD.
    DeletionProtection 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.
    KmsKey string
    The key in AWS Key Management Service (AWS 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.
    Name string
    The friendly name for the QLDB Ledger instance. By default generated by the provider.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    PermissionsMode string
    The permissions mode for the QLDB ledger instance. Specify either ALLOW_ALL or STANDARD.
    DeletionProtection 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.
    KmsKey string
    The key in AWS Key Management Service (AWS 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.
    Name string
    The friendly name for the QLDB Ledger instance. By default generated by the provider.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    permissionsMode String
    The permissions mode for the QLDB ledger instance. Specify either ALLOW_ALL or STANDARD.
    deletionProtection Boolean
    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.
    kmsKey String
    The key in AWS Key Management Service (AWS 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.
    name String
    The friendly name for the QLDB Ledger instance. By default generated by the provider.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    permissionsMode string
    The permissions mode for the QLDB ledger instance. Specify either ALLOW_ALL or STANDARD.
    deletionProtection boolean
    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.
    kmsKey string
    The key in AWS Key Management Service (AWS 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.
    name string
    The friendly name for the QLDB Ledger instance. By default generated by the provider.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    permissions_mode str
    The permissions mode for the QLDB ledger instance. Specify either ALLOW_ALL or STANDARD.
    deletion_protection 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.
    kms_key str
    The key in AWS Key Management Service (AWS 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.
    name str
    The friendly name for the QLDB Ledger instance. By default generated by the provider.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    permissionsMode String
    The permissions mode for the QLDB ledger instance. Specify either ALLOW_ALL or STANDARD.
    deletionProtection Boolean
    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.
    kmsKey String
    The key in AWS Key Management Service (AWS 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.
    name String
    The friendly name for the QLDB Ledger instance. By default generated by the provider.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    The ARN of the QLDB Ledger
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the QLDB Ledger
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the QLDB Ledger
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the QLDB Ledger
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the QLDB Ledger
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the QLDB Ledger
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Ledger Resource

    Get an existing Ledger 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?: LedgerState, opts?: CustomResourceOptions): Ledger
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            deletion_protection: Optional[bool] = None,
            kms_key: Optional[str] = None,
            name: Optional[str] = None,
            permissions_mode: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> Ledger
    func GetLedger(ctx *Context, name string, id IDInput, state *LedgerState, opts ...ResourceOption) (*Ledger, error)
    public static Ledger Get(string name, Input<string> id, LedgerState? state, CustomResourceOptions? opts = null)
    public static Ledger get(String name, Output<String> id, LedgerState 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:
    Arn string
    The ARN of the QLDB Ledger
    DeletionProtection 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.
    KmsKey string
    The key in AWS Key Management Service (AWS 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.
    Name string
    The friendly name for the QLDB Ledger instance. By default generated by the provider.
    PermissionsMode string
    The permissions mode for the QLDB ledger instance. Specify either ALLOW_ALL or STANDARD.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the QLDB Ledger
    DeletionProtection 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.
    KmsKey string
    The key in AWS Key Management Service (AWS 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.
    Name string
    The friendly name for the QLDB Ledger instance. By default generated by the provider.
    PermissionsMode string
    The permissions mode for the QLDB ledger instance. Specify either ALLOW_ALL or STANDARD.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the QLDB Ledger
    deletionProtection Boolean
    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.
    kmsKey String
    The key in AWS Key Management Service (AWS 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.
    name String
    The friendly name for the QLDB Ledger instance. By default generated by the provider.
    permissionsMode String
    The permissions mode for the QLDB ledger instance. Specify either ALLOW_ALL or STANDARD.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the QLDB Ledger
    deletionProtection boolean
    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.
    kmsKey string
    The key in AWS Key Management Service (AWS 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.
    name string
    The friendly name for the QLDB Ledger instance. By default generated by the provider.
    permissionsMode string
    The permissions mode for the QLDB ledger instance. Specify either ALLOW_ALL or STANDARD.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the QLDB Ledger
    deletion_protection 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.
    kms_key str
    The key in AWS Key Management Service (AWS 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.
    name str
    The friendly name for the QLDB Ledger instance. By default generated by the provider.
    permissions_mode str
    The permissions mode for the QLDB ledger instance. Specify either ALLOW_ALL or STANDARD.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the QLDB Ledger
    deletionProtection Boolean
    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.
    kmsKey String
    The key in AWS Key Management Service (AWS 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.
    name String
    The friendly name for the QLDB Ledger instance. By default generated by the provider.
    permissionsMode String
    The permissions mode for the QLDB ledger instance. Specify either ALLOW_ALL or STANDARD.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

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

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

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi