1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package qldb
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/qldb/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Creates a new ledger in your Amazon Web Services account in the current Region.
func (c *Client) CreateLedger(ctx context.Context, params *CreateLedgerInput, optFns ...func(*Options)) (*CreateLedgerOutput, error) {
if params == nil {
params = &CreateLedgerInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateLedger", params, optFns, c.addOperationCreateLedgerMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateLedgerOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateLedgerInput struct {
// The name of the ledger that you want to create. The name must be unique among
// all of the ledgers in your Amazon Web Services 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.
//
// This member is required.
Name *string
// 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.
//
// This member is required.
PermissionsMode types.PermissionsMode
// Specifies whether the ledger is protected from being deleted by any user. If
// not defined during 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 this parameter to false .
DeletionProtection *bool
// The key in Key Management Service (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 KMS key that is owned and managed by Amazon Web
// Services on your behalf.
// - Undefined: By default, use an Amazon Web Services owned KMS key.
// - A valid symmetric customer managed KMS key: Use the specified symmetric
// encryption 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 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 Amazon Web Services 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 Key Management Service Developer Guide.
KmsKey *string
// The key-value pairs to add as tags to the ledger that you want to create. Tag
// keys are case sensitive. Tag values are case sensitive and can be null.
Tags map[string]*string
noSmithyDocumentSerde
}
type CreateLedgerOutput struct {
// The Amazon Resource Name (ARN) for the ledger.
Arn *string
// The date and time, in epoch time format, when the ledger was created. (Epoch
// time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970
// UTC.)
CreationDateTime *time.Time
// Specifies whether the ledger is protected from being deleted by any user. If
// not defined during 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 this parameter to false .
DeletionProtection *bool
// The ARN of the customer managed KMS key that the ledger uses for encryption at
// rest. If this parameter is undefined, the ledger uses an Amazon Web Services
// owned KMS key for encryption.
KmsKeyArn *string
// The name of the ledger.
Name *string
// The permissions mode of the ledger that you created.
PermissionsMode types.PermissionsMode
// The current status of the ledger.
State types.LedgerState
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateLedgerMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpCreateLedger{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreateLedger{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateLedger"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpCreateLedgerValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateLedger(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opCreateLedger(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateLedger",
}
}
|