KMS Key | Create (Review Required) - AMS Advanced Change Type Reference
Change Type DetailsAdditional InformationExecution Input ParametersExample: Required ParametersExample: All Parameters

KMS Key | Create (Review Required)

Request a KMS key by describing key permissions or submitting a key policy document.

Full classification: Deployment | Advanced stack components | KMS key | Create (review required)

Change Type Details

Change type ID

ct-2epp05svrlwod

Current version

3.0

Expected execution duration

60 minutes

AWS approval

Required

Customer approval

Not required if submitter

Execution mode

Manual

Additional Information

Create KMS Key (review required)

Screenshot of this change type in the AMS console:

How it works:

  1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC.

  2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view.

    • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create.

      To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button.

    • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page.

  3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC.

    In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area.

  4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output.

  5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page.

How it works:

  1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here.

  2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID.

    Monitor the RFC: aws amscm get-rfc --rfc-id ID command.

To check the change type version, use this command:

aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID
Note

You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients\" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference.

INLINE CREATE:

Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this:

aws amscm create-rfc --change-type-id "ct-2epp05svrlwod" --change-type-version "3.0" --title "TITLE" --execution-parameters "{\"KeyDescription\": \"Example description\", \"KeyPermissions\": \"key permissions\", \"Operation\": \"Create\"}"

TEMPLATE CREATE:

  1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateKmsKeyParams.json:

    aws amscm get-change-type-version --change-type-id "ct-2epp05svrlwod" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateKmsKeyParams.json

  2. Modify and save the CreateKmsKeyParams file. For example, you can replace the contents with something like this:

    {
  "Description": "KMS key request",
  "KeyPermissions": "{\"Id\":\"key-consolepolicy-3\",\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Allow use of the key\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"arn:aws:iam::111122223333:role/KMSRole\"]},\"Action\":[\"kms:Encrypt\",\"kms:Decrypt\",\"kms:ReEncrypt*\",\"kms:GenerateDataKey*\",\"kms:DescribeKey\"],\"Resource\":\"*\"}]}",
  "Operation": "Create"
}

  3. Output the RFC template JSON file to a file; this example names it CreateKmsKeyRfc.json:

    aws amscm create-rfc --generate-cli-skeleton > CreateKmsKeyRfc.json

  4. Modify and save the CreateKmsKeyRfc.json file. For example, you can replace the contents with something like this:

    {
"ChangeTypeVersion":    "3.0",
"ChangeTypeId":         "ct-2epp05svrlwod",
"Title":                "KmsKey-Create-RFC"
}

  5. Create the RFC, specifying the CreateKmsKey Rfc file and the CreateKmsKeyParams file:

    aws amscm create-rfc --cli-input-json file://CreateKmsKeyRfc.json  --execution-parameters file://CreateKmsKeyParams.json

    You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start.

Note

This change type is at v3.0. The required KeyName parameter has been replaced by an optional AliasName parameter; KMS keys use aliases.

This is a "review required" change type (an AMS operator must review and run the CT), which means that the RFC can take longer to run and you might have to communicate with AMS through the RFC details page correspondance option. Additionally, if you schedule a "review required" change type RFC, be sure to allow at least 24 hours, if approval does not happen before the scheduled start time, the RFC is rejected automatically.

To learn more about AWS KMS keys, see AWS Key Management Service (KMS), AWS Key Management Service FAQs, and AWS Key Management Service Concepts.

Execution Input Parameters

For detailed information about the execution input parameters, see Schema for Change Type ct-2epp05svrlwod.

Example: Required Parameters

{
  "KeyDescription": "Exmample description of the key to be created.",
  "KeyPermissions": "KMS Key permissions to add: kms:Get",
  "Operation": "Create"
}

Example: All Parameters

{
  "KeyDescription": "Exmample description of the key to be created.",
  "AliasName": "testkmskey",
  "KeyRotation": true,
  "KeyPermissions": "KMS Key permissions to add: kms:Get",
  "MultiRegion": false,
  "Tags": [
    {
      "Key": "foo",
      "Value": "bar"
    },
    {
      "Key": "testkey",
      "Value": "testvalue"
    }
  ],
  "Operation": "Create",
  "Priority": "Medium"
}