AWS managedservices documentation change
Summary
Added documentation for 'High availability one-tier stacks' creation process
Security assessment
Focuses on infrastructure provisioning without specific security features or vulnerabilities addressed
Diff
diff --git a/managedservices/latest/ctexguide/review-walkthroughs.md b/managedservices/latest/ctexguide/review-walkthroughs.md index 41ed70632..6b6f55bc2 100644 --- a//managedservices/latest/ctexguide/review-walkthroughs.md +++ b//managedservices/latest/ctexguide/review-walkthroughs.md @@ -5 +5 @@ -Create IAM entity or policy (review required)Continue rollback on custom AWS CloudFormation stackManage the VPC Subnet IPv4 Address Auto AssigmentSchedule addDelete EBS snapshot (Review Required)Update SNS topicCreate an S3 access pointCreate Custom RDS Parameter GroupAdd event notification to an Amazon S3 bucketUpdate custom deny list for AMS Automated IAM ProvisioningMigrate AWS Managed Account DNS resolver to Route 53 for SALZ accounts (review required)Disassociate resolver rules from VPCUpdate Enhanced MonitoringAssociate VPC with Resolver RuleDeploy AMS pattern (review required)Share AWS KMS KeyCreate Active Directory TrustOverride Stack Access Duration (Review required)Enable automated IAM provisioning with read-write permissionsAdd VPC static route (review required)Create IAM entity or policyUpdate IAM entity or policyDelete IAM entity or policyUpdate detailed monitoringShare directoryUnshare directoryCreate VPC endpointUpdate RDS storageUpdate an RDS multi-AZ deploymentUpdate an RDS instance typeUpdate S3 bucket versioningUpdate S3 bucket encryptionUpdating an application account (review required)Associate private IP addresses (review required) ct-1pvlhug439gl2Create Amazon RDS option group (review required)Remove TGW static routeCreate for WIGS (Review Required)Modify EBS volumeUpdate AWS Backup plan (review required)Confirm offboardingManagement account: Offboard Application accountDeploy AMS Resource Scheduler SolutionUpdate AMS Resource Scheduler SolutionDelete or deactivate access keyCreate access keyEnable Detailed MonitoringUpdate the DeleteOnTermination option (review required)Update RDS maintainance window (review required)Update RDS performance insights (review required)Create security group (review required) +Delete target groups (review required)Create application load balancer (ALB)Update application load balancer (ALB)Create listenerHigh availability one-tier stacks: CreatingCreate IAM entity or policy (review required)Continue rollback on custom AWS CloudFormation stackManage the VPC Subnet IPv4 Address Auto AssigmentSchedule addDelete EBS snapshot (Review Required)Update SNS topicCreate an S3 access pointCreate Custom RDS Parameter GroupAdd event notification to an Amazon S3 bucketUpdate custom deny list for AMS Automated IAM ProvisioningMigrate AWS Managed Account DNS resolver to Route 53 for SALZ accounts (review required)Disassociate resolver rules from VPCUpdate Enhanced MonitoringAssociate VPC with Resolver RuleDeploy AMS pattern (review required)Share AWS KMS KeyCreate Active Directory TrustOverride Stack Access Duration (Review required)Enable automated IAM provisioning with read-write permissionsAdd VPC static route (review required)Create IAM entity or policyUpdate IAM entity or policyDelete IAM entity or policyUpdate detailed monitoringShare directoryUnshare directoryCreate VPC endpointUpdate RDS storageUpdate an RDS multi-AZ deploymentUpdate an RDS instance typeUpdate S3 bucket versioningUpdate S3 bucket encryptionUpdating an application account (review required)Associate private IP addresses (review required) ct-1pvlhug439gl2Create Amazon RDS option group (review required)Remove TGW static routeCreate for WIGS (Review Required)Modify EBS volumeUpdate AWS Backup plan (review required)Confirm offboardingManagement account: Offboard Application accountDeploy AMS Resource Scheduler SolutionUpdate AMS Resource Scheduler SolutionDelete or deactivate access keyCreate access keyEnable Detailed MonitoringUpdate the DeleteOnTermination option (review required)Update RDS maintainance window (review required)Update RDS performance insights (review required)Create security group (review required) @@ -10,0 +11,10 @@ Create IAM entity or policy (review required)Continue rollback on custom AWS Clo + * Delete target groups (review required) + + * Create application load balancer (ALB) + + * Update application load balancer (ALB) + + * Create listener + + * High availability one-tier stacks: Creating + @@ -113,0 +124,553 @@ Create IAM entity or policy (review required)Continue rollback on custom AWS Clo +## Delete target groups (review required) + +Screenshot of this change type in the AMS console: + + + +###### Note + +When using "review required" CTs, AMS recommends that you use the ASAP **Scheduling** option (choose **ASAP** in the console, leave start and end time blank in the API/CLI) as these CTs require an AMS operator to examine the RFC, and possibly communicate with you before it can be approved and run. If you schedule these RFCs, be sure to allow at least 24 hours. If approval does not happen before the scheduled start time, the RFC is rejected automatically. + +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 protected]\"]}}"` 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](https://docs.aws.amazon.com/managedservices/latest/ApiReference-cm/API_CreateRfc.html). + +_INLINE CREATE_ : + +Issue the create RFC command with execution parameters provided inline (escape quotation marks 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-0akjahmgqhu4u" --change-type-version "1.0" --title "Delete Target Group" --execution-parameters "{\"Region\":\"us-west-2\",\"TargetGroupArns\":[\"arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067\"],\"Priority\":\"High\"}"172.31.0.11\",\"172.31.0.12\"],\"InstancesPort\":[\"80\"],\"TargetGroupArn\":[\"arn:aws:elasticloadbalancing:us-east-1:00000000000:targetgroup/test-target-group/0000000000\"]}}" + +TEMPLATE CREATE: + + 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it TgDeleteParams.json. + + aws amscm get-change-type-version --change-type-id "ct-0akjahmgqhu4u" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > TgDeleteParams.json + + 2. Modify and save the TgDeleteParams file. For example, you can replace the contents with something like this: + + { + "Region": "us-west-2", + "TargetGroupArns": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + "Priority": "High" + } + + 3. Output the RFC template to a file in your current folder named TgDeleteRfc.json: + + aws amscm create-rfc --generate-cli-skeleton > TgDeleteRfc.json + + 4. Modify and save the TgDeleteRfc.json file. For example, you can replace the contents with something like this: + + { + "ChangeTypeVersion": "1.0", + "ChangeTypeId": "ct-0akjahmgqhu4u", + "Title": "Delete Target Group" + } + + 5. Create the RFC, specifying the TgDeleteRfc file and the TgDeleteParams file: + + aws amscm create-rfc --cli-input-json file://TgDeleteRfc.json --execution-parameters file://TgDeleteParams.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. + + + + +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. + + * Deleting a target group also deletes any associated health checks. + + * Deleting a target group does not affect its registered targets. + + * For information about target groups, see [ELB Target Groups](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html). + + + + +## Create application load balancer (ALB) + +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. + + + + +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 protected]\"]}}"` 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](https://docs.aws.amazon.com/managedservices/latest/ApiReference-cm/API_CreateRfc.html). + +_INLINE CREATE_ : + +Issue the create RFC command with execution parameters provided inline (escape quotation marks 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 --profile saml --region us-east-1 create-rfc --change-type-id "ct-111r1yayblnw4" --change-type-version "3.0" --title 'Create ALB' --description "My Test ALB" --execution-parameters ""{\"Description\":\"Test ALB\",\"VpcId\":\"VPC_ID\",\"Name\":\"TestStack\",\"StackTemplateId\":\"stm-sd7uv500000000000\",\"TimeoutInMinutes\":360,\"LoadBalancer\":{\"SecurityGroups\":[\"SG_ID\"],\"SubnetIds\":[\"SUBNET_ID\",\"SUBNET_ID\"]},\"Listener1\":{\"Port\":\"443\",\"Protocol\":\"HTTPS\"}}" + +_TEMPLATE CREATE_ : + + 1. Output the execution parameters JSON schema for this change type to a JSON file. For example, you can replace the contents with something like this: + + aws amscm get-change-type-version --change-type-id "ct-111r1yayblnw4" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateAlbParams.json + + 2. Modify and save the CreateAlbParams file. For example: + + { + "Description": "ALB-Create", + "VpcId": "VPC_ID", + "Name": "My-ALB", + "StackTemplateId": "stm-sd7uv500000000000", + "TimeoutInMinutes" : 360, + "LoadBalancer" : { + "SecurityGroups" : ["SG_ID"], + "SubnetIds" : ["SUBNET_ID", "SUBNET_ID"] + }, + "Listener1" : {