Network.AWS.SecretsManager.CreateSecret

Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.

Secrets Manager stores the encrypted secret data in one of a collection of "versions" associated with the secret. Each version contains a copy of the encrypted secret data. Each version is associated with one or more "staging labels" that identify where the version is in the rotation cycle. The SecretVersionsToStages field of the secret contains the mapping of staging labels to the active versions of the secret. Versions without a staging label are considered deprecated and are not included in the list.

You provide the secret data to be encrypted by putting text in either the SecretString parameter or binary data in the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager also creates an initial secret version and automatically attaches the staging label AWSCURRENT to the new version.

Minimum permissions

To run this command, you must have the following permissions:

• secretsmanager:CreateSecret
• kms:GenerateDataKey - needed only if you use a customer-created KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.
• kms:Decrypt - needed only if you use a customer-created KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

Related operations

• To delete a secret, use DeleteSecret .
• To modify an existing secret, use UpdateSecret .
• To create a new version of a secret, use PutSecretValue .
• To retrieve the encrypted secure string and secure binary values, use GetSecretValue .
• To retrieve all other details for a secret, use DescribeSecret . This does not include the encrypted secure string and secure binary values.
• To retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine the SecretVersionsToStages response value.

Creating a Request

createSecret

Arguments

:: Text

csName

-> CreateSecret

Creates a value of CreateSecret with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• csSecretBinary - (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty. This parameter is not available using the Secrets Manager console. It can be accessed only by using the AWS CLI or one of the AWS SDKs.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.
• csKMSKeyId - (Optional) Specifies the ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values in the versions stored in this secret. If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named aws/secretsmanager ). If a KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString or SecretBinary fields. Important: You can use the account's default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and specify the ARN in this field.
• csSecretString - (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty. If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString parameter. The Secrets Manager console stores the information as a JSON structure of keyvalue pairs that the Lambda rotation function knows how to parse. For storing multiple values, we recommend that you use a JSON text string argument and specify keyvalue pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide . For example: [{Key:"username",Value:"bob"},{Key:"password",Value:"abc123xyz456"}] If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
• csClientRequestToken - (Optional) If you include SecretString or SecretBinary , then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version. This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret. * If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created. * If a version with this value already exists and that version's SecretString and SecretBinary values are the same as those in the request, then the request is ignored (the operation is idempotent). * If a version with this value already exists and that version's SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version. This value becomes the SecretVersionId of the new version.
• csDescription - (Optional) Specifies a user-provided description of the secret.
• csTags - (Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a Key and Value pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource . Important: * Secrets Manager tag key names are case sensitive. A tag with the key ABC is a different tag from one with key "abc". * If you check tags in IAM policy Condition elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied error. This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide . For example: [{Key:CostCenter,Value:"12345"},{Key:"environment",Value:"production"}] If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. The following basic restrictions apply to tags: * Maximum number of tags per secret—50 * Maximum key length—127 Unicode characters in UTF-8 * Maximum value length—255 Unicode characters in UTF-8 * Tag keys and values are case sensitive. * Do not use the aws: prefix in your tag names or values because it is reserved for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. * If your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
• csName - Specifies the friendly name of the new secret.

data CreateSecret

See: createSecret smart constructor.

Instances

Eq CreateSecret

Methods

(==) :: CreateSecret -> CreateSecret -> Bool

(/=) :: CreateSecret -> CreateSecret -> Bool

Data CreateSecret

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateSecret -> c CreateSecret

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateSecret

toConstr :: CreateSecret -> Constr

dataTypeOf :: CreateSecret -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateSecret)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateSecret)

gmapT :: (forall b. Data b => b -> b) -> CreateSecret -> CreateSecret

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateSecret -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateSecret -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateSecret -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateSecret -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateSecret -> m CreateSecret

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateSecret -> m CreateSecret

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateSecret -> m CreateSecret

Show CreateSecret

Methods

showsPrec :: Int -> CreateSecret -> ShowS

show :: CreateSecret -> String

showList :: [CreateSecret] -> ShowS

Generic CreateSecret

Associated Types

type Rep CreateSecret :: * -> *

Methods

from :: CreateSecret -> Rep CreateSecret x

to :: Rep CreateSecret x -> CreateSecret

Hashable CreateSecret

Methods

hashWithSalt :: Int -> CreateSecret -> Int

hash :: CreateSecret -> Int

ToJSON CreateSecret

Methods

toJSON :: CreateSecret -> Value

toEncoding :: CreateSecret -> Encoding

toJSONList :: [CreateSecret] -> Value

toEncodingList :: [CreateSecret] -> Encoding

NFData CreateSecret

Methods

rnf :: CreateSecret -> ()

AWSRequest CreateSecret

Associated Types

type Rs CreateSecret :: *

Methods

request :: CreateSecret -> Request CreateSecret

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateSecret -> ClientResponse -> m (Response CreateSecret)

ToHeaders CreateSecret

Methods

toHeaders :: CreateSecret -> [Header]

ToPath CreateSecret

Methods

toPath :: CreateSecret -> ByteString

ToQuery CreateSecret

Methods

toQuery :: CreateSecret -> QueryString

type Rep CreateSecret

