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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package paymentcryptography
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/paymentcryptography/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates an Amazon Web Services Payment Cryptography key, a logical
// representation of a cryptographic key, that is unique in your account and Amazon
// Web Services Region. You use keys for cryptographic functions such as encryption
// and decryption. In addition to the key material used in cryptographic
// operations, an Amazon Web Services Payment Cryptography key includes metadata
// such as the key ARN, key usage, key origin, creation date, description, and key
// state. When you create a key, you specify both immutable and mutable data about
// the key. The immutable data contains key attributes that define the scope and
// cryptographic operations that you can perform using the key, for example key
// class (example: SYMMETRIC_KEY ), key algorithm (example: TDES_2KEY ), key usage
// (example: TR31_P0_PIN_ENCRYPTION_KEY ) and key modes of use (example: Encrypt ).
// For information about valid combinations of key attributes, see Understanding
// key attributes (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html)
// in the Amazon Web Services Payment Cryptography User Guide. The mutable data
// contained within a key includes usage timestamp and key deletion timestamp and
// can be modified after creation. Amazon Web Services Payment Cryptography binds
// key attributes to keys using key blocks when you store or export them. Amazon
// Web Services Payment Cryptography stores the key contents wrapped and never
// stores or transmits them in the clear. Cross-account use: This operation can't
// be used across different Amazon Web Services accounts. Related operations:
// - DeleteKey
// - GetKey
// - ListKeys
func (c *Client) CreateKey(ctx context.Context, params *CreateKeyInput, optFns ...func(*Options)) (*CreateKeyOutput, error) {
if params == nil {
params = &CreateKeyInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateKey", params, optFns, c.addOperationCreateKeyMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateKeyOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateKeyInput struct {
// Specifies whether the key is exportable from the service.
//
// This member is required.
Exportable *bool
// The role of the key, the algorithm it supports, and the cryptographic
// operations allowed with the key. This data is immutable after the key is
// created.
//
// This member is required.
KeyAttributes *types.KeyAttributes
// Specifies whether to enable the key. If the key is enabled, it is activated for
// use within the service. If the key is not enabled, then it is created but not
// activated. The default value is enabled.
Enabled *bool
// The algorithm that Amazon Web Services Payment Cryptography uses to calculate
// the key check value (KCV). It is used to validate the key integrity. For TDES
// keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with
// the key to be checked and retaining the 3 highest order bytes of the encrypted
// result. For AES keys, the KCV is computed using a CMAC algorithm where the input
// data is 16 bytes of zero and retaining the 3 highest order bytes of the
// encrypted result.
KeyCheckValueAlgorithm types.KeyCheckValueAlgorithm
// Assigns one or more tags to the Amazon Web Services Payment Cryptography key.
// Use this parameter to tag a key when it is created. To tag an existing Amazon
// Web Services Payment Cryptography key, use the TagResource operation. Each tag
// consists of a tag key and a tag value. Both the tag key and the tag value are
// required, but the tag value can be an empty (null) string. You can't have more
// than one tag on an Amazon Web Services Payment Cryptography key with the same
// tag key. Don't include personal, confidential or sensitive information in this
// field. This field may be displayed in plaintext in CloudTrail logs and other
// output. Tagging or untagging an Amazon Web Services Payment Cryptography key can
// allow or deny permission to the key.
Tags []types.Tag
noSmithyDocumentSerde
}
type CreateKeyOutput struct {
// The key material that contains all the key attributes.
//
// This member is required.
Key *types.Key
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateKeyMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson10_serializeOpCreateKey{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpCreateKey{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateKey"); 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 = addOpCreateKeyValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateKey(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_opCreateKey(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateKey",
}
}
|
