qldb

package
v3.29.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 15, 2021 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Ledger 

type Ledger struct {
	pulumi.CustomResourceState

	// The ARN of the QLDB Ledger
	Arn pulumi.StringOutput `pulumi:"arn"`
	// 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.
	DeletionProtection pulumi.BoolPtrOutput `pulumi:"deletionProtection"`
	// The friendly name for the QLDB Ledger instance. This is atuo generated by default.
	Name pulumi.StringOutput `pulumi:"name"`
	// Key-value mapping of resource tags
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

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

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/qldb"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := qldb.NewLedger(ctx, "sample_ledger", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

QLDB Ledgers can be imported using the `name`, e.g.

```sh 

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

```

func GetLedger 

func GetLedger(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *LedgerState, opts ...pulumi.ResourceOption) (*Ledger, error)

GetLedger gets an existing Ledger resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewLedger 

func NewLedger(ctx *pulumi.Context,
	name string, args *LedgerArgs, opts ...pulumi.ResourceOption) (*Ledger, error)

NewLedger registers a new resource with the given unique name, arguments, and options.

func (*Ledger) ElementType added in v3.13.0 

func (*Ledger) ElementType() reflect.Type

func (*Ledger) ToLedgerOutput added in v3.13.0 

func (i *Ledger) ToLedgerOutput() LedgerOutput

func (*Ledger) ToLedgerOutputWithContext added in v3.13.0 

func (i *Ledger) ToLedgerOutputWithContext(ctx context.Context) LedgerOutput

func (*Ledger) ToLedgerPtrOutput added in v3.25.0 

func (i *Ledger) ToLedgerPtrOutput() LedgerPtrOutput

func (*Ledger) ToLedgerPtrOutputWithContext added in v3.25.0 

func (i *Ledger) ToLedgerPtrOutputWithContext(ctx context.Context) LedgerPtrOutput

type LedgerArgs 

type LedgerArgs struct {
	// 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.
	DeletionProtection pulumi.BoolPtrInput
	// The friendly name for the QLDB Ledger instance. This is atuo generated by default.
	Name pulumi.StringPtrInput
	// Key-value mapping of resource tags
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Ledger resource.

func (LedgerArgs) ElementType 

func (LedgerArgs) ElementType() reflect.Type

type LedgerArray added in v3.25.0 

type LedgerArray []LedgerInput

func (LedgerArray) ElementType added in v3.25.0 

func (LedgerArray) ElementType() reflect.Type

func (LedgerArray) ToLedgerArrayOutput added in v3.25.0 

func (i LedgerArray) ToLedgerArrayOutput() LedgerArrayOutput

func (LedgerArray) ToLedgerArrayOutputWithContext added in v3.25.0 

func (i LedgerArray) ToLedgerArrayOutputWithContext(ctx context.Context) LedgerArrayOutput

type LedgerArrayInput added in v3.25.0 

type LedgerArrayInput interface {
	pulumi.Input

	ToLedgerArrayOutput() LedgerArrayOutput
	ToLedgerArrayOutputWithContext(context.Context) LedgerArrayOutput
}

LedgerArrayInput is an input type that accepts LedgerArray and LedgerArrayOutput values. You can construct a concrete instance of `LedgerArrayInput` via: 

LedgerArray{ LedgerArgs{...} }

type LedgerArrayOutput added in v3.25.0 

type LedgerArrayOutput struct{ *pulumi.OutputState }

func (LedgerArrayOutput) ElementType added in v3.25.0 

func (LedgerArrayOutput) ElementType() reflect.Type

func (LedgerArrayOutput) Index added in v3.25.0 

func (o LedgerArrayOutput) Index(i pulumi.IntInput) LedgerOutput

func (LedgerArrayOutput) ToLedgerArrayOutput added in v3.25.0 

func (o LedgerArrayOutput) ToLedgerArrayOutput() LedgerArrayOutput

func (LedgerArrayOutput) ToLedgerArrayOutputWithContext added in v3.25.0 

func (o LedgerArrayOutput) ToLedgerArrayOutputWithContext(ctx context.Context) LedgerArrayOutput

type LedgerInput added in v3.13.0 

type LedgerInput interface {
	pulumi.Input

	ToLedgerOutput() LedgerOutput
	ToLedgerOutputWithContext(ctx context.Context) LedgerOutput
}

type LedgerMap added in v3.25.0 

type LedgerMap map[string]LedgerInput

func (LedgerMap) ElementType added in v3.25.0 

func (LedgerMap) ElementType() reflect.Type

func (LedgerMap) ToLedgerMapOutput added in v3.25.0 

func (i LedgerMap) ToLedgerMapOutput() LedgerMapOutput

func (LedgerMap) ToLedgerMapOutputWithContext added in v3.25.0 

func (i LedgerMap) ToLedgerMapOutputWithContext(ctx context.Context) LedgerMapOutput

type LedgerMapInput added in v3.25.0 

type LedgerMapInput interface {
	pulumi.Input

	ToLedgerMapOutput() LedgerMapOutput
	ToLedgerMapOutputWithContext(context.Context) LedgerMapOutput
}

LedgerMapInput is an input type that accepts LedgerMap and LedgerMapOutput values. You can construct a concrete instance of `LedgerMapInput` via: 

LedgerMap{ "key": LedgerArgs{...} }

type LedgerMapOutput added in v3.25.0 

type LedgerMapOutput struct{ *pulumi.OutputState }

func (LedgerMapOutput) ElementType added in v3.25.0 

func (LedgerMapOutput) ElementType() reflect.Type

func (LedgerMapOutput) MapIndex added in v3.25.0 

func (o LedgerMapOutput) MapIndex(k pulumi.StringInput) LedgerOutput

func (LedgerMapOutput) ToLedgerMapOutput added in v3.25.0 

func (o LedgerMapOutput) ToLedgerMapOutput() LedgerMapOutput

func (LedgerMapOutput) ToLedgerMapOutputWithContext added in v3.25.0 

func (o LedgerMapOutput) ToLedgerMapOutputWithContext(ctx context.Context) LedgerMapOutput

type LedgerOutput added in v3.13.0 

type LedgerOutput struct {
	*pulumi.OutputState
}

func (LedgerOutput) ElementType added in v3.13.0 

func (LedgerOutput) ElementType() reflect.Type

func (LedgerOutput) ToLedgerOutput added in v3.13.0 

func (o LedgerOutput) ToLedgerOutput() LedgerOutput

func (LedgerOutput) ToLedgerOutputWithContext added in v3.13.0 

func (o LedgerOutput) ToLedgerOutputWithContext(ctx context.Context) LedgerOutput

func (LedgerOutput) ToLedgerPtrOutput added in v3.25.0 

func (o LedgerOutput) ToLedgerPtrOutput() LedgerPtrOutput

func (LedgerOutput) ToLedgerPtrOutputWithContext added in v3.25.0 

func (o LedgerOutput) ToLedgerPtrOutputWithContext(ctx context.Context) LedgerPtrOutput

type LedgerPtrInput added in v3.25.0 

type LedgerPtrInput interface {
	pulumi.Input

	ToLedgerPtrOutput() LedgerPtrOutput
	ToLedgerPtrOutputWithContext(ctx context.Context) LedgerPtrOutput
}

type LedgerPtrOutput added in v3.25.0 

type LedgerPtrOutput struct {
	*pulumi.OutputState
}

func (LedgerPtrOutput) ElementType added in v3.25.0 

func (LedgerPtrOutput) ElementType() reflect.Type

func (LedgerPtrOutput) ToLedgerPtrOutput added in v3.25.0 

func (o LedgerPtrOutput) ToLedgerPtrOutput() LedgerPtrOutput

func (LedgerPtrOutput) ToLedgerPtrOutputWithContext added in v3.25.0 

func (o LedgerPtrOutput) ToLedgerPtrOutputWithContext(ctx context.Context) LedgerPtrOutput

type LedgerState 

type LedgerState struct {
	// The ARN of the QLDB Ledger
	Arn pulumi.StringPtrInput
	// 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.
	DeletionProtection pulumi.BoolPtrInput
	// The friendly name for the QLDB Ledger instance. This is atuo generated by default.
	Name pulumi.StringPtrInput
	// Key-value mapping of resource tags
	Tags pulumi.StringMapInput
}

func (LedgerState) ElementType 

func (LedgerState) ElementType() reflect.Type

type LookupLedgerArgs 

type LookupLedgerArgs struct {
	// The friendly name of the ledger to match.
	Name string `pulumi:"name"`
}

A collection of arguments for invoking getLedger.

type LookupLedgerResult 

type LookupLedgerResult struct {
	// Amazon Resource Name (ARN) of the ledger.
	Arn string `pulumi:"arn"`
	// Deletion protection on the QLDB Ledger instance. Set to `true` by default.
	DeletionProtection bool `pulumi:"deletionProtection"`
	// The provider-assigned unique ID for this managed resource.
	Id   string `pulumi:"id"`
	Name string `pulumi:"name"`
}

A collection of values returned by getLedger.

func LookupLedger 

func LookupLedger(ctx *pulumi.Context, args *LookupLedgerArgs, opts ...pulumi.InvokeOption) (*LookupLedgerResult, error)

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

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/qldb"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := qldb.LookupLedger(ctx, &qldb.LookupLedgerArgs{
			Name: "an_example_ledger",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.