Self-Provisioned Service | Add (Review Required)

Add a specific, allowed, AWS service to your AMS account. AMS adds the necessary permissions to use the service to an existing IAM role that you specify, or creates a new role that allows you to use the service without AMS management under the AMS Shared Responsibility model. Compliance is a shared responsibility and your AMS compliance status does not automatically apply to services or applications that you add in this way. Some AWS services do not have compliance certifications. For more information, go to the AWS Services in Scope of AWS Assurance Program page. On that page, unless specifically excluded, features of each of the services are considered in scope of the assurance programs, and are reviewed and tested as part of the assessment.

Full classification: Management | AWS service | Self-provisioned service | Add (review required)

Change Type Details

Change type ID	ct-3qe6io8t6jtny
Current version	1.0
Expected execution duration	60 minutes
AWS approval	Required
Customer approval	Not required if submitter
Execution mode	Manual

Additional Information

Add Self-Service Provisioning service (review required)

Adding an AMS self-provisioned AWS service with the console

The following shows 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.

Adding an AMS self-provisioned AWS service with the CLI

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\" : [\"[e-mail]\"]}}" 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:

All parameters:

aws amscm create-rfc --title Add-Self-Serve-Service --change-type-id ct-3qe6io8t6jtny --change-type-version 1.0 --execution-parameters '{"ServiceName":"AWS Certificate Manager (ACM)","IAMRole":"arn:aws:iam::123456789012:role/customer_security_role", "SAMLProviders":"SAML_PROVIDER,SAML_PROVIDER"}'

Only required parameters:

aws amscm create-rfc --title add-self-serve-service --change-type-id ct-3qe6io8t6jtny --change-type-version 1.0 --execution-parameters '{"ServiceName":"AWS License Manager"}'

TEMPLATE CREATE:

1. Output the execution parameters for this change type to a JSON file named SelfServeServiceParams.json.

   aws amscm get-change-type-version --change-type-id "ct-3qe6io8t6jtny" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > SelfServeServiceParams.json

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

   {
   "ServiceName":   "AWS Certificate Manager (ACM)",
   "IAMRole":       "arn:aws:iam::123456789012:role/customer_security_role",
   "SAMLProviders": "SAML_PROVIDER, SAML_PROVIDER"
   }

3. Output the RFC template to a file in your current folder; this example names it SelfServeServiceRfc.json:

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

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

   {
   "ChangeTypeId":         "ct-3qe6io8t6jtny",
   "ChangeTypeVersion":    "1.0",
   "Title":                "Self-Serve-Service-RFC"
   }

5. Create the RFC, specifying the SelfServeServiceRfc file and the SelfServeServiceParams file:

   aws amscm create-rfc --cli-input-json file://SelfServeServiceRfc.json  --execution-parameters file://SelfServeServiceParams.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.

Tips

• For automated deployment of most self-provisioned services with default roles, use: Management | AWS service | Self-provisioned service | Add (no review required) (ct-1w8z66n899dct). See Add Self-Service Provisioning service. UUse this "review required" change type (ct-3qe6io8t6jtny) for services not supported by ct-1w8z66n899dct or for deployments with custom parameters.

• For a list of which self-provisioned services you can add using CloudFormation Ingest, see CloudFormation Ingest stack: supported resources.

• 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.

• The ServiceName parameter is limited to AMS-approved AWS services. For a list, see Setting Up Self-serve Services.

Execution Input Parameters

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

Example: Required Parameters

{
  "ServiceName": "AWS License Manager"
}

Example: All Parameters

{
  "ServiceName": "AWS License Manager",
  "IAMRole": "arn:aws:iam::123456789012:role/myrole",
  "SAMLProviders": "foo-saml-provider",
  "Priority": "Medium"
}