Update ReadOnly access - AMS Advanced Change Management User Guide

Update ReadOnly access

How to update ReadOnly access to a stand-alone EC2 stack instance or to instances that are part of an EC2 Auto Scaling group (ASG) stack using the AMS console or the AMS API/CLI.

For an example about updating Admin access, see Admin access: updating.

Classification: Management | Access | Stack read-only access | Update

Change type ID: ct-3kh1wiizlne1i

Version: 2.0

Required data:

  • Subject: This value displays on the RFC dashboard.

  • DomainFQDN: Provide the Fully Qualified Domain Name (FQDN) of your AMS-trusted domain. If you’re unsure, you can use the AWS Management Console for Directory Services (under Security and Identity) Directory Name tab.

  • StackIds: An array of stack identifiers that you want to access. You can find stack IDs by looking on the Stacks dashboard of the AMS console or by running the ListStackSummaries operation of the SKMS API (list-stack-summaries in the CLI). For the AMS SKMS API reference, see the Reports tab in the AWS Artifact Console.

  • Username: The Active Directory user name of the person who wants access.

  • VpcId: The ID of the VPC where the stacks are that you want access to. You can find this by looking on the VPCs dashboard of the AMS console or by running the ListVpcSummaries operation of the SKMS API (list-vpc-summaries in the CLI). For the AMS SKMS API reference, see the Reports tab in the AWS Artifact Console..

Optional data:

  • TimeRequestedInHours: The amount of time, in hours, requested for access to the instance. Access is ended after this time.

The following shows this change type in the AMS console.

How it works:

  1. Navigate to the Create RFC page: RFCs -> 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, 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 --profile saml amscm create-rfc --change-type-id "ct-3kh1wiizlne1i" --change-type-version "2.0" --title "Stack-RO-Update-QC" --execution-parameters "{\"DomainFQDN\":\"TEST.com\",\"StackIds\":[\"stack-01234567890abcdef\"],\"TimeRequestedInHours\":1,\"Username\":\"TEST\",\"VpcId\":\"VPC_ID\"}"

TEMPLATE CREATE:

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

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

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

    { "DomainFQDN": "mycorpdomain.acme.com", "StackIds": [STACK_ID, STACK_ID], "TimeRequestedInHours": 8, "Username": "USERNAME", "VpcId": "VPC_ID" }

    Note that the TimeRequestedInHours option defaults to one hour. You may request up to eight hours.

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

    aws amscm create-rfc --generate-cli-skeleton > UpdateReadOnlyAccessRfc.json
  3. Modify and save the UpdateReadOnlyAccessRfc.json file. For example, you can replace the contents with something like this:

    { "ChangeTypeId": "ct-3kh1wiizlne1i", "ChangeTypeVersion": "2.0", "Title": "Update-ReadOnly-Access-to-EC2-RFC" }
  4. Create the RFC, specifying the UpdateReadOnlyAccessRfc file and the UpdateReadOnlyAcessParams file:

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

    To log in to the instance through a bastion, follow the next procedure, Instance access examples.