qldb

package
v4.35.0 Latest Latest
Warning

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

 Go to latest Published: Jan 18, 2022 License: Apache-2.0 Imports: 7 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. By default generated by this provider.
	Name pulumi.StringOutput `pulumi:"name"`
	// The permissions mode for the QLDB ledger instance. Specify either `ALLOW_ALL` or `STANDARD`.
	PermissionsMode pulumi.StringOutput `pulumi:"permissionsMode"`
	// 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.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
}

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/v4/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{
			PermissionsMode: pulumi.String("STANDARD"),
		})
		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 

func (*Ledger) ElementType() reflect.Type

func (*Ledger) ToLedgerOutput 

func (i *Ledger) ToLedgerOutput() LedgerOutput

func (*Ledger) ToLedgerOutputWithContext 

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

func (*Ledger) ToLedgerPtrOutput 

func (i *Ledger) ToLedgerPtrOutput() LedgerPtrOutput

func (*Ledger) ToLedgerPtrOutputWithContext 

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. By default generated by this provider.
	Name pulumi.StringPtrInput
	// The permissions mode for the QLDB ledger instance. Specify either `ALLOW_ALL` or `STANDARD`.
	PermissionsMode pulumi.StringInput
	// 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.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Ledger resource.

func (LedgerArgs) ElementType 

func (LedgerArgs) ElementType() reflect.Type

type LedgerArray 

type LedgerArray []LedgerInput

func (LedgerArray) ElementType 

func (LedgerArray) ElementType() reflect.Type

func (LedgerArray) ToLedgerArrayOutput 

func (i LedgerArray) ToLedgerArrayOutput() LedgerArrayOutput

func (LedgerArray) ToLedgerArrayOutputWithContext 

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

type LedgerArrayInput 

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 

type LedgerArrayOutput struct{ *pulumi.OutputState }

func (LedgerArrayOutput) ElementType 

func (LedgerArrayOutput) ElementType() reflect.Type

func (LedgerArrayOutput) Index 

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

func (LedgerArrayOutput) ToLedgerArrayOutput 

func (o LedgerArrayOutput) ToLedgerArrayOutput() LedgerArrayOutput

func (LedgerArrayOutput) ToLedgerArrayOutputWithContext 

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

type LedgerInput 

type LedgerInput interface {
	pulumi.Input

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

type LedgerMap 

type LedgerMap map[string]LedgerInput

func (LedgerMap) ElementType 

func (LedgerMap) ElementType() reflect.Type

func (LedgerMap) ToLedgerMapOutput 

func (i LedgerMap) ToLedgerMapOutput() LedgerMapOutput

func (LedgerMap) ToLedgerMapOutputWithContext 

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

type LedgerMapInput 

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 

type LedgerMapOutput struct{ *pulumi.OutputState }

func (LedgerMapOutput) ElementType 

func (LedgerMapOutput) ElementType() reflect.Type

func (LedgerMapOutput) MapIndex 

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

func (LedgerMapOutput) ToLedgerMapOutput 

func (o LedgerMapOutput) ToLedgerMapOutput() LedgerMapOutput

func (LedgerMapOutput) ToLedgerMapOutputWithContext 

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

type LedgerOutput 

type LedgerOutput struct{ *pulumi.OutputState }

func (LedgerOutput) ElementType 

func (LedgerOutput) ElementType() reflect.Type

func (LedgerOutput) ToLedgerOutput 

func (o LedgerOutput) ToLedgerOutput() LedgerOutput

func (LedgerOutput) ToLedgerOutputWithContext 

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

func (LedgerOutput) ToLedgerPtrOutput 

func (o LedgerOutput) ToLedgerPtrOutput() LedgerPtrOutput

func (LedgerOutput) ToLedgerPtrOutputWithContext 

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

type LedgerPtrInput 

type LedgerPtrInput interface {
	pulumi.Input

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

type LedgerPtrOutput 

type LedgerPtrOutput struct{ *pulumi.OutputState }

func (LedgerPtrOutput) Elem added in v4.15.0 

func (o LedgerPtrOutput) Elem() LedgerOutput

func (LedgerPtrOutput) ElementType 

func (LedgerPtrOutput) ElementType() reflect.Type

func (LedgerPtrOutput) ToLedgerPtrOutput 

func (o LedgerPtrOutput) ToLedgerPtrOutput() LedgerPtrOutput

func (LedgerPtrOutput) ToLedgerPtrOutputWithContext 

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. By default generated by this provider.
	Name pulumi.StringPtrInput
	// The permissions mode for the QLDB ledger instance. Specify either `ALLOW_ALL` or `STANDARD`.
	PermissionsMode pulumi.StringPtrInput
	// 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.
	Tags pulumi.StringMapInput
	// A map of tags assigned to the resource, including those inherited from the provider.
	TagsAll 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 LookupLedgerOutputArgs added in v4.21.0 

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

A collection of arguments for invoking getLedger.

func (LookupLedgerOutputArgs) ElementType added in v4.21.0 

func (LookupLedgerOutputArgs) ElementType() reflect.Type

type LookupLedgerResult 

type LookupLedgerResult struct {
	Arn                string `pulumi:"arn"`
	DeletionProtection bool   `pulumi:"deletionProtection"`
	// The provider-assigned unique ID for this managed resource.
	Id              string `pulumi:"id"`
	Name            string `pulumi:"name"`
	PermissionsMode string `pulumi:"permissionsMode"`
}

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/v4/go/aws/qldb"
"github.com/pulumi/pulumi/sdk/v3/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
	})
}

```

type LookupLedgerResultOutput added in v4.21.0 

type LookupLedgerResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getLedger.

func LookupLedgerOutput added in v4.21.0 

func LookupLedgerOutput(ctx *pulumi.Context, args LookupLedgerOutputArgs, opts ...pulumi.InvokeOption) LookupLedgerResultOutput

func (LookupLedgerResultOutput) Arn added in v4.21.0 

func (o LookupLedgerResultOutput) Arn() pulumi.StringOutput

func (LookupLedgerResultOutput) DeletionProtection added in v4.21.0 

func (o LookupLedgerResultOutput) DeletionProtection() pulumi.BoolOutput

func (LookupLedgerResultOutput) ElementType added in v4.21.0 

func (LookupLedgerResultOutput) ElementType() reflect.Type

func (LookupLedgerResultOutput) Id added in v4.21.0 

func (o LookupLedgerResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (LookupLedgerResultOutput) Name added in v4.21.0 

func (o LookupLedgerResultOutput) Name() pulumi.StringOutput

func (LookupLedgerResultOutput) PermissionsMode added in v4.21.0 

func (o LookupLedgerResultOutput) PermissionsMode() pulumi.StringOutput

func (LookupLedgerResultOutput) ToLookupLedgerResultOutput added in v4.21.0 

func (o LookupLedgerResultOutput) ToLookupLedgerResultOutput() LookupLedgerResultOutput

func (LookupLedgerResultOutput) ToLookupLedgerResultOutputWithContext added in v4.21.0 

func (o LookupLedgerResultOutput) ToLookupLedgerResultOutputWithContext(ctx context.Context) LookupLedgerResultOutput

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.