awsqldb

package
v1.148.0-devpreview Latest Latest
Warning

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

 Go to latest Published: Mar 10, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnLedger_CFN_RESOURCE_TYPE_NAME 

func CfnLedger_CFN_RESOURCE_TYPE_NAME() *string

func CfnLedger_IsCfnElement 

func CfnLedger_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnLedger_IsCfnResource 

func CfnLedger_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnLedger_IsConstruct 

func CfnLedger_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnStream_CFN_RESOURCE_TYPE_NAME 

func CfnStream_CFN_RESOURCE_TYPE_NAME() *string

func CfnStream_IsCfnElement 

func CfnStream_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnStream_IsCfnResource 

func CfnStream_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnStream_IsConstruct 

func CfnStream_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnLedger_Override 

func NewCfnLedger_Override(c CfnLedger, scope awscdk.Construct, id *string, props *CfnLedgerProps)

Create a new `AWS::QLDB::Ledger`.

func NewCfnStream_Override 

func NewCfnStream_Override(c CfnStream, scope awscdk.Construct, id *string, props *CfnStreamProps)

Create a new `AWS::QLDB::Stream`.

Types

type CfnLedger 

type CfnLedger interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DeletionProtection() interface{}
	SetDeletionProtection(val interface{})
	KmsKey() *string
	SetKmsKey(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	PermissionsMode() *string
	SetPermissionsMode(val *string)
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::QLDB::Ledger`.

The `AWS::QLDB::Ledger` resource specifies a new Amazon Quantum Ledger Database (Amazon QLDB) ledger in your AWS account . Amazon QLDB is a fully managed ledger database that provides a transparent, immutable, and cryptographically verifiable transaction log owned by a central trusted authority. You can use QLDB to track all application data changes, and maintain a complete and verifiable history of changes over time.

For more information, see [CreateLedger](https://docs.aws.amazon.com/qldb/latest/developerguide/API_CreateLedger.html) in the *Amazon QLDB API Reference* .

TODO: EXAMPLE

func NewCfnLedger 

func NewCfnLedger(scope awscdk.Construct, id *string, props *CfnLedgerProps) CfnLedger

Create a new `AWS::QLDB::Ledger`.

type CfnLedgerProps 

type CfnLedgerProps struct {
	// The permissions mode to assign to the ledger that you want to create.
	//
	// This parameter can have one of the following values:
	//
	// - `ALLOW_ALL` : A legacy permissions mode that enables access control with API-level granularity for ledgers.
	//
	// This mode allows users who have the `SendCommand` API permission for this ledger to run all PartiQL commands (hence, `ALLOW_ALL` ) on any tables in the specified ledger. This mode disregards any table-level or command-level IAM permissions policies that you create for the ledger.
	// - `STANDARD` : ( *Recommended* ) A permissions mode that enables access control with finer granularity for ledgers, tables, and PartiQL commands.
	//
	// By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To allow PartiQL commands to run, you must create IAM permissions policies for specific table resources and PartiQL actions, in addition to the `SendCommand` API permission for the ledger. For information, see [Getting started with the standard permissions mode](https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html) in the *Amazon QLDB Developer Guide* .
	//
	// > We strongly recommend using the `STANDARD` permissions mode to maximize the security of your ledger data.
	PermissionsMode *string `json:"permissionsMode" yaml:"permissionsMode"`
	// The flag that prevents a ledger from being deleted by any user.
	//
	// If not provided on ledger creation, this feature is enabled ( `true` ) by default.
	//
	// If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the `UpdateLedger` operation to set the flag to `false` .
	DeletionProtection interface{} `json:"deletionProtection" yaml:"deletionProtection"`
	// The key in AWS Key Management Service ( AWS KMS ) to use for encryption of data at rest in the ledger.
	//
	// For more information, see [Encryption at rest](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) in the *Amazon QLDB Developer Guide* .
	//
	// Use one of the following options to specify this parameter:
	//
	// - `AWS_OWNED_KMS_KEY` : Use an AWS KMS key that is owned and managed by AWS on your behalf.
	// - *Undefined* : By default, use an AWS owned KMS key.
	// - *A valid symmetric customer managed KMS key* : Use the specified KMS key in your account that you create, own, and manage.
	//
	// Amazon QLDB does not support asymmetric keys. For more information, see [Using symmetric and asymmetric keys](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the *AWS Key Management Service Developer Guide* .
	//
	// To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with `"alias/"` . To specify a key in a different AWS account , you must use the key ARN or alias ARN.
	//
	// For example:
	//
	// - Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
	// - Key ARN: `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
	// - Alias name: `alias/ExampleAlias`
	// - Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
	//
	// For more information, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) in the *AWS Key Management Service Developer Guide* .
	KmsKey *string `json:"kmsKey" yaml:"kmsKey"`
	// The name of the ledger that you want to create.
	//
	// The name must be unique among all of the ledgers in your AWS account in the current Region.
	//
	// Naming constraints for ledger names are defined in [Quotas in Amazon QLDB](https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming) in the *Amazon QLDB Developer Guide* .
	Name *string `json:"name" yaml:"name"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnLedger`.

TODO: EXAMPLE

type CfnStream 

type CfnStream interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	ExclusiveEndTime() *string
	SetExclusiveEndTime(val *string)
	InclusiveStartTime() *string
	SetInclusiveStartTime(val *string)
	KinesisConfiguration() interface{}
	SetKinesisConfiguration(val interface{})
	LedgerName() *string
	SetLedgerName(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	StreamName() *string
	SetStreamName(val *string)
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::QLDB::Stream`.

The `AWS::QLDB::Stream` resource specifies a journal stream for a given Amazon Quantum Ledger Database (Amazon QLDB) ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.

For more information, see [StreamJournalToKinesis](https://docs.aws.amazon.com/qldb/latest/developerguide/API_StreamJournalToKinesis.html) in the *Amazon QLDB API Reference* .

TODO: EXAMPLE

func NewCfnStream 

func NewCfnStream(scope awscdk.Construct, id *string, props *CfnStreamProps) CfnStream

Create a new `AWS::QLDB::Stream`.

type CfnStreamProps 

type CfnStreamProps struct {
	// The inclusive start date and time from which to start streaming journal data.
	//
	// This parameter must be in `ISO 8601` date and time format and in Universal Coordinated Time (UTC). For example: `2019-06-13T21:36:34Z` .
	//
	// The `InclusiveStartTime` cannot be in the future and must be before `ExclusiveEndTime` .
	//
	// If you provide an `InclusiveStartTime` that is before the ledger's `CreationDateTime` , QLDB effectively defaults it to the ledger's `CreationDateTime` .
	InclusiveStartTime *string `json:"inclusiveStartTime" yaml:"inclusiveStartTime"`
	// The configuration settings of the Kinesis Data Streams destination for your stream request.
	KinesisConfiguration interface{} `json:"kinesisConfiguration" yaml:"kinesisConfiguration"`
	// The name of the ledger.
	LedgerName *string `json:"ledgerName" yaml:"ledgerName"`
	// The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
	//
	// To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the `iam:PassRole` action on the IAM role resource. This is required for all journal stream requests.
	RoleArn *string `json:"roleArn" yaml:"roleArn"`
	// The name that you want to assign to the QLDB journal stream.
	//
	// User-defined names can help identify and indicate the purpose of a stream.
	//
	// Your stream name must be unique among other *active* streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in [Quotas in Amazon QLDB](https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming) in the *Amazon QLDB Developer Guide* .
	StreamName *string `json:"streamName" yaml:"streamName"`
	// The exclusive date and time that specifies when the stream ends.
	//
	// If you don't define this parameter, the stream runs indefinitely until you cancel it.
	//
	// The `ExclusiveEndTime` must be in `ISO 8601` date and time format and in Universal Coordinated Time (UTC). For example: `2019-06-13T21:36:34Z` .
	ExclusiveEndTime *string `json:"exclusiveEndTime" yaml:"exclusiveEndTime"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnStream`.

TODO: EXAMPLE

type CfnStream_KinesisConfigurationProperty 

type CfnStream_KinesisConfigurationProperty struct {
	// Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.
	//
	// *This option is enabled by default.* Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see [KPL Key Concepts](https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html) and [Consumer De-aggregation](https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html) in the *Amazon Kinesis Data Streams Developer Guide* .
	AggregationEnabled interface{} `json:"aggregationEnabled" yaml:"aggregationEnabled"`
	// The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
	StreamArn *string `json:"streamArn" yaml:"streamArn"`
}

The configuration settings of the Amazon Kinesis Data Streams destination for an Amazon QLDB journal stream.

TODO: EXAMPLE

Source Files

View all Source files

Directories

Path Synopsis

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.