type Rep CreateSecret = D1 * (MetaData "CreateSecret" "Network.AWS.SecretsManager.CreateSecret" "amazonka-secretsmanager-1.6.0-K7nD2j5oEj0GsgMw0kPUxD" False) (C1 * (MetaCons "CreateSecret'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_csSecretBinary") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Sensitive Base64)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_csKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_csSecretString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Sensitive Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_csClientRequestToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_csDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_csTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Tag]))) (S1 * (MetaSel (Just Symbol "_csName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs CreateSecret

type Rs CreateSecret = CreateSecretResponse

Request Lenses

csSecretBinary :: Lens' CreateSecret (Maybe ByteString)

(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty. This parameter is not available using the Secrets Manager console. It can be accessed only by using the AWS CLI or one of the AWS SDKs.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.

csKMSKeyId :: Lens' CreateSecret (Maybe Text)

(Optional) Specifies the ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values in the versions stored in this secret. If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named aws/secretsmanager ). If a KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString or SecretBinary fields. Important: You can use the account's default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and specify the ARN in this field.

csSecretString :: Lens' CreateSecret (Maybe Text)

(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty. If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString parameter. The Secrets Manager console stores the information as a JSON structure of keyvalue pairs that the Lambda rotation function knows how to parse. For storing multiple values, we recommend that you use a JSON text string argument and specify keyvalue pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide . For example: [{Key:"username",Value:"bob"},{Key:"password",Value:"abc123xyz456"}] If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.

csClientRequestToken :: Lens' CreateSecret (Maybe Text)

(Optional) If you include SecretString or SecretBinary , then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version. This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret. * If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created. * If a version with this value already exists and that version's SecretString and SecretBinary values are the same as those in the request, then the request is ignored (the operation is idempotent). * If a version with this value already exists and that version's SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version. This value becomes the SecretVersionId of the new version.

csDescription :: Lens' CreateSecret (Maybe Text)

(Optional) Specifies a user-provided description of the secret.

csTags :: Lens' CreateSecret [Tag]

(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a Key and Value pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource . Important: * Secrets Manager tag key names are case sensitive. A tag with the key ABC is a different tag from one with key "abc". * If you check tags in IAM policy Condition elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied error. This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide . For example: [{Key:CostCenter,Value:"12345"},{Key:"environment",Value:"production"}] If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. The following basic restrictions apply to tags: * Maximum number of tags per secret—50 * Maximum key length—127 Unicode characters in UTF-8 * Maximum value length—255 Unicode characters in UTF-8 * Tag keys and values are case sensitive. * Do not use the aws: prefix in your tag names or values because it is reserved for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. * If your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.

csName :: Lens' CreateSecret Text

Specifies the friendly name of the new secret.

Destructuring the Response

createSecretResponse

Arguments

:: Int

csrsResponseStatus

-> CreateSecretResponse

Creates a value of CreateSecretResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• csrsVersionId - The unique identifier that's associated with the version of the secret you just created.
• csrsARN - The Amazon Resource Name (ARN) of the secret that you just created.
• csrsName - The friendly name of the secret that you just created.
• csrsResponseStatus - -- | The response status code.

data CreateSecretResponse

See: createSecretResponse smart constructor.

Instances

Eq CreateSecretResponse

Methods

(==) :: CreateSecretResponse -> CreateSecretResponse -> Bool

(/=) :: CreateSecretResponse -> CreateSecretResponse -> Bool

Data CreateSecretResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateSecretResponse -> c CreateSecretResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateSecretResponse

toConstr :: CreateSecretResponse -> Constr

dataTypeOf :: CreateSecretResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateSecretResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateSecretResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateSecretResponse -> CreateSecretResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateSecretResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateSecretResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateSecretResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateSecretResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateSecretResponse -> m CreateSecretResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateSecretResponse -> m CreateSecretResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateSecretResponse -> m CreateSecretResponse

Read CreateSecretResponse

Methods

readsPrec :: Int -> ReadS CreateSecretResponse

readList :: ReadS [CreateSecretResponse]

readPrec :: ReadPrec CreateSecretResponse

readListPrec :: ReadPrec [CreateSecretResponse]

Show CreateSecretResponse

Methods

showsPrec :: Int -> CreateSecretResponse -> ShowS

show :: CreateSecretResponse -> String

showList :: [CreateSecretResponse] -> ShowS

Generic CreateSecretResponse

Associated Types

type Rep CreateSecretResponse :: * -> *

Methods

from :: CreateSecretResponse -> Rep CreateSecretResponse x

to :: Rep CreateSecretResponse x -> CreateSecretResponse

NFData CreateSecretResponse

Methods

rnf :: CreateSecretResponse -> ()

type Rep CreateSecretResponse

type Rep CreateSecretResponse = D1 * (MetaData "CreateSecretResponse" "Network.AWS.SecretsManager.CreateSecret" "amazonka-secretsmanager-1.6.0-K7nD2j5oEj0GsgMw0kPUxD" False) (C1 * (MetaCons "CreateSecretResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_csrsVersionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_csrsARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_csrsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_csrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

csrsVersionId :: Lens' CreateSecretResponse (Maybe Text)

The unique identifier that's associated with the version of the secret you just created.

csrsARN :: Lens' CreateSecretResponse (Maybe Text)

The Amazon Resource Name (ARN) of the secret that you just created.

csrsName :: Lens' CreateSecretResponse (Maybe Text)

The friendly name of the secret that you just created.

csrsResponseStatus :: Lens' CreateSecretResponse Int

• - | The response status code.