The highest tagged major version is
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/v2/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
})
}
```
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.
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 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/v2/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