Split (1)

train · 107k rows

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
systems-manager-automation-runbook-guide-098	systems-manager-automation-runbook-guide.pdf	98	• AWSSupport-TroubleshootEKSWorkerNode • AWS-UpdateEKSCluster • AWS-UpdateEKSManagedNodeGroup • AWS-UpdateEKSSelfManagedLinuxNodeGroups • AWSSupport-SetupK8sApiProxyForEKS • AWSSupport-TroubleshootEbsCsiDriversForEks AWSSupport-CollectEKSInstanceLogs Description Amazon EKS 387 AWS Systems Manager Automation runbook reference User Guide The AWSSupport-CollectEKSInstanceLogs runbook gathers operating system and Amazon Elastic Kubernetes Service (Amazon EKS) related log ﬁles from an Amazon Elastic Compute Cloud (Amazon EC2) instance to help you troubleshoot common issues. While the automation is gathering the associated log ﬁles, changes are made to the ﬁle system structure including the creation of temporary directories, the copying of log ﬁles to the temporary directories, and compressing the log ﬁles into an archive. This activity can result in increased CPUUtilization on the EC2 instance. For more information about CPUUtilization , see Instance metrics in the Amazon CloudWatch User Guide . If you specify a value for the LogDestination parameter, the automation evaluates the policy status of the Amazon Simple Storage Service (Amazon S3) bucket you specify. To help with the security of the logs gathered from your EC2 instance, if the policy status isPublic is set to true , or if the access control list (ACL) grants READ\|WRITE permissions to the All Users Amazon S3 predeﬁned group, the logs are not uploaded. For more information about Amazon S3 predeﬁned groups, see Amazon S3 predeﬁned groups in the Amazon Simple Storage Service User Guide . Note This automation requires at least 10 percent of available disk space on the root Amazon Elastic Block Store (Amazon EBS) volume attached to your EC2 instance. If there is not enough available disk space on the root volume, the automation stops. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux Parameters • AutomationAssumeRole AWSSupport-CollectEKSInstanceLogs 388 AWS Systems Manager Automation runbook reference User Guide Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • EKSInstanceId Type: String Description: (Required) ID of the Amazon EKS EC2 instance you want to collect logs from. • LogDestination Type: String Description: (Optional) The S3 bucket in your account to upload the archived logs to. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • ssm:SendCommand We recommend that the EC2 instance receiving the command has an IAM role with the AmazonSSMManagedInstanceCore Amazon managed policy attached. To upload the log archive to the S3 bucket you specify in the LogDestination parameter, you must add the s3:PutObject permission. Document Steps • aws:assertAwsResourceProperty - Conﬁrms the operating system of the value speciﬁed in the EKSInstanceId parameter is Linux. • aws:runCommand - Gathers operating system and Amazon EKS related log ﬁles, compressing them into an archive in the /var/log directory. AWSSupport-CollectEKSInstanceLogs 389 AWS Systems Manager Automation runbook reference User Guide • aws:branch - Conﬁrms whether a value was speciﬁed for the LogDestination parameter. • aws:runCommand - Uploads the log archive to the S3 bucket you specify in the LogDestination parameter. AWS-CreateEKSClusterWithFargateProfile Description The AWS-CreateEKSClusterWithFargateProfile runbook creates an Amazon Elastic Kubernetes Service (Amazon EKS) cluster using an AWS Fargate. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • ClusterName Type: String Description: (Required) A unique name for the cluster. AWS-CreateEKSClusterWithFargateProfile 390 AWS Systems Manager Automation runbook reference User Guide • ClusterRoleArn Type: String Description: (Required) The ARN of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. • FargateProﬁleName Type: String Description: (Required) The name of the Fargate proﬁle. • FargateProﬁleRoleArn Type: String Description: (Required) The ARN of the Amazon EKS Pod execution IAM role. • FargateProﬁleSelectors Type: String Description: (Required) The selectors to match pods to the Fargate proﬁle. • SubnetIds Type: StringList Description: (Required) The IDs of the subnets you want to use for your Amazon EKS cluster. Amazon EKS creates elastic network interfaces in these subnets for communication between your nodes and the Kubernetes control plane. You must specify at least two subnet IDs. • EKSEndpointPrivateAccess Type: Boolean Default: True Description: (Optional) Set this value to True to allow private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs include the necessary CIDR
systems-manager-automation-runbook-guide-099	systems-manager-automation-runbook-guide.pdf	99	to use for your Amazon EKS cluster. Amazon EKS creates elastic network interfaces in these subnets for communication between your nodes and the Kubernetes control plane. You must specify at least two subnet IDs. • EKSEndpointPrivateAccess Type: Boolean Default: True Description: (Optional) Set this value to True to allow private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs include the necessary CIDR blocks for communication with the nodes or Fargate pods. • EKSEndpointPublicAccess AWS-CreateEKSClusterWithFargateProfile 391 AWS Systems Manager Automation runbook reference User Guide Type: Boolean Default: False Description: (Optional) Set this value to False to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the VPC where it was launched. • PublicAccessCIDRs Type: StringList Description: (Optional) The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. If you've disabled private endpoint access and you have nodes or Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. • SecurityGroupIds Type: StringList Description: (Optional) Specify one or more security groups to associate with the elastic network interfaces created in your account by Amazon EKS. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:GetAutomationExecution • ssm:StartAutomationExecution • ec2:DescribeRouteTables • ec2:DescribeSubnets • ec2:DescribeVpcs • eks:CreateCluster • eks:CreateFargateProfile • eks:DescribeCluster • eks:DescribeFargateProfile AWS-CreateEKSClusterWithFargateProfile 392 AWS Systems Manager Automation runbook reference User Guide • iam:CreateServiceLinkedRole • iam:GetRole • iam:ListAttachedRolePolicies • iam:PassRole Document Steps • CreateEKSCluster (aws:executeAwsApi) - Creates an Amazon EKS cluster. • VerifyEKSClusterIsActive (aws:waitForAwsResourceProperty) - Veriﬁes the cluster state is ACTIVE. • CreateFargateProﬁle (aws:executeAwsApi) - Creates a Fargate for the cluster. • VerifyFargateProﬁleIsActive (aws:waitForAwsResourceProperty) - Veriﬁes the Fargate proﬁle state is ACTIVE. Outputs CreateEKSCluster.CreateClusterResponse Description: Response received from the CreateCluster API call. CreateFargateProfile.CreateFargateProfileResponse Description: Response received from the CreateFargateProfile API call. AWS-CreateEKSClusterWithNodegroup Description The AWS-CreateEKSClusterWithNodegroup runbook creates an Amazon Elastic Kubernetes Service (Amazon EKS) cluster using a node group for capacity. Run this Automation (console) Document type Automation Owner AWS-CreateEKSClusterWithNodegroup 393 AWS Systems Manager Automation runbook reference User Guide Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • ClusterName Type: String Description: (Required) A unique name for the cluster. • ClusterRoleArn Type: String Description: (Required) The ARN of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. • NodegroupName Type: String Description: (Required) A unique name for the node group. • NodegroupRoleArn Type: String Description: (Required) The ARN of the IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance proﬁle and associated policies. Before you can launch nodes and register them into a cluster, you must create an IAM role for those nodes to use when they are launched. AWS-CreateEKSClusterWithNodegroup 394 AWS Systems Manager Automation runbook reference User Guide • SubnetIds Type: StringList Description: (Required) The IDs of the subnets you want to use for your Amazon EKS cluster. Amazon EKS creates elastic network interfaces in these subnets for communication between your nodes and the Kubernetes control plane. You must specify at least two subnet IDs. • EKSEndpointPrivateAccess Type: Boolean Default: True Description: (Optional) Set this value to True to allow private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs include the necessary CIDR blocks for communication with the nodes or Fargate pods. • EKSEndpointPublicAccess Type: Boolean Default: False Description: (Optional) Set this value to False to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the VPC where it was launched. • PublicAccessCIDRs Type: StringList Description: (Optional) The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you
systems-manager-automation-runbook-guide-100	systems-manager-automation-runbook-guide.pdf	100	in the cluster, then ensure that publicAccessCidrs include the necessary CIDR blocks for communication with the nodes or Fargate pods. • EKSEndpointPublicAccess Type: Boolean Default: False Description: (Optional) Set this value to False to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the VPC where it was launched. • PublicAccessCIDRs Type: StringList Description: (Optional) The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. If you've disabled private endpoint access and you have nodes or Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. • SecurityGroupIds Type: StringList AWS-CreateEKSClusterWithNodegroup 395 AWS Systems Manager Automation runbook reference User Guide Description: (Optional) Specify one or more security groups to associate with the elastic network interfaces created in your account by Amazon EKS. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • ec2:DescribeSubnets • eks:CreateCluster • eks:CreateNodegroup • eks:DescribeCluster • eks:DescribeNodegroup • iam:CreateServiceLinkedRole • iam:GetRole • iam:ListAttachedRolePolicies • iam:PassRole Document Steps • CreateEKSCluster (aws:executeAwsApi) - Creates an Amazon EKS cluster. • VerifyEKSClusterIsActive (aws:waitForAwsResourceProperty) - Veriﬁes the cluster state is ACTIVE. • CreateNodegroup (aws:executeAwsApi) - Creates a node group for the cluster. • VerifyNodegroupIsActive (aws:waitForAwsResourceProperty) - Veriﬁes the node group state is ACTIVE. Outputs • CreateEKSCluster.CreateClusterResponse: Response received from the CreateCluster API call. AWS-CreateEKSClusterWithNodegroup 396 AWS Systems Manager Automation runbook reference User Guide • CreateNodegroup.CreateNodegroupResponse: Response received from the CreateNodegroup API call. AWS-DeleteEKSCluster Description This runbook deletes the resources associated with an Amazon EKS cluster, including node groups and Fargate proﬁles. Optionally, you can choose to delete all self-managed nodes, the AWS CloudFormation stacks used to create the nodes, and the VPC CloudFormation stack for your cluster. For more information about deleting a cluster, see Deleting a cluster in the Amazon EKS User Guide. Note If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster. If you don't, the system can't delete the load balancers. Use the following procedure to ﬁnd and delete services before you run the AWS-DeleteEKSCluster runbook. To locate and delete services in your cluster 1. Install the Kubernetes command line utility, kubectl . For more information, see Installing kubectl in the Amazon EKS User Guide. 2. Run the following command to list all services running in your cluster. kubectl get svc --all-namespaces 3. Run the following command to delete any services that have an associated EXTERNAL-IP value. These services are fronted by a load balancer, and you must delete them in Kubernetes to allow the load balancer and associated resources to be properly released. kubectl delete svc service-name AWS-DeleteEKSCluster 397 AWS Systems Manager Automation runbook reference User Guide You can now run the AWS-DeleteEKSCluster runbook. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • EKSClusterName Type: String Description: (Required) The name of the Amazon EKS Cluster to be deleted. • VPCCloudFormationStack Type: String Description: (Optional) AWS CloudFormation stack name for VPC for the EKS cluster being deleted. This deletes the AWS CloudFormation stack for VPC and any resources created by the stack. • VPCCloudFormationStackRole Type: String AWS-DeleteEKSCluster 398 AWS Systems Manager Automation runbook reference User Guide Description: (Optional) The ARN of an IAM role that AWS CloudFormation assumes to delete the VPC CloudFormation stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. • SelfManagedNodeStacks Type: String Description: (Optional) Comma-separated list of AWS CloudFormation stack names for self- managed nodes, This will delete the AWS CloudFormation stacks for self-managed nodes. • SelfManagedNodeStacksRole Type: String Description: (Optional) The ARN of an IAM role that AWS CloudFormation assumes to delete the Self-managed Node Stacks. AWS CloudFormation uses the role's credentials to make calls on your behalf. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • sts:AssumeRole • eks:ListNodegroups • eks:DeleteNodegroup • eks:ListFargateProfiles • eks:DeleteFargateProfile • eks:DeleteCluster • cfn:DescribeStacks • cfn:DeleteStack Document Steps • aws:executeScript - DeleteNodeGroups: Find and delete all node groups in the EKS cluster. AWS-DeleteEKSCluster 399 AWS Systems Manager Automation runbook reference User Guide • aws:executeScript - DeleteFargateProﬁles: Find and delete all Fargate proﬁles in the EKS cluster. • aws:executeScript - DeleteSelfManagedNodes: Delete all self-managed nodes and the CloudFormation stacks used to create the nodes.
systems-manager-automation-runbook-guide-101	systems-manager-automation-runbook-guide.pdf	101	AWS CloudFormation uses the role's credentials to make calls on your behalf. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • sts:AssumeRole • eks:ListNodegroups • eks:DeleteNodegroup • eks:ListFargateProfiles • eks:DeleteFargateProfile • eks:DeleteCluster • cfn:DescribeStacks • cfn:DeleteStack Document Steps • aws:executeScript - DeleteNodeGroups: Find and delete all node groups in the EKS cluster. AWS-DeleteEKSCluster 399 AWS Systems Manager Automation runbook reference User Guide • aws:executeScript - DeleteFargateProﬁles: Find and delete all Fargate proﬁles in the EKS cluster. • aws:executeScript - DeleteSelfManagedNodes: Delete all self-managed nodes and the CloudFormation stacks used to create the nodes. • aws:executeScript - DeleteEKSCluster: Delete EKS cluster. • aws:executeScript - DeleteVPCCloudFormationStack: Delete the VPC CloudFormation stack. AWS-MigrateToNewEKSSelfManagedNodeGroup Description The AWS-MigrateToNewEKSSelfManagedNodeGroup runbook helps you create a new Amazon Elastic Kubernetes Service (Amazon EKS) Linux node group to migrate your existing application to. For more information, see Migrating to a new node group in the Amazon EKS User Guide. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux Parameters • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. AWS-MigrateToNewEKSSelfManagedNodeGroup 400 AWS Systems Manager Automation runbook reference User Guide • OldStackName Type: String Description: (Required) The name or stack ID of your existing AWS CloudFormation stack. • NewStackName Type: String Description: (Optional) The name of the new AWS CloudFormation stack that is created for your new node group. If you don't specify a value for this parameter, the stack name is created using the format: NewNodeGroup-ClusterName-AutomationExecutionID. • ClusterControlPlaneSecurityGroup Type: String Description: (Optional) The ID of the security group you want nodes to use to communicate with the Amazon EKS control plane. If you don't specify a value for this parameter, the security group speciﬁed in your existing AWS CloudFormation stack is used. • NodeInstanceType Type: String Description: (Optional) The instance type that you want to use for the new node group. If you don't specify a value for this parameter, the instance type speciﬁed in your existing AWS CloudFormation stack is used. • NodeGroupName Type: String Description: (Optional) The name of your new node group. If you don't specify a value for this parameter, the node group name speciﬁed in your existing AWS CloudFormation stack is used. • NodeAutoScalingGroupDesiredCapacity Type: String Description: (Optional) The desired number of nodes to scale to when your new stack is created. This number must be greater than or equal to the NodeAutoScalingGroupMinSize value and less than or equal to the NodeAutoScalingGroupMaxSize. If you don't specify a value for this 401 AWS-MigrateToNewEKSSelfManagedNodeGroup AWS Systems Manager Automation runbook reference User Guide parameter, the node group desired capacity speciﬁed in your existing AWS CloudFormation stack is used. • NodeAutoScalingGroupMaxSize Type: String Description: (Optional) The maximum number of nodes that your node group can scale out to. If you don't specify a value for this parameter, the node group maximum size speciﬁed in your existing AWS CloudFormation stack is used. • NodeAutoScalingGroupMinSize Type: String Description: (Optional) The minimum number of nodes that your node group can scale in to. If you don't specify a value for this parameter, the node group minimum size speciﬁed in your existing AWS CloudFormation stack is used. • NodeImageId Type: String Description: (Optional) The ID of the Amazon Machine Image (AMI) that you want the node group to use. • NodeImageIdSSMParam Type: String Description: (Optional) The public Systems Manager parameter for the AMI that you want the node group to use. • NodeVolumeSize Type: String Description: (Optional) The size of the root volume for your nodes in GiB. If you don't specify a value for this parameter, the node volume size speciﬁed in your existing AWS CloudFormation stack is used. • NodeVolumeType Type: String AWS-MigrateToNewEKSSelfManagedNodeGroup 402 AWS Systems Manager Automation runbook reference User Guide Description: (Optional) The type of Amazon EBS volume you want to use for the root volume of your nodes. If you don't specify a value for this parameter, the volume type speciﬁed in your existing AWS CloudFormation stack is used. • KeyName Type: String Description: (Optional) The key pair you want to assign to your nodes. If you don't specify a value for this parameter, the key pair speciﬁed in your existing AWS CloudFormation stack is used. • Subnets Type: StringList Description: (Optional) A comma-separated list of the subnet IDs that you want to use for your new node group. If you don't specify a value for this parameter, the subnets speciﬁed in your existing AWS CloudFormation stack is used. • DisableIMDSv1 Type: Boolean Description: (Optional) Specify true to disable Instance Metadata Service Version 1 (IMDSv1). By default, nodes
systems-manager-automation-runbook-guide-102	systems-manager-automation-runbook-guide.pdf	102	used. • KeyName Type: String Description: (Optional) The key pair you want to assign to your nodes. If you don't specify a value for this parameter, the key pair speciﬁed in your existing AWS CloudFormation stack is used. • Subnets Type: StringList Description: (Optional) A comma-separated list of the subnet IDs that you want to use for your new node group. If you don't specify a value for this parameter, the subnets speciﬁed in your existing AWS CloudFormation stack is used. • DisableIMDSv1 Type: Boolean Description: (Optional) Specify true to disable Instance Metadata Service Version 1 (IMDSv1). By default, nodes support IMDSv1 and IMDSv2. • BootstrapArguments Type: String Description: (Optional) Additional arguments you want to pass to the node bootstrap script. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • ssm:GetParameters • autoscaling:CreateAutoScalingGroup AWS-MigrateToNewEKSSelfManagedNodeGroup 403 AWS Systems Manager Automation runbook reference User Guide • autoscaling:CreateOrUpdateTags • autoscaling:DeleteTags • autoscaling:DescribeAutoScalingGroups • autoscaling:DescribeScalingActivities • autoscaling:DescribeScheduledActions • autoscaling:SetDesiredCapacity • autoscaling:TerminateInstanceInAutoScalingGroup • autoscaling:UpdateAutoScalingGroup • cloudformation:CreateStack • cloudformation:DescribeStackResource • cloudformation:DescribeStacks • cloudformation:UpdateStack • ec2:AuthorizeSecurityGroupEgress • ec2:AuthorizeSecurityGroupIngress • ec2:CreateLaunchTemplateVersion • ec2:CreateLaunchTemplate • ec2:CreateSecurityGroup • ec2:CreateTags • ec2:DeleteLaunchTemplate • ec2:DeleteSecurityGroup • ec2:DescribeAvailabilityZones • ec2:DescribeImages • ec2:DescribeInstanceAttribute • ec2:DescribeInstanceStatus • ec2:DescribeInstances • ec2:DescribeKeyPairs • ec2:DescribeLaunchTemplateVersions • ec2:DescribeLaunchTemplates • ec2:DescribeSecurityGroups AWS-MigrateToNewEKSSelfManagedNodeGroup 404 AWS Systems Manager Automation runbook reference User Guide • ec2:DescribeSubnets • ec2:DescribeVpcs • ec2:RevokeSecurityGroupEgress • ec2:RevokeSecurityGroupIngress • ec2:RunInstances • ec2:TerminateInstances • iam:AddRoleToInstanceProfile • iam:AttachRolePolicy • iam:CreateInstanceProfile • iam:CreateRole • iam:GetInstanceProfile • iam:GetRole • iam:PassRole Document Steps • DetermineParameterValuesForNewNodeGroup (aws:executeScript) - Gathers the parameter values to use for the new node group. • CreateStack (aws:createStack) - Creates the AWS CloudFormation stack for the new node group. • GetNewStackNodeInstanceRole (aws:executeAwsApi) - Gets the node instance role. • GetNewStackSecurityGroup (aws:executeAwsApi) - The step gets the node security group. • AddIngressRulesToNewNodeSecurityGroup (aws:executeAwsApi) - Adds ingress rules to the newly created security group so it can accept traﬃc from the one assigned to your previous node group. • AddIngressRulesToOldNodeSecurityGroup (aws:executeAwsApi) - Adds ingress rules to the previous security group so it can accept traﬃc from the one assigned to your newly created node group. • VerifyStackComplete (aws:assertAwsResourceProperty) - Veriﬁes the new stack status is CREATE_COMPLETE. Outputs AWS-MigrateToNewEKSSelfManagedNodeGroup 405 AWS Systems Manager Automation runbook reference User Guide DetermineParameterValuesForNewNodeGroup.NewStackParameters - The parameters used to create the new stack. GetNewStackNodeInstanceRole.NewNodeInstanceRole - The node instance role for the new node group. GetNewStackSecurityGroup.NewNodeSecurityGroup - The ID of the security group for the new node group. DetermineParameterValuesForNewNodeGroup.NewStackName - The AWS CloudFormation stack name for the new node group. CreateStack.StackId - The AWS CloudFormation stack ID for the new node group. AWSPremiumSupport-TroubleshootEKSCluster Description The AWSPremiumSupport-TroubleshootEKSCluster runbook diagnoses common issues with an Amazon Elastic Kubernetes Service (Amazon EKS) cluster, underlying infrastructure, and provides recommended remediation steps. Important Access to AWSPremiumSupport-* runbooks requires either an Enterprise or Business Support Subscription. For more information, see Compare AWS Support Plans . If you specify a value for the S3BucketName parameter, the automation evaluates the policy status of the Amazon Simple Storage Service (Amazon S3) bucket you specify. To help with the security of the logs gathered from your EC2 instance, if the policy status isPublic is set to true , or if the access control list (ACL) grants READ\|WRITE permissions to the All Users Amazon S3 predeﬁned group, the logs are not uploaded. For more information about Amazon S3 predeﬁned groups, see Amazon S3 predeﬁned groups in the Amazon Simple Storage Service User Guide . Run this Automation (console) Document type Automation AWSPremiumSupport-TroubleshootEKSCluster 406 AWS Systems Manager Automation runbook reference User Guide Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • ClusterName Type: String Description: (Required) The name of the Amazon EKS cluster that you want to troubleshoot. • S3BucketName Type: String Description: (Required) The name of the private Amazon S3 bucket where the report generated by the runbook should be uploaded. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • ec2:DescribeInstances • ec2:DescribeInstanceTypes AWSPremiumSupport-TroubleshootEKSCluster 407 AWS Systems Manager Automation runbook reference User Guide • ec2:DescribeSubnets • ec2:DescribeSecurityGroups • ec2:DescribeRouteTables • ec2:DescribeNatGateways • ec2:DescribeVpcs • ec2:DescribeNetworkAcls • iam:GetInstanceProfile • iam:ListInstanceProfiles • iam:ListAttachedRolePolicies • eks:DescribeCluster • eks:ListNodegroups • eks:DescribeNodegroup • autoscaling:DescribeAutoScalingGroups In addition, the AWS Identity and Access Management (IAM) policy attached to the user or role that starts the automation must allow the ssm:GetParameter operation to the following public AWS Systems Manager parameters to get the latest recommended Amazon EKS Amazon Machine Image (AMI) for the worker nodes. • arn:aws:ssm:::parameter/aws/service/eks/optimized-ami/*/amazon-linux-2/ recommended/image_id •
systems-manager-automation-runbook-guide-103	systems-manager-automation-runbook-guide.pdf	103	use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • ec2:DescribeInstances • ec2:DescribeInstanceTypes AWSPremiumSupport-TroubleshootEKSCluster 407 AWS Systems Manager Automation runbook reference User Guide • ec2:DescribeSubnets • ec2:DescribeSecurityGroups • ec2:DescribeRouteTables • ec2:DescribeNatGateways • ec2:DescribeVpcs • ec2:DescribeNetworkAcls • iam:GetInstanceProfile • iam:ListInstanceProfiles • iam:ListAttachedRolePolicies • eks:DescribeCluster • eks:ListNodegroups • eks:DescribeNodegroup • autoscaling:DescribeAutoScalingGroups In addition, the AWS Identity and Access Management (IAM) policy attached to the user or role that starts the automation must allow the ssm:GetParameter operation to the following public AWS Systems Manager parameters to get the latest recommended Amazon EKS Amazon Machine Image (AMI) for the worker nodes. • arn:aws:ssm:::parameter/aws/service/eks/optimized-ami//amazon-linux-2/ recommended/image_id • arn:aws:ssm:::parameter/aws/service/ami-windows-latest/ Windows_Server-2019-English-Core-EKS_Optimized-/image_id • arn:aws:ssm:::parameter/aws/service/ami-windows-latest/ Windows_Server-2019-English-Full-EKS_Optimized-/image_id • arn:aws:ssm:::parameter/aws/service/ami-windows-latest/ Windows_Server-1909-English-Core-EKS_Optimized-/image_id • arn:aws:ssm:::parameter/aws/service/eks/optimized-ami/*/amazon-linux-2- gpu/recommended/image_id To upload the report generated by the runbook to an Amazon S3 bucket, the following permissions are required for the speciﬁed Amazon S3 bucket you specify. AWSPremiumSupport-TroubleshootEKSCluster 408 AWS Systems Manager Automation runbook reference User Guide • s3:GetBucketPolicyStatus • s3:GetBucketAcl • s3:PutObject Document Steps • aws:executeAwsApi - Gathers details for the speciﬁed Amazon EKS cluster. • aws:executeScript - Gathers details of the Amazon Elastic Compute Cloud (Amazon EC2) instances, Auto Scaling groups, AMIs, and Amazon EC2 GPU graphic instance types. • aws:executeScript - Gathers details of the virtual private cloud (VPC), subnets, network address translation (NAT) gateways, subnet routes, security groups and network access control lists (ACLs) of the Amazon EKS cluster. • aws:executeScript - Gathers details of attached IAM instance proﬁles and role policies. • aws:executeScript - Gathers details of the Amazon S3 bucket you specify in the S3BucketName parameter. • aws:executeScript - Classiﬁes the Amazon VPC subnets as public or private. • aws:executeScript - Checks the Amazon VPC subnets for tags that are required as part of an Amazon EKS cluster. • aws:executeScript - Checks the Amazon VPC subnets for the tags that are required for Elastic Load Balancing subnets. • aws:executeScript - Checks if the worker node Amazon EC2 instances use the latest Amazon EKS optimized AMIs • aws:executeScript - Checks if the Amazon VPC security groups attached to worker nodes for the tags that are required. • aws:executeScript - Checks the Amazon EKS cluster and worker node Amazon VPC security group rules for the recommended ingress rules to the Amazon EKS cluster. • aws:executeScript - Checks the Amazon EKS cluster and worker node Amazon VPC security group rules for the recommended egress rules from the Amazon EKS cluster. • aws:executeScript - Checks the network ACL conﬁguration of the Amazon VPC subnets. • aws:executeScript - Checks if the worker node Amazon EC2 instances have the required managed policies. • aws:executeScript - Checks if the Auto Scaling groups have the necessary tags for cluster autoscaling. AWSPremiumSupport-TroubleshootEKSCluster 409 AWS Systems Manager Automation runbook reference User Guide • aws:executeScript - Checks if the worker node Amazon EC2 instances are connected to the internet. • aws:executeScript - Generates a report based on the outputs from the previous steps. If a value is speciﬁed for the S3BucketName parameter, the generated report is uploaded to the Amazon S3 bucket. AWSSupport-TroubleshootEKSWorkerNode Description The AWSSupport-TroubleshootEKSWorkerNode runbook analyzes an Amazon Elastic Compute Cloud (Amazon EC2) worker node and Amazon Elastic Kubernetes Service (Amazon EKS) cluster to help you identify and troubleshoot common causes that prevent worker nodes from joining a cluster. The runbook outputs guidance to help you resolve any issues that are identiﬁed. Important To successfully run this automation, the state of your Amazon EC2 worker node must be running , and the Amazon EKS cluster state must be ACTIVE . Run this Automation (console) Document type Automation Owner Amazon Platforms Linux Parameters • AutomationAssumeRole Type: String AWSSupport-TroubleshootEKSWorkerNode 410 AWS Systems Manager Automation runbook reference User Guide Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • ClusterName Type: String Description: (Required) The name of the Amazon EKS cluster. • WorkerID Type: String Description: (Required) The ID of the Amazon EC2 worker node that failed to join the cluster. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ec2:DescribeDhcpOptions • ec2:DescribeImages • ec2:DescribeInstanceAttribute • ec2:DescribeInstances • ec2:DescribeInstanceStatus • ec2:DescribeNatGateways • ec2:DescribeNetworkAcls • ec2:DescribeNetworkInterfaces • ec2:DescribeRouteTables • ec2:DescribeSecurityGroups • ec2:DescribeSubnets • ec2:DescribeVpcAttribute • ec2:DescribeVpcEndpoints • ec2:DescribeVpcs AWSSupport-TroubleshootEKSWorkerNode 411 AWS Systems Manager Automation runbook reference User Guide • eks:DescribeCluster • iam:GetInstanceProfile • iam:GetRole • iam:ListAttachedRolePolicies • ssm:DescribeInstanceInformation • ssm:ListCommandInvocations • ssm:ListCommands • ssm:SendCommand Document Steps • aws:assertAwsResourceProperty - Conﬁrms that the Amazon EKS cluster you specify in the ClusterName parameter exists and is in an ACTIVE state. • aws:assertAwsResourceProperty - Conﬁrms that the Amazon EC2 worker node you specify in the WorkerID parameter exists and is in a running state. • aws:executeScript
systems-manager-automation-runbook-guide-104	systems-manager-automation-runbook-guide.pdf	104	ec2:DescribeImages • ec2:DescribeInstanceAttribute • ec2:DescribeInstances • ec2:DescribeInstanceStatus • ec2:DescribeNatGateways • ec2:DescribeNetworkAcls • ec2:DescribeNetworkInterfaces • ec2:DescribeRouteTables • ec2:DescribeSecurityGroups • ec2:DescribeSubnets • ec2:DescribeVpcAttribute • ec2:DescribeVpcEndpoints • ec2:DescribeVpcs AWSSupport-TroubleshootEKSWorkerNode 411 AWS Systems Manager Automation runbook reference User Guide • eks:DescribeCluster • iam:GetInstanceProfile • iam:GetRole • iam:ListAttachedRolePolicies • ssm:DescribeInstanceInformation • ssm:ListCommandInvocations • ssm:ListCommands • ssm:SendCommand Document Steps • aws:assertAwsResourceProperty - Conﬁrms that the Amazon EKS cluster you specify in the ClusterName parameter exists and is in an ACTIVE state. • aws:assertAwsResourceProperty - Conﬁrms that the Amazon EC2 worker node you specify in the WorkerID parameter exists and is in a running state. • aws:executeScript - Runs a Python script that helps identify possible causes for the worker node failing to join the cluster. AWS-UpdateEKSCluster Description The AWS-UpdateEKSCluster runbook helps you update your Amazon Elastic Kubernetes Service (Amazon EKS) cluster to the Kubernetes version that you want to use. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows AWS-UpdateEKSCluster 412 AWS Systems Manager Automation runbook reference User Guide Parameters • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • ClusterName Type: String Description: (Required) The name of your Amazon EKS cluster. • Version Type: String Description: (Required) The Kubernetes version that you want to update your cluster to. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • eks:DescribeUpdate • eks:UpdateClusterVersion Document Steps • aws:executeAwsApi - Updates the Kubernetes version that is used by your Amazon EKS cluster. • aws:waitForAwsResourceProperty - Waits for the update status to be Successful. AWS-UpdateEKSManagedNodeGroup Description AWS-UpdateEKSManagedNodeGroup 413 AWS Systems Manager Automation runbook reference User Guide The AWS-UpdateEKSManagedNodeGroup runbook helps you update an Amazon Elastic Kubernetes Service (Amazon EKS) managed node group. You can either choose a Version or Configuration update. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • ClusterName Type: String Description: (Required) The name of the cluster whose node group you want to update. • NodeGroupName Type: String Description: (Required) The name of the node group to update. • UpdateType Type: String Valid values: Update Node Group Version \| Update Node Group Conﬁgurations AWS-UpdateEKSManagedNodeGroup 414 AWS Systems Manager Automation runbook reference User Guide Default: Update Node Group Version Description: (Required) The type of update that you want to perform on the node group. The following parameters apply only to the Version update type: • AMIReleaseVersion Type: String Description: (Optional) The version of the Amazon EKS optimized AMI that you want to use. By default, the latest version is used. • ForceUpgrade Type: Boolean Description: (Optional) If true, the update won't fail in response to a pod disruption budget violation. • KubernetesVersion Type: String Description: (Optional) The Kubernetes version to update the node group to. • LaunchTemplateId Type: String Description: (Optional) The ID of the launch template. • LaunchTemplateName Type: String Description: (Optional) The name of the launch template. • LaunchTemplateVersion Type: String Description: (Optional) The Amazon Elastic Compute Cloud (Amazon EC2) launch template version. This parameter is only valid if a node group was created from a launch template. AWS-UpdateEKSManagedNodeGroup 415 AWS Systems Manager Automation runbook reference User Guide The following parameters apply only to the Configuration update type: • AddOrUpdateNodeGroupLabels Type: StringMap Description: (Optional) Kubernetes labels that you want to add or update. • AddOrUpdateKubernetesTaintsEﬀect Type: StringList Description: (Optional) The Kubernetes taints that you want to add or update. • MaxUnavailableNodeGroups Type: Integer Default: 0 Description: (Optional) The maximum number of nodes that are unavailable at once during a version update. • MaxUnavailablePercentageNodeGroup Type: Integer Default: 0 Description: (Optional) The percentage of nodes that are unavailable during a version update. • NodeGroupDesiredSize Type: Integer Default: 0 Description: (Optional) The number of nodes that the managed node group should maintain. • NodeGroupMaxSize Type: Integer Default: 0 AWS-UpdateEKSManagedNodeGroup 416 AWS Systems Manager Automation runbook reference User Guide Description: (Optional) The maximum number of nodes that the managed node group can scale out to. • NodeGroupMinSize Type: Integer Default: 0 Description: (Optional) The minimum number of nodes that the managed node group can scale in to. • RemoveKubernetesTaintsEﬀect Type: StringList Description: (Optional) The Kubernetes taints that you want to remove. • RemoveNodeGroupLabels Type: StringList Description: (Optional) A comma-separated list of labels that you want to remove. Required IAM permissions The AutomationAssumeRole parameter
systems-manager-automation-runbook-guide-105	systems-manager-automation-runbook-guide.pdf	105	number of nodes that the managed node group should maintain. • NodeGroupMaxSize Type: Integer Default: 0 AWS-UpdateEKSManagedNodeGroup 416 AWS Systems Manager Automation runbook reference User Guide Description: (Optional) The maximum number of nodes that the managed node group can scale out to. • NodeGroupMinSize Type: Integer Default: 0 Description: (Optional) The minimum number of nodes that the managed node group can scale in to. • RemoveKubernetesTaintsEﬀect Type: StringList Description: (Optional) The Kubernetes taints that you want to remove. • RemoveNodeGroupLabels Type: StringList Description: (Optional) A comma-separated list of labels that you want to remove. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • eks:UpdateNodegroupConfig • eks:UpdateNodegroupVersion Document Steps • aws:executeScript - Updates an Amazon EKS cluster node group according to the values that you specify for the runbook input parameters. • aws:waitForAwsResourceProperty - Waits for the cluster update status to be Successful. AWS-UpdateEKSManagedNodeGroup 417 AWS Systems Manager Automation runbook reference User Guide AWS-UpdateEKSSelfManagedLinuxNodeGroups Description The AWS-UpdateEKSSelfManagedLinuxNodeGroups runbook updates self-managed managed node groups in your Amazon Elastic Kubernetes Service (Amazon EKS) cluster using an AWS CloudFormation stack. If your cluster uses auto scaling, we recommend scaling the deployment down to two replicas before using this runbook. To scale a deployment to two replicas 1. Install the Kubernetes command line utility, kubectl. For more information, see Installing kubectl in the Amazon EKS User Guide. 2. Run the following command. kubectl scale deployments/cluster-autoscaler --replicas=2 -n kube-system 3. Run the AWS-UpdateEKSSelfManagedLinuxNodeGroups runbook. 4. Scale the deployment back to the desired number of replicas by running the following command. kubectl scale deployments/cluster-autoscaler --replicas=number -n kube-system Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters AWS-UpdateEKSSelfManagedLinuxNodeGroups 418 AWS Systems Manager Automation runbook reference User Guide • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • ClusterName Type: String Description: (Required) The name of the Amazon EKS cluster. • NodeGroupName Type: String Description: (Required) The name of the managed node group. • ClusterControlPlaneSecurityGroup Type: String Description: (Required) The ID of the control plane security group. • DisableIMDSv1 Type: Boolean Description: (Optional) Determines whether you want to allow Instance Metadata Service Version 1 (IMDSv1) and IMDSv2. • KeyName Type: String Description: (Optional) The key name for the instances. • NodeAutoScalingGroupDesiredCapacity Type: String Description: (Optional) The number of nodes that the node group should maintain. • NodeAutoScalingGroupMaxSize AWS-UpdateEKSSelfManagedLinuxNodeGroups 419 AWS Systems Manager Automation runbook reference User Guide Type: String Description: (Optional) The maximum number of nodes that the node group can scale out to. • NodeAutoScalingGroupMinSize Type: String Description: (Optional) The minimum number of nodes that the node group can scale in to. • NodeInstanceType Type: String Default: t3.large Description: (Optional) The instance type that you want to use for the node group. • NodeImageId Type: String Description: (Optional) The ID of the Amazon Machine Image (AMI) that you want the node group to use. • NodeImageIdSSMParam Type: String Default: /aws/service/eks/optimized-ami/1.21/amazon-linux-2/recommended/image_id Description: (Optional) The public Systems Manager parameter for the AMI that you want the node group to use. • StackName Type: String Description: (Required) The name of the AWS CloudFormation stack used to update the node group. • Subnets Type: String AWS-UpdateEKSSelfManagedLinuxNodeGroups 420 AWS Systems Manager Automation runbook reference User Guide Description: (Required) A comma-separated list of the IDs for the subnets that you want your cluster to use. • VpcId Type: String Default: Default Description: (Required) The virtual private cloud (VPC) where your cluster is deployed. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • eks:CreateCluster • eks:CreateNodegroup • eks:DeleteNodegroup • eks:DeleteCluster • eks:DescribeCluster • eks:DescribeNodegroup • eks:ListClusters • eks:ListNodegroups • eks:UpdateClusterConfig • eks:UpdateNodegroupConfig Document Steps • aws:executeScript - Updates an Amazon EKS cluster node group according to the values that you specify for the runbook input parameters. • aws:waitForAwsResourceProperty - Waits for the AWS CloudFormation stack update status to be returned. AWS-UpdateEKSSelfManagedLinuxNodeGroups 421 AWS Systems Manager Automation runbook reference User Guide AWSSupport-SetupK8sApiProxyForEKS Description The AWSSupport-SetupK8sApiProxyForEKS automation runbook provides a way to create an AWS Lambda function that acts as a proxy for making control plane API calls to the Amazon Elastic Kubernetes Service cluster endpoint. It serves as a building block for runbooks which require making control plane API calls for automating tasks and troubleshooting issues with an Amazon EKS cluster. Important All the resources created by this automation are tagged so that they can be easily found. The tags used are: • AWSSupport-SetupK8sApiProxyForEKS: true Note • The automation is a helper runbook and cannot be executed as a standalone runbook. It is invoked as a
systems-manager-automation-runbook-guide-106	systems-manager-automation-runbook-guide.pdf	106	runbook provides a way to create an AWS Lambda function that acts as a proxy for making control plane API calls to the Amazon Elastic Kubernetes Service cluster endpoint. It serves as a building block for runbooks which require making control plane API calls for automating tasks and troubleshooting issues with an Amazon EKS cluster. Important All the resources created by this automation are tagged so that they can be easily found. The tags used are: • AWSSupport-SetupK8sApiProxyForEKS: true Note • The automation is a helper runbook and cannot be executed as a standalone runbook. It is invoked as a child automation for runbooks which require control plane API calls to Amazon EKS cluster. • Please ensure to run Cleanup operation after usage to avoid incurring unwanted costs. Document type Automation Owner Amazon Platforms Linux Parameters AWSSupport-SetupK8sApiProxyForEKS 422 AWS Systems Manager Automation runbook reference User Guide • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • ClusterName Type: String Description: (Required) The name of the Amazon Elastic Kubernetes Service cluster. • Operation Type: String Description: (Required) Operation to perform: Setup provisions the Lambda function in the account, Cleanup will de-provision resources created as part of setup phase. Allowed Values: Setup \| Cleanup Default: Setup • LambdaRoleArn Type: String Description: (Optional) The ARN of the IAM role that allows the AWS Lambda function to access the required AWS services and resources. If no role is speciﬁed, this Systems Manager Automation will create one IAM role for Lambda in your account with the name Automation-K8sProxy-Role-<ExecutionId> that includes the managed policies: AWSLambdaBasicExecutionRole and AWSLambdaVPCAccessExecutionRole. How does it work? The runbook performs the following steps: • Validates that the automation is running as a child execution. The runbook will not work when invoked as a standalone runbook since it does not perform any meaningful work on its own. AWSSupport-SetupK8sApiProxyForEKS 423 AWS Systems Manager Automation runbook reference User Guide • Checks for existing AWS CloudFormation stack for the proxy Lambda function for the speciﬁed cluster. • If the stack exists, the existing infrastructure is re-used instead of re-creating it. • A reference counter is maintained using tags to ensure a runbook does not delete the infrastructure if it is being re-used by another runbook for the same cluster. • Perform the operation type (Setup/Cleanup) speciﬁed for the invocation: • Setup: Creates or describes existing resources. Cleanup: Removes provisioned resources, if the infrastructure is not being used by any other runbook. Required IAM Permissions The AutomationAssumeRole parameter requires the following permissions given LambdaRoleArn is not passed: • cloudformation:CreateStack • cloudformation:DescribeStacks • cloudformation:DeleteStack • cloudformation:UpdateStack • ec2:CreateNetworkInterface • ec2:DescribeNetworkInterfaces • ec2:DescribeRouteTables • ec2:DescribeSecurityGroups • ec2:DescribeSubnets • ec2:DescribeVpcs • ec2:DeleteNetworkInterface • eks:DescribeCluster • lambda:CreateFunction • lambda:DeleteFunction • lambda:ListTags • lambda:GetFunction • lambda:ListTags AWSSupport-SetupK8sApiProxyForEKS 424 AWS Systems Manager Automation runbook reference User Guide • lambda:TagResource • lambda:UntagResource • lambda:UpdateFunctionCode • logs:CreateLogGroup • logs:PutRetentionPolicy • logs:TagResource • logs:UntagResource • logs:DescribeLogGroups • logs:DescribeLogStreams • logs:ListTagsForResource • iam:CreateRole • iam:AttachRolePolicy • iam:DetachRolePolicy • iam:PassRole • iam:GetRole • iam:DeleteRole • iam:TagRole • iam:UntagRole • tag:GetResources • tag:TagResources When LambdaRoleArn is provided, the automation does not need to create the role and the following permissions can be excluded: • iam:CreateRole • iam:DeleteRole • iam:TagRole • iam:UntagRole • iam:AttachRolePolicy • iam:DetachRolePolicy AWSSupport-SetupK8sApiProxyForEKS 425 AWS Systems Manager Automation runbook reference User Guide Below is an example policy demonstrating permissions required for AutomationAssumeRole when LambdaRoleArn is not passed: { "Version": "2012-10-17", "Statement": [ { "Action": [ "tag:GetResources", "tag:TagResources", "ec2:CreateNetworkInterface", "ec2:DescribeNetworkInterfaces", "ec2:DescribeRouteTables", "ec2:DescribeSecurityGroups", "ec2:DescribeSubnets", "ec2:DescribeVpcs", "ec2:DeleteNetworkInterface", "eks:DescribeCluster", "iam:GetRole", "cloudformation:DescribeStacks", "logs:DescribeLogGroups", "logs:DescribeLogStreams", "lambda:GetFunction", "lambda:ListTags", "logs:ListTagsForResource" ], "Resource": "", "Effect": "Allow", "Sid": "AllowActionsWithoutConditions" }, { "Condition": { "StringEquals": { "aws:RequestTag/AWSSupport-SetupK8sApiProxyForEKS": "true" } }, "Action": "iam:CreateRole", "Resource": [ "arn:<partition>:iam:::<account-id>::role/Automation-K8sProxy" ], "Effect": "Allow", "Sid": "AllowCreateRoleWithRequiredTag" }, AWSSupport-SetupK8sApiProxyForEKS 426 AWS Systems Manager Automation runbook reference User Guide { "Condition": { "StringEquals": { "aws:ResourceTag/AWSSupport-SetupK8sApiProxyForEKS": "true" } }, "Action": [ "iam:DeleteRole", "iam:TagRole", "iam:UntagRole" ], "Resource": [ "arn:<partition>:iam:::<account-id>::role/Automation-K8sProxy" ], "Effect": "Allow", "Sid": "IAMActions" }, { "Condition": { "StringEquals": { "aws:ResourceTag/AWSSupport-SetupK8sApiProxyForEKS": "true" }, "StringLike": { "iam:PolicyARN": [ "arn:<partition>:iam::<partition>:policy/service-role/ AWSLambdaBasicExecutionRole", "arn:<partition>:iam::<partition>:policy/service-role/ AWSLambdaVPCAccessExecutionRole" ] } }, "Action": [ "iam:AttachRolePolicy", "iam:DetachRolePolicy" ], "Resource": [ "arn:<partition>:iam:::<account-id>::role/Automation-K8sProxy" ], "Effect": "Allow", "Sid": "AttachRolePolicy" }, { "Condition": { "StringEquals": { AWSSupport-SetupK8sApiProxyForEKS 427 AWS Systems Manager Automation runbook reference User Guide "aws:ResourceTag/AWSSupport-SetupK8sApiProxyForEKS": "true" } }, "Action": [ "lambda:CreateFunction", "lambda:DeleteFunction", "lambda:TagResource", "lambda:UntagResource", "lambda:UpdateFunctionCode" ], "Resource": "arn:<partition>:lambda::<region-id>:::<account- id>::function:Automation-K8sProxy", "Effect": "Allow", "Sid": "LambdaActions" }, { "Condition": { "StringEquals": { "aws:ResourceTag/AWSSupport-SetupK8sApiProxyForEKS": "true" } }, "Action": [ "cloudformation:CreateStack", "cloudformation:DeleteStack", "cloudformation:UpdateStack" ], "Resource": "arn:<partition>:cloudformation::<region-id>:::<account-id>::stack/ AWSSupport-SetupK8sApiProxyForEKS", "Effect": "Allow", "Sid": "CloudFormationActions" }, { "Condition": { "StringEquals": { "aws:ResourceTag/AWSSupport-SetupK8sApiProxyForEKS": "true" } }, "Action": [ "logs:CreateLogGroup", "logs:CreateLogStream", "logs:PutLogEvents", "logs:PutRetentionPolicy", "logs:TagResource", "logs:UntagResource" AWSSupport-SetupK8sApiProxyForEKS 428 AWS
systems-manager-automation-runbook-guide-107	systems-manager-automation-runbook-guide.pdf	107	[ "arn:<partition>:iam::<partition>:policy/service-role/ AWSLambdaBasicExecutionRole", "arn:<partition>:iam::<partition>:policy/service-role/ AWSLambdaVPCAccessExecutionRole" ] } }, "Action": [ "iam:AttachRolePolicy", "iam:DetachRolePolicy" ], "Resource": [ "arn:<partition>:iam:::<account-id>::role/Automation-K8sProxy" ], "Effect": "Allow", "Sid": "AttachRolePolicy" }, { "Condition": { "StringEquals": { AWSSupport-SetupK8sApiProxyForEKS 427 AWS Systems Manager Automation runbook reference User Guide "aws:ResourceTag/AWSSupport-SetupK8sApiProxyForEKS": "true" } }, "Action": [ "lambda:CreateFunction", "lambda:DeleteFunction", "lambda:TagResource", "lambda:UntagResource", "lambda:UpdateFunctionCode" ], "Resource": "arn:<partition>:lambda::<region-id>:::<account- id>::function:Automation-K8sProxy", "Effect": "Allow", "Sid": "LambdaActions" }, { "Condition": { "StringEquals": { "aws:ResourceTag/AWSSupport-SetupK8sApiProxyForEKS": "true" } }, "Action": [ "cloudformation:CreateStack", "cloudformation:DeleteStack", "cloudformation:UpdateStack" ], "Resource": "arn:<partition>:cloudformation::<region-id>:::<account-id>::stack/ AWSSupport-SetupK8sApiProxyForEKS", "Effect": "Allow", "Sid": "CloudFormationActions" }, { "Condition": { "StringEquals": { "aws:ResourceTag/AWSSupport-SetupK8sApiProxyForEKS": "true" } }, "Action": [ "logs:CreateLogGroup", "logs:CreateLogStream", "logs:PutLogEvents", "logs:PutRetentionPolicy", "logs:TagResource", "logs:UntagResource" AWSSupport-SetupK8sApiProxyForEKS 428 AWS Systems Manager Automation runbook reference User Guide ], "Resource": [ "arn:<partition>:logs::<region-id>:::<account-id>::log-group:/aws/lambda/ Automation-K8sProxy", "arn:<partition>:logs::<region-id>:::<account-id>::log-group:/aws/lambda/ Automation-K8sProxy:" ], "Effect": "Allow", "Sid": "LogsActions" }, { "Condition": { "StringLikeIfExists": { "iam:PassedToService": "lambda.amazonaws.com" } }, "Action": [ "iam:PassRole" ], "Resource": [ "arn:<partition>:iam:::<account-id>::role/Automation-K8sProxy-Role*" ], "Effect": "Allow", "Sid": "PassRoleToLambda" } ] } In case the LambdaRoleArn is passed, please ensure that it has AWSLambdaBasicExecutionRole policy attached to it for public cluster and additionally, AWSLambdaVPCAccessExecutionRole for private clusters. Resources Created The following resources are created during Setup operation: 1. AWS Lambda function 2. IAM Role: Lambda execution role, if not provided. 3. CloudWatch Log Group (Lambda Logs) AWSSupport-SetupK8sApiProxyForEKS 429 AWS Systems Manager Automation runbook reference User Guide Lambda function and execution role are retained until Cleanup operation is executed. Lambda log group will be retained for 30 days or until manually deleted. Instructions The runbook is a helper utility designed to be executed from within other runbooks as a child automation. It facilitates the creation of infrastructure enabling the parent runbook to make Amazon EKS K8s control plane API calls. In order to use the runbook, you can follow the below steps from the context of the parent automation. 1. Setup Phase: Invoke the automation using aws:executeAutomation action operation from the runbook that would like to make Amazon EKS K8s control plane API calls with operation set to Setup. Example of input parameters: { "AutomationAssumeRole": "<role-arn>", "ClusterName": "<eks-cluster-name>", "Operation": "Setup" } The output of the aws:executeAutomation step will contain the ARN of the proxy Lambda function. 2. Using the Lambda Proxy: Invoke the Lambda function inside the aws:executeScript action using boto3's Lambda.Client.invoke(...) with a list of API call paths and bearer token. The Lambda function will perform HTTP GET calls to the speciﬁed path by passing the bearer token as part of authorization header. Example of Lambda invoke event: { "ApiCalls": ["/api/v1/pods/", ...], "BearerToken": "..." } AWSSupport-SetupK8sApiProxyForEKS 430 AWS Systems Manager Automation runbook reference User Guide Note The bearer token has to be generated as part of the parent automation script. You need to ensure the principal executing the parent runbook has read-only permission to the speciﬁed Amazon EKS cluster. 3. Cleanup Phase: Invoke the automation using aws:executeAutomation action operation from the runbook that would like to make Amazon EKS K8s control plane API calls with operation set to Cleanup. Example of input parameters: { "AutomationAssumeRole": "<role-arn>", "ClusterName": "<eks-cluster-name>", "Operation": "Cleanup" } Automation Steps 1. ValidateExecution • Veriﬁes that the automation is not running as a standalone execution. 2. CheckForExistingStack • Checks if a AWS CloudFormation stack was already provisioned for the speciﬁed cluster name. • Returns stack existence status and whether it's safe to delete. 3. BranchOnIsStackExists • Decision step that branches based on stack existence. • Routes to either update existing stack name or proceed with operation branching. 4. UpdateStackName • Updates the StackName variable with the existing stack's name. • Only executed if stack already exists. 5. BranchOnOperation • Routes the automation based on the Operation parameter (Setup /Cleanup). • For Setup: Routes to either create new stack or describe existing resources. AWSSupport-SetupK8sApiProxyForEKS 431 AWS Systems Manager Automation runbook reference User Guide • For Cleanup: Proceeds to stack deletion if safe to delete. 6. GetClusterNetworkConﬁg • Describes the Amazon EKS cluster to obtain VPC conﬁguration. • Retrieves endpoint, VPC ID, subnet IDs, security group ID, and CA data. 7. ProvisionResources • Creates a AWS CloudFormation stack with required resources. • Provisions Lambda function with necessary networking conﬁguration. • Tags all resources for tracking and management. 8. DescribeStackResources • Retrieves information about the created/existing stack. • Gets the ARN of the provisioned Lambda function. 9. BranchOnIsLambdaDeploymentRequired • Determines if Lambda code deployment is needed. • Only proceeds to deployment for newly created stacks. 10.DeployLambdaFunctionCode • Deploys the Lambda function code using the deployment package. • Updates the function with the proxy implementation. 11.AssertLambdaAvailable • Veriﬁes that the Lambda function code update was successful. • Waits for the function to be in Successful state. 12.PerformStackCleanup • Deletes the AWS CloudFormation stack and associated resources. • Executed during Cleanup operation or on failure of Setup operation. Outputs LambdaFunctionArn: ARN of the proxy Lambda function References Systems Manager Automation • Run an automation AWSSupport-SetupK8sApiProxyForEKS 432 AWS Systems Manager Automation runbook
systems-manager-automation-runbook-guide-108	systems-manager-automation-runbook-guide.pdf	108	Determines if Lambda code deployment is needed. • Only proceeds to deployment for newly created stacks. 10.DeployLambdaFunctionCode • Deploys the Lambda function code using the deployment package. • Updates the function with the proxy implementation. 11.AssertLambdaAvailable • Veriﬁes that the Lambda function code update was successful. • Waits for the function to be in Successful state. 12.PerformStackCleanup • Deletes the AWS CloudFormation stack and associated resources. • Executed during Cleanup operation or on failure of Setup operation. Outputs LambdaFunctionArn: ARN of the proxy Lambda function References Systems Manager Automation • Run an automation AWSSupport-SetupK8sApiProxyForEKS 432 AWS Systems Manager Automation runbook reference User Guide • Setting up an Automation • Support Automation Workﬂows AWSSupport-TroubleshootEbsCsiDriversForEks Description The AWSSupport-TroubleshootEbsCsiDriversForEks runbook helps troubleshoot issues with Amazon Elastic Block Store volume mounts in Amazon Elastic Kubernetes Service (Amazon EKS) and Amazon EBS Container Storage Interface (CSI) driver issues Important Currently the Amazon EBS CSI Driver running on AWS Fargate is not supported. How does it work? The runbook AWSSupport-TroubleshootEbsCsiDriversForEks performs the following high- level steps: • Veriﬁes if the target Amazon EKS cluster exists and is in active state. • Deploys necessary authentication resources for making Kubernetes API calls based on whether the addon is Amazon EKS-managed or self-managed. • Performs Amazon EBS CSI controller health checks and diagnostics. • Runs IAM permissions checks on node roles and service account roles. • Diagnoses persistent volume creation issues for the speciﬁed application pod. • Checks node-to-pod scheduling and examines pod events. • Collects relevant Kubernetes and application logs, uploading them to the speciﬁed Amazon S3 bucket. • Performs node health checks and veriﬁes connectivity with Amazon EC2 endpoints. • Reviews persistent volume block device attachments and mounting status. • Cleans up the authentication infrastructure created during troubleshooting. • Generates a comprehensive troubleshooting report combining all diagnostic results. AWSSupport-TroubleshootEbsCsiDriversForEks 433 AWS Systems Manager Automation runbook reference User Guide Note • The Amazon EKS cluster's authentication mode must be set to either API or API_AND_CONFIG_MAP. We recommend using Amazon EKS Access entry. The runbook requires Kubernetes Role-based access control (RBAC) permissions to perform the necessary API calls. • If you don't specify an IAM role for the Lambda function (LambdaRoleArn parameter), the automation creates a role named Automation-K8sProxy- Role-<ExecutionId> in your account. This role includes the managed policies AWSLambdaBasicExecutionRole and AWSLambdaVPCAccessExecutionRole. • Some diagnostic steps require the Amazon EKS worker nodes to be Systems Manager managed instances. If the nodes aren't Systems Manager managed instances, steps that require Systems Manager access are skipped, but other checks continue. • The automation includes a cleanup step that removes authentication infrastructure resources. This cleanup step runs even when previous steps fail, which helps prevent orphaned resources in your AWS account. Run this Automation (console) Document type Automation Owner Amazon Platforms / Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ec2:DescribeIamInstanceProfileAssociations AWSSupport-TroubleshootEbsCsiDriversForEks 434 AWS Systems Manager Automation runbook reference User Guide • ec2:DescribeInstanceStatus • ec2:GetEbsEncryptionByDefault • eks:DescribeAddon • eks:DescribeAddonVersions • eks:DescribeCluster • iam:GetInstanceProfile • iam:GetOpenIDConnectProvider • iam:GetRole • iam:ListOpenIDConnectProviders • iam:SimulatePrincipalPolicy • s3:GetBucketLocation • s3:GetBucketPolicyStatus • s3:GetBucketPublicAccessBlock • s3:GetBucketVersioning • s3:ListBucket • s3:ListBucketVersions • ssm:DescribeInstanceInformation • ssm:GetAutomationExecution • ssm:GetDocument • ssm:ListCommandInvocations • ssm:ListCommands • ssm:SendCommand • ssm:StartAutomationExecution Instructions Follow these steps to conﬁgure the automation: 1. Create a SSM automation role TroubleshootEbsCsiDriversForEks-SSM-Role in your account. Verify that the trust relationship contains the following policy. AWSSupport-TroubleshootEbsCsiDriversForEks 435 AWS Systems Manager Automation runbook reference User Guide { "Version": "2012-10-17", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "Service": "ssm.amazonaws.com" }, "Action": "sts:AssumeRole" } ] } 2. Attach the policy below to the IAM role to grant the required permissions to perform the speciﬁed actions on the speciﬁed resources. • If you are expecting to upload execution and resources logs to Amazon S3 bucket in same AWS region, replace arn:{partition}:s3:::BUCKET_NAME/* as yours in OptionalRestrictPutObjects. • The Amazon S3 bucket should point to the correct Amazon S3 bucket if you will select S3BucketName in SSM execution. • This permission is optional if you don't specify S3BucketName • The Amazon S3 bucket must be private and in the same AWS region where you execute the SSM automation. { "Version": "2012-10-17", "Statement": [ { "Sid": "OptionalRestrictPutObjects", "Effect": "Allow", "Action": ["s3:PutObject"], "Resource": ["arn:{partition}:s3:::BUCKET_NAME/"] }, { "Effect": "Allow", "Action": [ "ec2:DescribeIamInstanceProfileAssociations", "ec2:DescribeInstanceStatus", "ec2:GetEbsEncryptionByDefault", AWSSupport-TroubleshootEbsCsiDriversForEks 436 AWS Systems Manager Automation runbook reference User Guide "eks:DescribeAddon", "eks:DescribeAddonVersions", "eks:DescribeCluster", "iam:GetInstanceProfile", "iam:GetOpenIDConnectProvider", "iam:GetRole", "iam:ListOpenIDConnectProviders", "iam:SimulatePrincipalPolicy", "s3:GetBucketLocation", "s3:GetBucketPolicyStatus", "s3:GetBucketPublicAccessBlock", "s3:GetBucketVersioning", "s3:ListBucket", "s3:ListBucketVersions", "ssm:DescribeInstanceInformation", "ssm:GetAutomationExecution", "ssm:GetDocument", "ssm:ListCommandInvocations", "ssm:ListCommands", "ssm:SendCommand", "ssm:StartAutomationExecution" ], "Resource": "" }, { "Sid": "SetupK8sApiProxyForEKSActions", "Effect": "Allow", "Action": [ "cloudformation:CreateStack", "cloudformation:DeleteStack", "cloudformation:DescribeStacks", "cloudformation:UpdateStack", "ec2:CreateNetworkInterface", "ec2:DeleteNetworkInterface", "ec2:DescribeNetworkInterfaces", "ec2:DescribeRouteTables", "ec2:DescribeSecurityGroups", "ec2:DescribeSubnets", "ec2:DescribeVpcs", "eks:DescribeCluster", "iam:CreateRole", "iam:DeleteRole", "iam:GetRole", "iam:TagRole", AWSSupport-TroubleshootEbsCsiDriversForEks 437 AWS Systems Manager Automation runbook reference User Guide "iam:UntagRole", "lambda:CreateFunction", "lambda:DeleteFunction", "lambda:GetFunction", "lambda:InvokeFunction", "lambda:ListTags", "lambda:TagResource", "lambda:UntagResource", "lambda:UpdateFunctionCode", "logs:CreateLogGroup", "logs:CreateLogStream", "logs:DescribeLogGroups", "logs:DescribeLogStreams", "logs:ListTagsForResource", "logs:PutLogEvents", "logs:PutRetentionPolicy", "logs:TagResource", "logs:UntagResource", "ssm:DescribeAutomationExecutions", "tag:GetResources",
systems-manager-automation-runbook-guide-109	systems-manager-automation-runbook-guide.pdf	109	["s3:PutObject"], "Resource": ["arn:{partition}:s3:::BUCKET_NAME/"] }, { "Effect": "Allow", "Action": [ "ec2:DescribeIamInstanceProfileAssociations", "ec2:DescribeInstanceStatus", "ec2:GetEbsEncryptionByDefault", AWSSupport-TroubleshootEbsCsiDriversForEks 436 AWS Systems Manager Automation runbook reference User Guide "eks:DescribeAddon", "eks:DescribeAddonVersions", "eks:DescribeCluster", "iam:GetInstanceProfile", "iam:GetOpenIDConnectProvider", "iam:GetRole", "iam:ListOpenIDConnectProviders", "iam:SimulatePrincipalPolicy", "s3:GetBucketLocation", "s3:GetBucketPolicyStatus", "s3:GetBucketPublicAccessBlock", "s3:GetBucketVersioning", "s3:ListBucket", "s3:ListBucketVersions", "ssm:DescribeInstanceInformation", "ssm:GetAutomationExecution", "ssm:GetDocument", "ssm:ListCommandInvocations", "ssm:ListCommands", "ssm:SendCommand", "ssm:StartAutomationExecution" ], "Resource": "" }, { "Sid": "SetupK8sApiProxyForEKSActions", "Effect": "Allow", "Action": [ "cloudformation:CreateStack", "cloudformation:DeleteStack", "cloudformation:DescribeStacks", "cloudformation:UpdateStack", "ec2:CreateNetworkInterface", "ec2:DeleteNetworkInterface", "ec2:DescribeNetworkInterfaces", "ec2:DescribeRouteTables", "ec2:DescribeSecurityGroups", "ec2:DescribeSubnets", "ec2:DescribeVpcs", "eks:DescribeCluster", "iam:CreateRole", "iam:DeleteRole", "iam:GetRole", "iam:TagRole", AWSSupport-TroubleshootEbsCsiDriversForEks 437 AWS Systems Manager Automation runbook reference User Guide "iam:UntagRole", "lambda:CreateFunction", "lambda:DeleteFunction", "lambda:GetFunction", "lambda:InvokeFunction", "lambda:ListTags", "lambda:TagResource", "lambda:UntagResource", "lambda:UpdateFunctionCode", "logs:CreateLogGroup", "logs:CreateLogStream", "logs:DescribeLogGroups", "logs:DescribeLogStreams", "logs:ListTagsForResource", "logs:PutLogEvents", "logs:PutRetentionPolicy", "logs:TagResource", "logs:UntagResource", "ssm:DescribeAutomationExecutions", "tag:GetResources", "tag:TagResources" ], "Resource": "" }, { "Sid": "PassRoleToAutomation", "Effect": "Allow", "Action": "iam:PassRole", "Resource": [ "arn::iam:::role/TroubleshootEbsCsiDriversForEks-SSM-Role", "arn::iam:::role/Automation-K8sProxy-Role-" ], "Condition": { "StringLikeIfExists": { "iam:PassedToService": [ "lambda.amazonaws.com", "ssm.amazonaws.com" ] } } }, { "Sid": "AttachRolePolicy", "Effect": "Allow", AWSSupport-TroubleshootEbsCsiDriversForEks 438 AWS Systems Manager Automation runbook reference User Guide "Action": [ "iam:AttachRolePolicy", "iam:DetachRolePolicy" ], "Resource": "*", "Condition": { "StringLikeIfExists": { "iam:ResourceTag/AWSSupport-SetupK8sApiProxyForEKS": "true" } } } ] } 3. Grant the required permissions for Amazon EKS cluster RBAC (Role-Based Access Control). The recommended approach is to create an Access Entry in your Amazon EKS cluster. In the Amazon EKS console, navigate to your cluster. For Amazon EKS access entries, verify your access conﬁguration is set to API_AND_CONFIG_MAP or API. For steps to conﬁgure authentication mode for access entries, see Setting up access entries. Choose Create access entry. • For IAM principal ARN, select the IAM role you created for SSM automation in the previous step. • For Type, select Standard. 4. Add an access policy: • For Access scope, select Cluster. • For Policy name, select AmazonEKSAdminViewPolicy. Choose Add policy. If you are not using access entries to manage Kubernetes API permissions, you must update the aws-auth ConﬁgMap and create a role binding between your IAM user or role. Ensure your IAM entity has the following read-only Kubernetes API permissions: • GET /apis/apps/v1/namespaces/{namespace}/deployments/{name} • GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name} • GET /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} • GET /api/v1/nodes/{name} AWSSupport-TroubleshootEbsCsiDriversForEks 439 AWS Systems Manager Automation runbook reference User Guide • GET /api/v1/namespaces/{namespace}/serviceaccounts/{name} • GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} • GET /api/v1/persistentvolumes/{name} • GET /apis/storage.k8s.io/v1/storageclasses/{name} • GET /api/v1/namespaces/{namespace}/pods/{name} • GET /api/v1/namespaces/{namespace}/pods • GET /api/v1/namespaces/{namespace}/pods/{name}/log • GET /api/v1/events 5. Run the automation AWSSupport-TroubleshootEbsCsiDriversForEks (console) 6. Select Execute automation. 7. For the input parameters, enter the following: • AutomationAssumeRole (Optional): • Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows SSM Automation to perform the actions on your behalf. The role needs to be added to your Amazon EKS cluster access entry or RBAC permission to allow Kubernetes API calls. • Type: AWS::IAM::Role::Arn • Example: TroubleshootEbsCsiDriversForEks-SSM-Role • EksClusterName: • Description: The name of the target Amazon Elastic Kubernetes Service (Amazon EKS) cluster. • Type: String • ApplicationPodName: • Description: The name of the Kubernetes application pod having issues with the Amazon EBS CSI driver. • Type: String • ApplicationNamespace: • Description: The Kubernetes namespace for the application pod having issues with the Amazon EBS CSI driver. • Type: String AWSSupport-TroubleshootEbsCsiDriversForEks • EbsCsiControllerDeploymentName (Optional): 440 AWS Systems Manager Automation runbook reference User Guide • Description: (Optional) The deployment name for the Amazon EBS CSI controller pod. • Type: String • Default: ebs-csi-controller • EbsCsiControllerNamespace (Optional): • Description: (Optional) The Kubernetes namespace for the Amazon EBS CSI controller pod. • Type: String • Default: kube-system • S3BucketName (Optional): • Description: (Optional) The target Amazon S3 bucket name where the troubleshooting logs will be uploaded. • Type: AWS::S3::Bucket::Name • LambdaRoleArn (Optional): • Description: (Optional) The ARN of the IAM role that allows the AWS Lambda function to access the required AWS services and resources. • Type: AWS::IAM::Role::Arn Select Execute. 8. After completed, review the Outputs section for the detailed results of the execution. References Systems Manager Automation • Run this Automation (console) • Run an automation • Setting up an Automation • Support Automation Workﬂows For more information on Amazon EBS CSI Driver, see Amazon EBS CSI Driver. AWSSupport-TroubleshootEbsCsiDriversForEks 441 AWS Systems Manager Automation runbook reference User Guide Elastic Beanstalk AWS Systems Manager Automation provides predeﬁned runbooks for AWS Elastic Beanstalk. For more information about runbooks, see Working with runbooks. For information about how to view runbook content, see View runbook content. Topics • AWSSupport-CollectElasticBeanstalkLogs • AWSConﬁgRemediation-EnableElasticBeanstalkEnvironmentLogStreaming • AWSConﬁgRemediation-EnableBeanstalkEnvironmentNotiﬁcations • AWSSupport-TroubleshootElasticBeanstalk AWSSupport-CollectElasticBeanstalkLogs Description The AWSSupport-CollectElasticBeanstalkLogs runbook gathers AWS Elastic Beanstalk related log ﬁles from an Amazon Elastic Compute Cloud (Amazon EC2) Windows Server instance launched by Elastic Beanstalk to help you troubleshoot common issues. While the automation is gathering the associated log ﬁles, changes are made to the ﬁle system structure including the creation of temporary directories, the copying of log ﬁles to the temporary directories, and compressing the log ﬁles into an archive. This activity can result in increased CPUUtilization on the Amazon EC2 instance. For more information about CPUUtilization , see
systems-manager-automation-runbook-guide-110	systems-manager-automation-runbook-guide.pdf	110	• AWSSupport-CollectElasticBeanstalkLogs • AWSConﬁgRemediation-EnableElasticBeanstalkEnvironmentLogStreaming • AWSConﬁgRemediation-EnableBeanstalkEnvironmentNotiﬁcations • AWSSupport-TroubleshootElasticBeanstalk AWSSupport-CollectElasticBeanstalkLogs Description The AWSSupport-CollectElasticBeanstalkLogs runbook gathers AWS Elastic Beanstalk related log ﬁles from an Amazon Elastic Compute Cloud (Amazon EC2) Windows Server instance launched by Elastic Beanstalk to help you troubleshoot common issues. While the automation is gathering the associated log ﬁles, changes are made to the ﬁle system structure including the creation of temporary directories, the copying of log ﬁles to the temporary directories, and compressing the log ﬁles into an archive. This activity can result in increased CPUUtilization on the Amazon EC2 instance. For more information about CPUUtilization , see Instance metrics in the Amazon CloudWatch User Guide . If you specify a value for the S3BucketName parameter, the automation evaluates the policy status of the Amazon Simple Storage Service (Amazon S3) bucket you specify. To help with the security of the logs gathered from your Amazon EC2 instance, if the policy status isPublic is set to true , or if the access control list (ACL) grants READ\|WRITE permissions to the All Users Amazon S3 predeﬁned group, the logs are not uploaded. For more information about Amazon S3 predeﬁned groups, see Amazon S3 predeﬁned groups in the Amazon Simple Storage Service User Guide . If you do not specify a value for the S3BucketName parameter, the automation uploads the log bundle to the default Elastic Beanstalk Amazon S3 bucket in the AWS Region where you run the automation. The directory is named according to the following structure, elasticbeanstalk- Elastic Beanstalk 442 AWS Systems Manager Automation runbook reference User Guide region - accountID . The region and accountID values will diﬀer based on the Region and AWS account you run the automation in. The log bundle will be saved to the resources/environments/logs/bundle/ environmentID / instanceID directory. The environmentID and instanceID values will diﬀer based on your Elastic Beanstalk environment and the Amazon EC2 instance you're gathering logs from. By default, the AWS Identity and Access Management (IAM) instance proﬁle attached to the Amazon EC2 instances of the Elastic Beanstalk environment has the required permissions to upload the bundle to the default Elastic Beanstalk Amazon S3 bucket for your environment. If you specify a value for the S3BucketName parameter, the instance proﬁle attached to the Amazon EC2 instance must allow the s3:GetBucketAcl , s3:GetBucketPolicy , s3:GetBucketPolicyStatus , and s3:PutObject actions for the speciﬁed Amazon S3 bucket and path. Note This automation requires at least 500 MB of available disk space on the root Amazon Elastic Block Store (Amazon EBS) volume attached to your Amazon EC2 instance. If there is not enough available disk space on the root volume, the automation stops. Run this Automation (console) Document type Automation Owner Amazon Platforms Windows Parameters • AutomationAssumeRole Type: String AWSSupport-CollectElasticBeanstalkLogs 443 AWS Systems Manager Automation runbook reference User Guide Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • EnvironmentId Type: String Description: (Required) The ID of your Elastic Beanstalk environment you want to collect the log bundle from. • InstanceId Type: String (Required) The ID of the Amazon EC2 instance in your Elastic Beanstalk environment you want to collect the log bundle from. • S3BucketName Type: String (Optional) The Amazon S3 bucket you want to upload the archived logs to. • S3BucketPath Type: String (Optional) The Amazon S3 bucket path you want to upload the log bundle to. This parameter is ignored if you do not specify a value for the S3BucketName parameter. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • ssm:SendCommand • ssm:DescribeInstanceInformation AWSSupport-CollectElasticBeanstalkLogs 444 AWS Systems Manager Automation runbook reference User Guide • ec2:DescribeInstances Document Steps • aws:assertAwsResourceProperty - Conﬁrms the Amazon EC2 instance you specify in the InstanceId parameter is managed by AWS Systems Manager. • aws:assertAwsResourceProperty - Conﬁrms the Amazon EC2 instance you specify in the InstanceId parameter is a Windows Server instance. • aws:runCommand - Checks whether the instance is part of an Elastic Beanstalk environment, if there is suﬃcient disk space to bundle the logs, and whether the Amazon S3 bucket to which the logs would be uploaded to is public. • aws:runCommand - Collects the log ﬁles and uploads the archive to the Amazon S3 bucket speciﬁed in the S3BucketName parameter or to the default bucket for your Elastic Beanstalk environment if a value is not speciﬁed. AWSConfigRemediation- EnableElasticBeanstalkEnvironmentLogStreaming Description The AWSConfigRemediation-EnableElasticBeanstalkEnvironmentLogStreaming runbook enables logging on the AWS Elastic Beanstalk (Elastic Beanstalk) environment you specify. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole AWSConfigRemediation-EnableElasticBeanstalkEnvironmentLogStreaming 445 AWS Systems Manager Automation
systems-manager-automation-runbook-guide-111	systems-manager-automation-runbook-guide.pdf	111	suﬃcient disk space to bundle the logs, and whether the Amazon S3 bucket to which the logs would be uploaded to is public. • aws:runCommand - Collects the log ﬁles and uploads the archive to the Amazon S3 bucket speciﬁed in the S3BucketName parameter or to the default bucket for your Elastic Beanstalk environment if a value is not speciﬁed. AWSConfigRemediation- EnableElasticBeanstalkEnvironmentLogStreaming Description The AWSConfigRemediation-EnableElasticBeanstalkEnvironmentLogStreaming runbook enables logging on the AWS Elastic Beanstalk (Elastic Beanstalk) environment you specify. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole AWSConfigRemediation-EnableElasticBeanstalkEnvironmentLogStreaming 445 AWS Systems Manager Automation runbook reference User Guide Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. • EnvironmentId Type: String Description: (Required) The ID of the Elastic Beanstalk environment that you want to enable logging on. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • elasticbeanstalk:DescribeConfigurationSettings • elasticbeanstalk:DescribeEnvironments • elasticbeanstalk:UpdateEnvironment Document Steps • aws:executeAwsApi - Enables logging on the Elastic Beanstalk environment you specify in the EnvironmentId parameter. • aws:waitForAwsResourceProperty - Waits for the status of the environment to change to Ready . • aws:executeScript - Veriﬁes logging has been enabled on the Elastic Beanstalk environment. AWSConfigRemediation- EnableBeanstalkEnvironmentNotifications Description AWSConfigRemediation-EnableBeanstalkEnvironmentNotifications 446 AWS Systems Manager Automation runbook reference User Guide The AWSConfigRemediation-EnableBeanstalkEnvironmentNotifications runbook enables notiﬁcations for the AWS Elastic Beanstalk (Elastic Beanstalk) environment you specify. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. • EnvironmentId Type: String Description: (Required) The ID of the Elastic Beanstalk environment that you want to enable notiﬁcations for. • TopicArn Type: String Description: (Required) The ARN of the Amazon Simple Notiﬁcation Service (Amazon SNS) topic you want to send notiﬁcations to. Required IAM permissions AWSConfigRemediation-EnableBeanstalkEnvironmentNotifications 447 AWS Systems Manager Automation runbook reference User Guide The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • elasticbeanstalk:DescribeConfigurationSettings • elasticbeanstalk:DescribeEnvironments • elasticbeanstalk:UpdateEnvironment Document Steps • aws:executeAwsApi - Enables notiﬁcations for the Elastic Beanstalk environment you specify in the EnvironmentId parameter. • aws:waitForAwsResourceProperty - Waits for the status of the environment to change to Ready . • aws:executeScript - Veriﬁes notiﬁcations have been enabled for the Elastic Beanstalk environment. AWSSupport-TroubleshootElasticBeanstalk Description The AWSSupport-TroubleshootElasticBeanstalk runbook helps you troubleshoot the potential reasons why your AWS Elastic Beanstalk environment is in a Degraded or Severe state. This automation checks the following AWS resources associated with your Elastic Beanstalk environment: • Conﬁguration details for a load balancer, AWS CloudFormation stack, Amazon EC2 Auto Scaling group, Amazon Elastic Compute Cloud (Amazon EC2) instances, and virtual private cloud (VPC). • Network conﬁguration issues with the associated security group rules, route tables, and network access control lists (ACLs) associated with your subnets. • Veriﬁes connectivity to the Elastic Beanstalk endpoints and public internet access. • Veriﬁes the status of the load balancer. • Veriﬁes the status of the Amazon EC2 instances. AWSSupport-TroubleshootElasticBeanstalk 448 AWS Systems Manager Automation runbook reference User Guide • Retrieves a log bundle from your Elastic Beanstalk environment, and optionally uploads the ﬁles to Support. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • ApplicationName Type: String Description: (Required) The name of your Elastic Beanstalk application. • EnvironmentName Type: String Description: (Required) The name of your Elastic Beanstalk environment. • AWSS3UploaderLink Type: String AWSSupport-TroubleshootElasticBeanstalk 449 AWS Systems Manager Automation runbook reference User Guide Description: (Optional) A URL provided to you by Support to upload the log bundle from your Elastic Beanstalk environment to. This option is only available to customers who have purchased an Support plan, and have opened a Support case. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • autoscaling:Describe* • cloudformation:Describe* • cloudformation:Estimate* • cloudformation:Get* • cloudformation:List* • cloudformation:Validate* • cloudwatch:Describe* • cloudwatch:Get* • cloudwatch:List* • ec2:Describe* • elasticbeanstalk:Check* • elasticbeanstalk:Describe* • elasticbeanstalk:List* • elasticbeanstalk:RetrieveEnvironmentInfo* • elasticbeanstalk:RequestEnvironmentInfo* • elasticloadbalancing:Describe* • rds:Describe* • s3:Get* • s3:List* • sns:Get* • sns:List* Document Steps AWSSupport-TroubleshootElasticBeanstalk 450 AWS Systems Manager Automation runbook reference User Guide • aws:executeScript - Veriﬁes the AWS Identity and Access Management (IAM) principal who started the automation has the requisite permissions to perform all
systems-manager-automation-runbook-guide-112	systems-manager-automation-runbook-guide.pdf	112	Support plan, and have opened a Support case. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • autoscaling:Describe* • cloudformation:Describe* • cloudformation:Estimate* • cloudformation:Get* • cloudformation:List* • cloudformation:Validate* • cloudwatch:Describe* • cloudwatch:Get* • cloudwatch:List* • ec2:Describe* • elasticbeanstalk:Check* • elasticbeanstalk:Describe* • elasticbeanstalk:List* • elasticbeanstalk:RetrieveEnvironmentInfo* • elasticbeanstalk:RequestEnvironmentInfo* • elasticloadbalancing:Describe* • rds:Describe* • s3:Get* • s3:List* • sns:Get* • sns:List* Document Steps AWSSupport-TroubleshootElasticBeanstalk 450 AWS Systems Manager Automation runbook reference User Guide • aws:executeScript - Veriﬁes the AWS Identity and Access Management (IAM) principal who started the automation has the requisite permissions to perform all of the actions deﬁned in the runbook. • aws:branch - Branches the workﬂow based on the results of the previous step. • aws:executeScript - Collects information about the Elastic Beanstalk environment including the load balancer, AWS CloudFormation stack, Auto Scaling group, Amazon EC2 instances, and VPC conﬁguration. • aws:executeScript - Checks for network connectivity issues with the route tables and ACLs associated with the subnets in your VPC. • aws:executeScript - Checks for network connectivity issues with the security group rules associated with your Amazon EC2 instances. • aws:executeScript - Veriﬁes the status checks for the Amazon EC2 instances. • aws:executeScript - Generates a link for a log bundle of your Elastic Beanstalk environment. • aws:executeScript - Uploads log bundle to Support. • aws:executeScript - Outputs a report of action items to help you troubleshoot issues that might be aﬀecting the status of your Elastic Beanstalk environment. Elastic Load Balancing AWS Systems Manager Automation provides predeﬁned runbooks for Elastic Load Balancing. For more information about runbooks, see Working with runbooks. For information about how to view runbook content, see View runbook content. Topics • AWSConﬁgRemediation-DropInvalidHeadersForALB • AWS-EnableCLBAccessLogs • AWS-EnableCLBConnectionDraining • AWSConﬁgRemediation-EnableCLBCrossZoneLoadBalancing • AWSConﬁgRemediation-EnableELBDeletionProtection • AWSConﬁgRemediation-EnableLoggingForALBAndCLB • AWSSupport-TroubleshootCLBConnectivity • AWSConﬁgRemediation-EnableNLBCrossZoneLoadBalancing • AWS-UpdateALBDesyncMitigationMode Elastic Load Balancing 451 AWS Systems Manager Automation runbook reference User Guide • AWS-UpdateCLBDesyncMitigationMode AWSConfigRemediation-DropInvalidHeadersForALB Description The AWSConfigRemediation-DropInvalidHeadersForALB runbook enables the application load balancer you specify to remove HTTP headers with invalid headers. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. • LoadBalancerArn Type: String Description: (Required) The Amazon Resource Name (ARN) of the load balancer that you want to drop invalid headers. Required IAM permissions AWSConfigRemediation-DropInvalidHeadersForALB 452 AWS Systems Manager Automation runbook reference User Guide The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • elasticloadbalancing:DescribeLoadBalancerAttributes • elasticloadbalancing:ModifyLoadBalancerAttributes Document Steps • aws:executeAwsApi - Enables the drop invalid headers setting for the load balancer you specify in the LoadBalancerArn parameter. • aws:executeScript - Veriﬁes the drop invalid headers setting has been enabled on the load balancer you specify in the LoadBalancerArn parameter. AWS-EnableCLBAccessLogs Description The AWS-EnableCLBAccessLogs runbook enables access logs for a Classic Load Balancer. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole AWS-EnableCLBAccessLogs 453 AWS Systems Manager Automation runbook reference User Guide Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • EmitInterval Type: Integer Valid values: 5 \| 60 Default: 60 Description: (Optional) The interval for publishing the access logs in minutes. • LoadBalancerNames Type: String Description: (Required) A comma separated list of Classic Load Balancers you want to enable access logs for. • S3BucketName Type: String Description: (Required) The name of the Amazon Simple Storage Service (Amazon S3) bucket where the access logs are stored. • S3BucketPreﬁx Type: String Description: (Optional) The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. If the preﬁx is not provided, the log is placed at the root level of the bucket. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. AWS-EnableCLBAccessLogs 454 AWS Systems Manager Automation runbook reference User Guide • elasticloadbalancing:ModifyLoadBalancerAttributes Document Steps • aws:executeAwsApi - Enables access logs for the Classic Load Balancers you specify in the LoadBalancerNames parameter. Outputs EnableCLBAccessLogs.SuccessesLoadBalancers - List of load balancer names where access logs were successfully enabled. EnableCLBAccessLogs.FailedLoadBalancers - MapList of load balancer names where enabling access logs failed and the reason for the failure. AWS-EnableCLBConnectionDraining Description The AWS-EnableCLBConnectionDraining runbook enables connection draining on a Classic Load Balancer (CLB) to the speciﬁed timeout value. Connection drainings enables the CLB to complete in-ﬂight requests made to instances that are deregistering or unhealthy with the speciﬁed timeout being the time it keeps connections alive before reporting the instance as deregistered. For more
systems-manager-automation-runbook-guide-113	systems-manager-automation-runbook-guide.pdf	113	access logs for the Classic Load Balancers you specify in the LoadBalancerNames parameter. Outputs EnableCLBAccessLogs.SuccessesLoadBalancers - List of load balancer names where access logs were successfully enabled. EnableCLBAccessLogs.FailedLoadBalancers - MapList of load balancer names where enabling access logs failed and the reason for the failure. AWS-EnableCLBConnectionDraining Description The AWS-EnableCLBConnectionDraining runbook enables connection draining on a Classic Load Balancer (CLB) to the speciﬁed timeout value. Connection drainings enables the CLB to complete in-ﬂight requests made to instances that are deregistering or unhealthy with the speciﬁed timeout being the time it keeps connections alive before reporting the instance as deregistered. For more information about connection draining on CLBs, see Conﬁgure connection draining for your Classic Load Balancer in the User Guide for Classic Load Balancers. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters AWS-EnableCLBConnectionDraining 455 AWS Systems Manager Automation runbook reference User Guide • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • LoadBalancerName Type: String Description: (Required) The name of the load balancer you want to enable connection draining on. • ConnectionTimeout Type: Integer Valid values: 1-3600 Default: 300 Description: (Required) The connection timeout value for the load balancer. The timeout value can be set between 1 and 3600 seconds. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • elasticloadbalancing:DescribeLoadBalancerAttributes • elasticloadbalancing:ModifyLoadBalancerAttributes Document Steps • ModifyLoadBalancerConnectionDraining (aws:executeAwsApi): Enables connection draining and sets the speciﬁed timeout value for the load balancer you specify. AWS-EnableCLBConnectionDraining 456 AWS Systems Manager Automation runbook reference User Guide • VerifyLoadBalancerConnectionDrainingEnabled (aws:assertAwsResourceProperty): Veriﬁes that connection draining is enabled for the load balancer. • VerifyLoadBalancerConnectionDrainingTimeout (aws:assertAwsResourceProperty): Veriﬁes that the connection timeout value for the load balancer matches the value you speciﬁed. AWSConfigRemediation-EnableCLBCrossZoneLoadBalancing Description The AWSConfigRemediation-EnableCLBCrossZoneLoadBalancing runbook enables cross- zone load balancing for the Classic Load Balancer (CLB) you specify. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. • LoadBalancerName Type: String Description: (Required) The name of the CLB that you want to enable cross-zone load balancing on. AWSConfigRemediation-EnableCLBCrossZoneLoadBalancing 457 AWS Systems Manager Automation runbook reference User Guide Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • elb:DescribeLoadBalancerAttributes • elb:ModifyLoadBalancerAttributes Document Steps • aws:executeAwsApi - Enables cross-zone load balancing for the CLB you specify in the LoadBalancerName parameter. • aws:assertAwsResourceProperty - Veriﬁes cross-zone load balancing has been enabled on the CLB. AWSConfigRemediation-EnableELBDeletionProtection Description The AWSConfigRemediation-EnableELBDeletionProtection runbook enables deletion protection for the elastic load balancer (ELB) you specify. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters AWSConfigRemediation-EnableELBDeletionProtection 458 AWS Systems Manager Automation runbook reference User Guide • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. • LoadBalancerArn Type: String Description: (Required) The Amazon Resource Name (ARN) of the ELB that you want to enable deletion protection on. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • elasticloadbalancing:DescribeLoadBalancerAttributes • elasticloadbalancing:DescribeLoadBalancers • elasticloadbalancing:ModifyLoadBalancerAttributes Document Steps • aws:executeScript - Enables deletion protection on the ELB you specify in the LoadBalancerArn parameter. AWSConfigRemediation-EnableLoggingForALBAndCLB Description The AWSConfigRemediation-EnableLoggingForALBAndCLB runbook enables logging for the speciﬁed AWS Application Load Balancer or a Classic Load Balancer (CLB). Run this Automation (console) AWSConfigRemediation-EnableLoggingForALBAndCLB 459 AWS Systems Manager Automation runbook reference User Guide Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. • LoadBalancerId Type: String Description: (Required) The Classic Load Balancer name or the Application Load Balancer ARN. • S3BucketName Type: String Description: (Required) The Amazon S3 bucket name. • S3BucketPreﬁx Type: String Description: (Optional) The logical hierarchy you created for your Amazon Simple Storage Service (Amazon S3) bucket, for example my-bucket-prefix/prod . If the preﬁx is not provided, the log is placed at the root level of the bucket. Required IAM permissions AWSConfigRemediation-EnableLoggingForALBAndCLB 460 AWS Systems Manager Automation runbook reference User Guide The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • elasticloadbalancing:DescribeLoadBalancerAttributes • elasticloadbalancing:ModifyLoadBalancerAttributes Document Steps • aws:executeScript - Enables and veriﬁes
systems-manager-automation-runbook-guide-114	systems-manager-automation-runbook-guide.pdf	114	name or the Application Load Balancer ARN. • S3BucketName Type: String Description: (Required) The Amazon S3 bucket name. • S3BucketPreﬁx Type: String Description: (Optional) The logical hierarchy you created for your Amazon Simple Storage Service (Amazon S3) bucket, for example my-bucket-prefix/prod . If the preﬁx is not provided, the log is placed at the root level of the bucket. Required IAM permissions AWSConfigRemediation-EnableLoggingForALBAndCLB 460 AWS Systems Manager Automation runbook reference User Guide The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • elasticloadbalancing:DescribeLoadBalancerAttributes • elasticloadbalancing:ModifyLoadBalancerAttributes Document Steps • aws:executeScript - Enables and veriﬁes the logging for the Classic Load Balancer or the Application Load Balancer. AWSSupport-TroubleshootCLBConnectivity Description The AWSSupport-TroubleshootCLBConnectivity runbook help you troubleshoot connectivity issues between a Classic Load Balancer (CLB) and Amazon Elastic Compute Cloud (Amazon EC2) instances. Also, connectivity issues between a client and the CLB are reviewed. This runbook also reviews health checks for the CLB, veriﬁes that best practices are being followed, and creates a troubleshooting dashboard for you. Optionally, you can upload the automation output to an Amazon Simple Storage Service (Amazon S3) bucket. However, this runbook does not support uploading output to S3 buckets that are publicly accessible. We recommend creating a temporary S3 bucket for this automation. Important Using this runbook might incur charges for the dashboard that is created. For more information, see Amazon CloudWatch Pricing Run this Automation (console) Document type Automation AWSSupport-TroubleshootCLBConnectivity 461 AWS Systems Manager Automation runbook reference User Guide Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • InvestigationType Type: String Valid values: Best Practices \| Connectivity Issues \| Troubleshooting Dashboard Description: (Required) The operations you want the runbook to perform. • LoadBalancerName Type: String Description: (Required) The name of the CLB. • S3Location Type: String Description: (Optional) The name of the S3 bucket you want to send the automation results to. Publicly accessible buckets are not supported. If your S3 bucket uses server-side encryption, the user or role running this automation must have kms:GenerateDataKey permissions for the AWS KMS key. • S3LocationPreﬁx Type: String AWSSupport-TroubleshootCLBConnectivity 462 AWS Systems Manager Automation runbook reference User Guide Description: (Optional) The Amazon S3 key preﬁx (subfolder) you want to upload the automation output to. The format output is stored in the following format: amzn-s3-demo- bucket/S3LocationPrefix/{{InvestigationType}}_{{automation:EXECUTION_ID}}.txt. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ec2:DescribeInstances • ec2:DescribeNetworkAcls • ec2:DescribeNetworkInterfaces • ec2:DescribeRouteTables • ec2:DescribeSecurityGroups • ec2:DescribeVpcAttribute • ec2:DescribeVpcs • ec2:DescribeSubnets • elasticloadbalancing:DescribeLoadBalancers • elasticloadbalancing:DescribeLoadBalancerPolicies • elasticloadbalancing:DescribeInstanceHealth • elasticloadbalancing:DescribeLoadBalancerAttributes • iam:ListRoles • cloudwatch:PutDashboard • ssm:GetAutomationExecution • ssm:StartAutomationExecution • ssm:DescribeAutomationExecutions • ssm:DescribeAutomationStepExecutions • ssm:DescribeInstanceInformation • ssm:DescribeInstanceProperties • ssm:GetDocument • ssm:ListCommands AWSSupport-TroubleshootCLBConnectivity 463 AWS Systems Manager Automation runbook reference User Guide • ssm:ListCommandInvocations • ssm:ListDocuments • ssm:SendCommand • s3:GetBucketAcl • s3:GetBucketPolicyStatus • s3:GetPublicAccessBlock • s3:PutObject Document Steps • aws:executeScript - Veriﬁes that the CLB you specify in the LoadBalancerName parameter exists. • aws:branch - Branches based on the value speciﬁed for the InvestigationType parameter. • aws:executeScript - Performs connectivity checks to the CLB. • aws:executeScript - Veriﬁes that the CLB conﬁguration adheres to Elastic Load Balancing best practices. • aws:executeScript - Creates an Amazon CloudWatch dashboard for your CLB. • aws:executeScript - Creates a text ﬁle with the results of the automation and uploads it to the Amazon S3 bucket you specify in the S3Location parameter. Outputs RunBestPractices.Summary RunConnectivityChecks.Summary CreateTroubleshootingDashboard.Output UploadOutputToS3.Output AWSConfigRemediation-EnableNLBCrossZoneLoadBalancing Description The AWSConfigRemediation-EnableNLBCrossZoneLoadBalancing runbook enables cross zone load balancing for the network load balancer (NLB) you specify. AWSConfigRemediation-EnableNLBCrossZoneLoadBalancing 464 AWS Systems Manager Automation runbook reference User Guide Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. • LoadBalancerArn Type: String Description: (Required) The Amazon Resource Name (ARN) of the NLB that you want to enable cross zone load balancing on. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • elasticloadbalancing:DescribeLoadBalancerAttributes • elasticloadbalancing:ModifyLoadBalancerAttributes AWSConfigRemediation-EnableNLBCrossZoneLoadBalancing 465 AWS Systems Manager Automation runbook reference User Guide Document Steps • aws:executeAwsApi - Enables cross zone load balancing for the NLB you specify in the LoadBalancerArn parameter. • aws:executeScript - Veriﬁes cross zone load balancing has been enabled on the NLB. AWS-UpdateALBDesyncMitigationMode Description The AWS-UpdateALBDesyncMitigationMode runbook will update the desync mitigation mode on an Application Load Balancer (ALB) to the speciﬁed mitigation mode. The desync mitigation mode determines
systems-manager-automation-runbook-guide-115	systems-manager-automation-runbook-guide.pdf	115	to enable cross zone load balancing on. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • elasticloadbalancing:DescribeLoadBalancerAttributes • elasticloadbalancing:ModifyLoadBalancerAttributes AWSConfigRemediation-EnableNLBCrossZoneLoadBalancing 465 AWS Systems Manager Automation runbook reference User Guide Document Steps • aws:executeAwsApi - Enables cross zone load balancing for the NLB you specify in the LoadBalancerArn parameter. • aws:executeScript - Veriﬁes cross zone load balancing has been enabled on the NLB. AWS-UpdateALBDesyncMitigationMode Description The AWS-UpdateALBDesyncMitigationMode runbook will update the desync mitigation mode on an Application Load Balancer (ALB) to the speciﬁed mitigation mode. The desync mitigation mode determines how the load balancer handles requests that might pose a security risk to your application. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • LoadBalancerArn AWS-UpdateALBDesyncMitigationMode 466 AWS Systems Manager Automation runbook reference User Guide Type: String Description: (Required) The Amazon Resource Name (ARN) of the ALB that you want to modify the desync mitigation mode of. • DesyncMitigationMode Type: String Valid values: monitor \| defensive \| strictest Description: (Required) The mitigation mode that you want the ALB to use. For information about desync mitigation modes, see Desync mitigation mode in the User Guide for Application Load Balancers. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • elasticloadbalancing:DescribeLoadBalancers • elasticloadbalancing:DescribeLoadBalancerAttributes • elasticloadbalancing:ModifyLoadBalancerAttributes Document Steps • VerifyLoadBalancerType (aws:assertAwsResourceProperty) - Veriﬁes that the value speciﬁed for the LoadBalancerArn input parameter is for an application load balancer before proceeding to the next step. • ModifyLoadBalancerDesyncMode (aws:executeAwsApi) - Updates the ALB to use the speciﬁed DesyncMitigationMode. • VerifyLoadBalancerDesyncMitigationMode (aws:executeScript) - Veriﬁes that the desync mitigation mode was updated for the target ALB. Outputs AWS-UpdateALBDesyncMitigationMode 467 AWS Systems Manager Automation runbook reference User Guide VerifyLoadBalancerDesyncMitigationMode.ModiﬁcationResult - Message payload of the script verifying the modiﬁcation to your ALB. AWS-UpdateCLBDesyncMitigationMode Description The AWS-UpdateCLBDesyncMitigationMode runbook will update the desync mitigation mode on an Classic Load Balancer (CLB) to the speciﬁed mitigation mode. The desync mitigation mode determines how the load balancer handles requests that might pose a security risk to your application. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • LoadBalancerName Type: String Description: (Required) The name of the CLB that you want to modify the desync mitigation mode of. • DesyncMitigationMode AWS-UpdateCLBDesyncMitigationMode 468 AWS Systems Manager Automation runbook reference User Guide Type: String Valid values: monitor \| defensive \| strictest Description: (Required) The mitigation mode that you want the CLB to use. For information about desync mitigation modes, see Desync mitigation mode in the User Guide for Application Load Balancers. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • elasticloadbalancing:DescribeLoadBalancerAttributes • elasticloadbalancing:ModifyLoadBalancerAttributes Document Steps • ModifyLoadBalancerDesyncMode (aws:executeAwsApi) - Updates the CLB to use the speciﬁed DesyncMitigationMode. • VerifyLoadBalancerDesyncMitigationMode (aws:executeScript) - Veriﬁes that the desync mitigation mode was updated for the target CLB. Outputs VerifyLoadBalancerDesyncMitigationMode.ModiﬁcationResult - Message payload of the script verifying the modiﬁcation to your CLB. Amazon EMR AWS Systems Manager Automation provides predeﬁned runbooks for Amazon EMR. For more information about runbooks, see Working with runbooks. For information about how to view runbook content, see View runbook content. Topics Amazon EMR 469 AWS Systems Manager Automation runbook reference User Guide • AWSSupport-AnalyzeEMRLogs • AWSSupport-DiagnoseEMRLogsWithAthena AWSSupport-AnalyzeEMRLogs Description This runbook helps identify errors while running a job on an Amazon EMR cluster. The runbook analyzes a list of deﬁned logs on the ﬁle system and looks for a list of predeﬁned keywords. These log entries are used to create Amazon CloudWatch Events events so you can take any needed actions based on the events. Optionally, the runbook publishes log entries to the Amazon CloudWatch Logs log group of your choosing. This runbook currently looks for the following errors and patterns in log ﬁles: • container_out_of_memory – YARN container ran out of memory, running job may fail. • yarn_nodemanager_health: CORE or TASK node is running low on disk space and will not be able to run tasks. • node_state_change: CORE or TASK node is unreachable by the MASTER node. • step_failure: An EMR Step has failed. • no_core_nodes_running: No CORE nodes are currently running,
systems-manager-automation-runbook-guide-116	systems-manager-automation-runbook-guide.pdf	116	so you can take any needed actions based on the events. Optionally, the runbook publishes log entries to the Amazon CloudWatch Logs log group of your choosing. This runbook currently looks for the following errors and patterns in log ﬁles: • container_out_of_memory – YARN container ran out of memory, running job may fail. • yarn_nodemanager_health: CORE or TASK node is running low on disk space and will not be able to run tasks. • node_state_change: CORE or TASK node is unreachable by the MASTER node. • step_failure: An EMR Step has failed. • no_core_nodes_running: No CORE nodes are currently running, cluster is unhealthy. • hdfs_missing_blocks: There are missing HDFS blocks which could lead to data loss. • hdfs_high_util: HDFS Utilization is high, which may aﬀect jobs and cluster health. • instance_controller_restart: Instance-Controller process has restarted. This process is essential for cluster health. • instance_controller_restart_legacy: Instance-Controller process has restarted. This process is essential for cluster health. • high_load: High Load Average detected, may aﬀect node health reporting or result in timeouts or slowdowns. • yarn_node_blacklisted: CORE or TASK node has been blacklisted by YARN from running tasks. • yarn_node_lost: CORE or TASK node has been marked as LOST by YARN, possible connectivity issues. Instances associated with the ClusterID that you specify must be managed by AWS Systems Manager. You can run this automation once, schedule the automation to run at a speciﬁc time AWSSupport-AnalyzeEMRLogs 470 AWS Systems Manager Automation runbook reference User Guide interval, or remove a schedule created previously by an automation. This runbook supports Amazon EMR release versions 5.20 to 6.30. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • ClusterID Type: String Description: (Required) The ID of the cluster whose nodes logs you want to analyze. • Operation Type: String Valid values: Run Once \| Schedule \| Remove Schedule Description: (Required) The operation to perform on the cluster. • IntervalTime Type: String AWSSupport-AnalyzeEMRLogs 471 AWS Systems Manager Automation runbook reference User Guide Valid values: 5 minutes \| 10 minutes \| 15 minutes Description: (Optional) The duration of time between running the automation. This parameter is only applicable if you specify Schedule for the Operation parameter. • LogToCloudWatchLogs Type: String Valid values: yes \| no Description: (Optional) If you specify yes for the value of this parameter, the automation creates a CloudWatch Logs log group with the name speciﬁed in the CloudWatchLogGroup parameter to store any matched log entries. • CloudWatchLogGroup Type: String Description: (Optional) The name of the CloudWatch Logs log group you want to store any matched log entries in. This parameter is only applicable if you specify yes for the LogToCloudWatchLogs parameter. • CreateLogInsightsDashboard Type: String Valid values: yes \| no Description: (Optional) If you specify yes , CloudWatch dashboard is created if it does not already exist. This parameter is only applicable if you specify yes for the LogToCloudWatchLogs parameter. • CreateMetricFilters Type: String Valid values: yes \| no Description: (Optional) Specify yes if you want to create metric ﬁlters for the CloudWatch Logs log group. This parameter is only applicable if you specify yes for the LogToCloudWatchLogs parameter. AWSSupport-AnalyzeEMRLogs 472 AWS Systems Manager Automation runbook reference User Guide Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetDocument • ssm:ListDocuments • ssm:DescribeAutomationExecutions • ssm:DescribeAutomationStepExecutions • ssm:GetAutomationExecution • ssm:DescribeInstanceInformation • ssm:ListCommandInvocations • ssm:ListCommands • ssm:SendCommand • iam:CreateRole • iam:DeleteRole • iam:GetRolePolicy • iam:PutRolePolicy • iam:DeleteRolePolicy • iam:passrole • cloudformation:DescribeStacks • cloudformation:DeleteStack • cloudformation:CreateStack • events:DeleteRule • events:RemoveTargets • events:PutTargets • events:PutRule • events:DescribeRule • logs:DescribeLogGroups • logs:CreateLogGroup • logs:PutMetricFilter AWSSupport-AnalyzeEMRLogs 473 AWS Systems Manager Automation runbook reference User Guide • cloudwatch:PutDashboard • elasticmapreduce:ListInstances • elasticmapreduce:DescribeCluster Document Steps • aws:executeAwsApi - Gathers information about the Amazon EMR cluster speciﬁed in the ClusterID parameter. • aws:branch - Branches based on input. • If the provided operation is Run Once or Schedule : • aws:assertAwsResourceProperty - Veriﬁes the cluster is available. • aws:executeAwsApi - Gathers the IDs of all instances running in the cluster. • aws:assertAwsResourceProperty - Veriﬁes the SSM Agent is running on all instances in the cluster. • aws:branch - Branches based on whether you speciﬁed to run the automation once or on a schedule. • If the provided operation is Run Once : • aws:branch - Branches based on the value speciﬁed in the LogToCloudWatchLogs parameter. • If LogToCloudWatchLogs value is yes : • aws:executeScript - Checks if a CloudWatch Logs log group with the name speciﬁed in parameter CloudWatchLogGroup
systems-manager-automation-runbook-guide-117	systems-manager-automation-runbook-guide.pdf	117	• aws:assertAwsResourceProperty - Veriﬁes the cluster is available. • aws:executeAwsApi - Gathers the IDs of all instances running in the cluster. • aws:assertAwsResourceProperty - Veriﬁes the SSM Agent is running on all instances in the cluster. • aws:branch - Branches based on whether you speciﬁed to run the automation once or on a schedule. • If the provided operation is Run Once : • aws:branch - Branches based on the value speciﬁed in the LogToCloudWatchLogs parameter. • If LogToCloudWatchLogs value is yes : • aws:executeScript - Checks if a CloudWatch Logs log group with the name speciﬁed in parameter CloudWatchLogGroup already exists. If not, the group is created with the name speciﬁed. • aws:branch - Branches based on the value speciﬁed in the CreateMetricFilters parameter. • If CreateMetricFilters value is yes : • aws:executeAwsApi - 12 steps are ran for each metric ﬁlter • aws:branch - Branches based on the value speciﬁed in the CreateLogInsightsDashboard parameter. • If CreateLogInsightsDashboard value is yes : • aws:executeAwsApi - Creates a CloudWatch dashboard with the same name speciﬁed in the CloudWatchLogGroup parameter, if it does not already exist. AWSSupport-AnalyzeEMRLogs 474 AWS Systems Manager Automation runbook reference User Guide • If CreateLogInsightsDashboard value is no : • aws:runCommand - Runs a shell script to ﬁnd log patterns on each instance in the cluster. • If CreateMetricFilters value is no : • aws:branch - Branches based on the value speciﬁed in CreateLogInsightsDashboard parameter. • If CreateLogInsightsDashboard value is yes : • aws:executeAwsApi - Creates a CloudWatch dashboard with the same name speciﬁed in the CloudWatchLogGroup parameter, if it does not already exist. • If CreateLogInsightsDashboard value is no : • aws:runCommand - Runs a shell script to ﬁnd log patterns on each instance in the cluster. • If LogToCloudWatchLogs value is no : • aws:executeAwsApi - Runs a shell script to ﬁnd log patterns on each instance in the cluster. • If the provided operation is Schedule : • aws:createStack - Creates an Amazon EventBridge event that targets this runbook. • If the provided operation is Remove Schedule : • aws:executeAwsApi - Veriﬁes a schedule exists for the cluster. • aws:deleteStack - Deletes the schedule. Outputs GetClusterInformation.ClusterName GetClusterInformation.ClusterState ListingClusterInstances.InstanceIDs CreatingScheduleCloudFormationStack.StackStatus RemovingScheduleByDeletingScheduleCloudFormationStack.StackStatus CheckIfLogGroupExists.output AWSSupport-AnalyzeEMRLogs 475 AWS Systems Manager Automation runbook reference User Guide FindLogPatternOnEMRNode.CommandId AWSSupport-DiagnoseEMRLogsWithAthena Description The AWSSupport-DiagnoseEMRLogsWithAthena runbook helps diagnose Amazon EMR logs using Amazon Athena in integration with AWS Glue Data Catalog. Amazon Athena is used to query the Amazon EMR log ﬁles for containers, node logs, or both, with optional parameters for speciﬁc date ranges or keyword-based searches. The runbook can automatically retrieve the Amazon EMR log location for an existing cluster, or you can specify the Amazon S3 log location. To analyze the logs, the runbook: • Creates an AWS Glue database and executes Amazon Athena Data Deﬁnition Language (DDL) queries on the Amazon EMR Amazon S3 log location to create tables for cluster logs and a list of known issues. • Executes Data Manipulation Language (DML) queries to search for known issue patterns in the Amazon EMR logs. The queries return a list of detected issues, their occurrence count, and the number of matched keywords by Amazon S3 ﬁle path. • The results are uploaded to an Amazon S3 bucket you specify under the preﬁx saw_diagnose_EMR_known_issues. • The runbook returns the Amazon Athena query results, highlighting ﬁndings, recommendations, and references to Amazon Knowledge Center (KC) articles sourced from a predeﬁned subset. • Upon completion or failure, the AWS Glue database and the known issues ﬁles uploaded to the Amazon S3 bucket are deleted. How does it work? The AWSSupport-DiagnoseEMRLogsWithAthena perform analysis of Amazon EMR logs using Amazon Athena to detect errors and highlight ﬁndings, recommendations and relevant Knowledge Center articles. The runbook performs the following steps: • Get Amazon EMR cluster log location using cluster ID or input Amazon S3 location to retrieve log location and size. • Provide Athena costs estimate based on log location size. AWSSupport-DiagnoseEMRLogsWithAthena 476 AWS Systems Manager Automation runbook reference User Guide • Get approval to proceed by requesting approval from designated IAM principals before running Athena queries and continuing to the next steps. • Upload known issues to the speciﬁed Amazon S3 bucket, creates an AWS Glue database and tables. • Execute Athena queries on the Amazon EMR logs data. Queries can search by date range, keywords, both criteria, or run without ﬁlters based on the provided inputs. • Analyze results to highlight ﬁndings, recommendations, and relevant KC articles. • Output links for Amazon Athena DML queries results. • Clean up the environment by removing created database, tables, and uploaded known issues. Document type Automation Owner Amazon Platforms / The AutomationAssumeRole parameter requires the following actions to successfully use the runbook: • athena:GetQueryExecution • athena:StartQueryExecution • athena:GetPreparedStatement • athena:CreatePreparedStatement • glue:GetDatabase • glue:CreateDatabase • glue:DeleteDatabase
systems-manager-automation-runbook-guide-118	systems-manager-automation-runbook-guide.pdf	118	AWS Glue database and tables. • Execute Athena queries on the Amazon EMR logs data. Queries can search by date range, keywords, both criteria, or run without ﬁlters based on the provided inputs. • Analyze results to highlight ﬁndings, recommendations, and relevant KC articles. • Output links for Amazon Athena DML queries results. • Clean up the environment by removing created database, tables, and uploaded known issues. Document type Automation Owner Amazon Platforms / The AutomationAssumeRole parameter requires the following actions to successfully use the runbook: • athena:GetQueryExecution • athena:StartQueryExecution • athena:GetPreparedStatement • athena:CreatePreparedStatement • glue:GetDatabase • glue:CreateDatabase • glue:DeleteDatabase • glue:CreateTable • glue:GetTable • glue:DeleteTable • elasticmapreduce:DescribeCluster AWSSupport-DiagnoseEMRLogsWithAthena 477 AWS Systems Manager Automation runbook reference User Guide • s3:ListBucket • s3:GetBucketVersioning • s3:ListBucketVersions • s3:GetBucketPublicAccessBlock • s3:GetBucketPolicyStatus • s3:GetObject • s3:GetBucketLocation • pricing:GetProducts • pricing:GetAttributeValues • pricing:DescribeServices • pricing:ListPriceLists Important To restrict access to only the resources needed by this automation, attach the following policy to the IAM role that trusts the SSM Service. Replace the Partition, Region and Account with the appropriate values for the partition, region and account number where the run book is executed. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "elasticmapreduce:DescribeCluster", "glue:GetDatabase", "athena:GetQueryExecution", "athena:StartQueryExecution", "athena:GetPreparedStatement", "athena:CreatePreparedStatement", "s3:ListBucket", "s3:GetBucketVersioning", "s3:ListBucketVersions", "s3:GetBucketPublicAccessBlock", AWSSupport-DiagnoseEMRLogsWithAthena 478 AWS Systems Manager Automation runbook reference User Guide "s3:GetBucketPolicyStatus", "s3:GetObject", "s3:GetBucketLocation", "pricing:GetProducts", "pricing:GetAttributeValues", "pricing:DescribeServices", "pricing:ListPriceLists" ], "Resource": "" }, { "Sid": "RestrictPutObjects", "Effect": "Allow", "Action": [ "s3:PutObject" ], "Resource": [ "arn:{Partition}:s3::://results/", "arn:{partition}:s3::://saw_diagnose_emr_known_issues/" ] }, { "Sid": "RestrictDeleteAccess", "Effect": "Allow", "Action": [ "s3:DeleteObject", "s3:DeleteObjectVersion" ], "Resource": [ "arn:{Partition}:s3::://saw_diagnose_emr_known_issues/" ] }, { "Effect": "Allow", "Action": [ "glue:GetDatabase", "glue:CreateDatabase", "glue:DeleteDatabase" ], "Resource": [ "arn:{Partition}:glue:{Region}:{Account}:database/saw_diagnose_emr_database_", "arn:{Partition}:glue:{Region}:{Account}:table/saw_diagnose_emr_database_/", "arn:{Partition}:glue:{Region}:{Account}:userDefinedFunction/ saw_diagnose_emr_database_/", AWSSupport-DiagnoseEMRLogsWithAthena 479 AWS Systems Manager Automation runbook reference User Guide "arn:{Partition}:glue:{Region}:{Account}:catalog" ] }, { "Effect": "Allow", "Action": [ "glue:CreateTable", "glue:GetTable", "glue:DeleteTable" ], "Resource": [ "arn:{Partition}:glue:{Region}:{Account}:table/saw_diagnose_emr_database_/ saw_diagnose_emr_known_issues", "arn:{Partition}:glue:{Region}:{Account}:table/saw_diagnose_emr_database_/ saw_diagnose_emr_logs_table", "arn:{Partition}:glue:{Region}:{Account}:table/saw_diagnose_emr_database_/ j_", "arn:{Partition}:glue:{Region}:{Account}:database/saw_diagnose_emr_database_", "arn:{Partition}:glue:{Region}:{Account}:catalog" ] } ] } Instructions Follow these steps to conﬁgure the automation: 1. Navigate AWSSupport-DiagnoseEMRLogsWithAthena in the AWS Systems Manager under Documents. 2. Select Execute automation. 3. For the input parameters enter the following: • AutomationAssumeRole (Optional): The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • ClusterID (Required): The Amazon EMR cluster ID. AWSSupport-DiagnoseEMRLogsWithAthena 480 AWS Systems Manager Automation runbook reference User Guide • S3LogLocation (Optional): The Amazon S3 Amazon EMR log location. Input the Path-style URL Amazon S3 location, for example: s3://amzn-s3-demo-bucket/myfolder/j-1K48XXXXXXHCB/. Provide this parameter if the Amazon EMR cluster has been terminated for more than 30 days. • S3BucketName (Required): The Amazon S3 bucket name to upload a list of known issues, and the output of Amazon Athena queries. The bucket should have Block Public Access Enabled and be in the same AWS region and account as the Amazon EMR cluster. • Approvers (Required): The list of AWS authenticated principals who are able to either approve or reject the action. You can specify principals by using any of the following formats: user name, user ARN, IAM role ARN, or IAM assume role ARN. The maximum number of approvers is 10. • FetchNodeLogsOnly (Optional): If set to true, the automation diagnoses the Amazon EMR application containers logs. The default value is false. • FetchContainersLogsOnly (Optional): If set to true, the automation diagnoses the Amazon EMR containers logs. The default value is false. • EndSearchDate (Optional): The end date for log searches. If provided, the automation will exclusively search for logs generated up to the speciﬁed date in the format YYYY-MM-DD (for example: 2024-12-30). • DaysToCheck (Optional): When EndSearchDate is provided, this parameter is required to determine the number of days to retrospectively search for logs from the speciﬁed EndSearchDate. The maximum value is 30 days. The default value is 1. • SearchKeywords (Optional): The list of keywords to search in the logs, separated by commas. The keywords cannot contain single or double quotes. AWSSupport-DiagnoseEMRLogsWithAthena 481 AWS Systems Manager Automation runbook reference User Guide 4. Select Execute. 5. The automation initiates. 6. The document performs the following steps: • getLogLocation: Retrieves the Amazon S3 log location by querying the speciﬁed Amazon EMR Cluster ID. If the automation is unable to query the log location from the Amazon EMR cluster ID, the runbook uses the S3LogLocation input parameter. • branchOnValidLog: Veriﬁes the Amazon EMR logs location. If the location is valid, proceed to estimate the Amazon Athena potential costs when executing queries on the Amazon EMR logs. • estimateAthenaCosts: Determines the size of Amazon EMR logs and provides a cost estimate for executing Athena scans on the log dataset. For non-commercial regions (non-AWS partitions), this step just provides the log size without estimating costs. Costs can be calculated using
systems-manager-automation-runbook-guide-119	systems-manager-automation-runbook-guide.pdf	119	the speciﬁed Amazon EMR Cluster ID. If the automation is unable to query the log location from the Amazon EMR cluster ID, the runbook uses the S3LogLocation input parameter. • branchOnValidLog: Veriﬁes the Amazon EMR logs location. If the location is valid, proceed to estimate the Amazon Athena potential costs when executing queries on the Amazon EMR logs. • estimateAthenaCosts: Determines the size of Amazon EMR logs and provides a cost estimate for executing Athena scans on the log dataset. For non-commercial regions (non-AWS partitions), this step just provides the log size without estimating costs. Costs can be calculated using the Athena pricing documentation in the speciﬁed region. • approveAutomation: Waits for the designated IAM principals approval to proceed with the next steps of the automation. The approve notiﬁcation contains the estimated cost of Amazon Athena scan on the Amazon EMR logs, and details about the resources being provisioned by the automation. • uploadKnownIssuesExecuteAthenaQueries: AWSSupport-DiagnoseEMRLogsWithAthena 482 AWS Systems Manager Automation runbook reference User Guide Uploads the predeﬁned known issues to the Amazon S3 bucket speciﬁed in the S3BucketName parameter. Creates AWS Glue database and tables. Executes Amazon Athena queries in the AWS Glue database based on the input parameters. • getQueryExecutionStatus: Waits until the Amazon Athena query execution is in SUCCEEDED state. The Amazon Athena DML query searches for errors and exceptions in Amazon EMR cluster logs. • analyzeAthenaResults: Analyzes the Amazon Athena results to provide ﬁndings, recommendations, and Knowledge Center (KC) articles sourced from a predeﬁned set of mappings. • getAnalyzeResultsQuery1ExecutionStatus: Waits until the query execution is in SUCCEEDED state. The Amazon Athena DML query analyzes the results from the previous DML query. This analysis query will return matched exceptions with resolutions and KC articles • getAnalyzeResultsQuery2ExecutionStatus: Waits until the query execution is in SUCCEEDED state. The Amazon Athena DML query analyzes the results from the previous DML query. This analysis query will return a list of exceptions/errors detected in each Amazon S3 log path. • printAthenaQueriesMessage: Prints links for the Amazon Athena DML queries results. • cleanupResources: Clean-ups resources by deleting the created AWS Glue database and delete known issues ﬁles that were created in the Amazon EMR logs bucket. 7. After completed, review the Outputs section for the detailed results of the execution: Output provides three links for Athena query results: • List of all errors and frequently occurred exceptions found in the Amazon EMR cluster logs, along with the corresponding log locations (Amazon S3 preﬁx). • Summary of unique known exceptions matched in the Amazon EMR logs, along with recommended resolutions and KC articles to help in troubleshooting. AWSSupport-DiagnoseEMRLogsWithAthena 483 AWS Systems Manager Automation runbook reference User Guide • Details on where speciﬁc errors and exceptions appear in the Amazon S3 log paths, to support further diagnosis. References Systems Manager Automation • Run this Automation (console) • Run an automation • Setting up an Automation • Support Automation Workﬂows landing page AWS service documentation • Refer toTroubleshooting Amazon EMR Clusters for more information Amazon OpenSearch Service AWS Systems Manager Automation provides predeﬁned runbooks for Amazon OpenSearch Service. For more information about runbooks, see Working with runbooks. For information about how to view runbook content, see View runbook content. Topics • AWSConﬁgRemediation-DeleteOpenSearchDomain • AWSConﬁgRemediation-EnforceHTTPSOnOpenSearchDomain • AWSConﬁgRemediation-UpdateOpenSearchDomainSecurityGroups • AWSSupport-TroubleshootOpenSearchRedYellowCluster • AWSSupport-TroubleshootOpenSearchHighCPU Amazon OpenSearch Service 484 AWS Systems Manager Automation runbook reference User Guide AWSConfigRemediation-DeleteOpenSearchDomain Description The AWSConfigRemediation-DeleteOpenSearchDomain runbook deletes the given Amazon OpenSearch Service domain using the DeleteDomain API. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • DomainName Type: String Allowed values: (\d{12}/)?[a-z]{1}[a-z0-9-]{2,28} Description: (Required) The name of the Amazon OpenSearch Service domain that you want to delete. • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. Required IAM permissions AWSConfigRemediation-DeleteOpenSearchDomain 485 AWS Systems Manager Automation runbook reference User Guide The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • es:DeleteDomain • es:DescribeDomain Document Steps • aws:executeScript - Accepts the Amazon OpenSearch Service domain name as input, deletes it, and veriﬁes the deletion. AWSConfigRemediation-EnforceHTTPSOnOpenSearchDomain Description The AWSConfigRemediation-EnforceHTTPSOnOpenSearchDomain runbook enables EnforceHTTPS on a given Amazon OpenSearch Service domain using the UpdateDomainConﬁg API. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • DomainName AWSConfigRemediation-EnforceHTTPSOnOpenSearchDomain 486 AWS Systems Manager Automation runbook reference User Guide Type: String Allowed values: (\d{12}/)?[a-z]{1}[a-z0-9-]{2,28} Description: (Required) The name of the Amazon OpenSearch Service domain that you want to use to enforce HTTPS. • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. Required IAM permissions The AutomationAssumeRole parameter requires the following
systems-manager-automation-runbook-guide-120	systems-manager-automation-runbook-guide.pdf	120	a given Amazon OpenSearch Service domain using the UpdateDomainConﬁg API. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • DomainName AWSConfigRemediation-EnforceHTTPSOnOpenSearchDomain 486 AWS Systems Manager Automation runbook reference User Guide Type: String Allowed values: (\d{12}/)?[a-z]{1}[a-z0-9-]{2,28} Description: (Required) The name of the Amazon OpenSearch Service domain that you want to use to enforce HTTPS. • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • es:DescribeDomain • es:UpdateDomainConfig Document Steps • aws:executeScript - Enables the EnforceHTTPS endpoint option on the Amazon OpenSearch Service domain you specify in the DomainName parameter. AWSConfigRemediation- UpdateOpenSearchDomainSecurityGroups Description The AWSConfigRemediation-UpdateOpenSearchDomainSecurityGroups runbook updates the security group conﬁguration on a given Amazon OpenSearch Service domain using the UpdateDomainConﬁg API. AWSConfigRemediation-UpdateOpenSearchDomainSecurityGroups 487 AWS Systems Manager Automation runbook reference User Guide Note AWS Security groups can only be applied to Amazon OpenSearch Service domains conﬁgured for Amazon Virtual Private Cloud (VPC) Access, and not to Amazon OpenSearch Service domains conﬁgured for Public Access. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • DomainName Type: String Description: (Required) The name of the Amazon OpenSearch Service domain that you want to use to update security groups. • SecurityGroupList Type: StringList Description: (Required) The security group IDs that you want to assign to the Amazon OpenSearch Service domain. • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. AWSConfigRemediation-UpdateOpenSearchDomainSecurityGroups 488 AWS Systems Manager Automation runbook reference User Guide Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • es:DescribeDomain • es:UpdateDomainConfig Document Steps • aws:executeScript - Updates the security group conﬁguration on the Amazon OpenSearch Service domain you specify in the DomainName parameter. AWSSupport-TroubleshootOpenSearchRedYellowCluster Description AWSSupport-TroubleshootOpenSearchRedYellowCluster automation runbook is used to identify the cause for red or yellow cluster health status and guide you through changing the cluster back to green. How does it work? The runbook AWSSupport-TroubleshootOpenSearchRedYellowCluster helps you troubleshoot the cause of red or yellow cluster and provides the next steps to resolve this issue by analyzing the cluster conﬁguration and resource utilization. The runbook performs the following steps: • Calls the DescribeDomain API against the target domain to get the cluster conﬁguration. • Checks if the OpenSearch Service domain is internet-based (public) or Amazon Virtual Private Cloud (VPC)-based. • Creates a public or Amazon VPC-based AWS Lambda function depending on the cluster conﬁguration. Note: The Lambda function contains the troubleshooting code that run the OpenSearch Service APIs against the cluster to determine why the cluster is in red or yellow state. AWSSupport-TroubleshootOpenSearchRedYellowCluster 489 AWS Systems Manager Automation runbook reference User Guide • Deletes the Lambda function. • Displays the checks performed and the next recommended steps to resolve the red or yellow cluster issue. Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • cloudformation:CreateStack • cloudformation:DescribeStacks • cloudformation:DescribeStackEvents • cloudformation:DeleteStack • lambda:CreateFunction • lambda:DeleteFunction • lambda:InvokeFunction • lambda:GetFunction • es:DescribeDomain • es:DescribeDomainConfig • ec2:DescribeSecurityGroups • ec2:DescribeSubnets • ec2:DescribeVpcs • ec2:DescribeNetworkInterfaces AWSSupport-TroubleshootOpenSearchRedYellowCluster 490 AWS Systems Manager Automation runbook reference User Guide • ec2:CreateNetworkInterface • ec2:DeleteNetworkInterface • ec2:DescribeInstances • ec2:AttachNetworkInterface • cloudwatch:GetMetricData • iam:PassRole The LambdaExecutionRole parameter requires the following actions to successfully use the runbook: • es:ESHttpGet • ec2:CreateNetworkInterface • ec2:DescribeNetworkInterfaces • ec2:DeleteNetworkInterface Overview of LambdaExecutionRole policy: The following is an example of a Lambda function's execution role (AWS Identity and Access Management (IAM) role) that grants the function permission to access AWS services and resources required by this runbook. For more information, see Lambda execution role. Note The ec2:DescribeNetworkInterfaces, ec2:CreateNetworkInterface, and ec2:DeleteNetworkInterface are only required if your OpenSearch Service cluster is Amazon VPC-based to allow the Lambda function to create and manage the Amazon VPC network interfaces. For more information, see Connecting outbound networking to resources in a Amazon VPC and Lambda execution role. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", AWSSupport-TroubleshootOpenSearchRedYellowCluster 491 AWS Systems Manager Automation runbook reference User Guide "Action": "es:ESHttpGet", "Resource": [ "arn:<partition>:es:<region>:<account-id>:domain/<domain- name>/", "arn:<partition>:es:<region>:<account-id>:domain/<domain-name>/ _cluster/health", "arn:<partition>:es:<region>:<account-id>:domain/<domain-name>/ _cat/indices", "arn:<partition>:es:<region>:<account-id>:domain/<domain-name>/ _cat/allocation", "arn:<partition>:es:<region>:<account-id>:domain/<domain-name>/ _cluster/allocation/explain" ] }, { "Condition": { "ArnLikeIfExists": { "ec2:Vpc": "arn:<partition>:ec2:<region>:<account-id>:vpc/ <vpc_id>" } }, "Action": [ "ec2:DeleteNetworkInterface", "ec2:CreateNetworkInterface", "ec2:DescribeNetworkInterfaces", "ec2:UnassignPrivateIpAddresses", "ec2:AssignPrivateIpAddresses" ], "Resource": "*", "Effect": "Allow" } ] } Instructions Follow these steps to conﬁgure the automation: 1. Navigate to the AWSSupport-TroubleshootOpenSearchRedYellowCluster in the AWS Systems Manager console. 2. Select Execute automation. AWSSupport-TroubleshootOpenSearchRedYellowCluster 492 AWS Systems Manager Automation runbook reference User Guide 3. For
systems-manager-automation-runbook-guide-121	systems-manager-automation-runbook-guide.pdf	121	Amazon VPC and Lambda execution role. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", AWSSupport-TroubleshootOpenSearchRedYellowCluster 491 AWS Systems Manager Automation runbook reference User Guide "Action": "es:ESHttpGet", "Resource": [ "arn:<partition>:es:<region>:<account-id>:domain/<domain- name>/", "arn:<partition>:es:<region>:<account-id>:domain/<domain-name>/ _cluster/health", "arn:<partition>:es:<region>:<account-id>:domain/<domain-name>/ _cat/indices", "arn:<partition>:es:<region>:<account-id>:domain/<domain-name>/ _cat/allocation", "arn:<partition>:es:<region>:<account-id>:domain/<domain-name>/ _cluster/allocation/explain" ] }, { "Condition": { "ArnLikeIfExists": { "ec2:Vpc": "arn:<partition>:ec2:<region>:<account-id>:vpc/ <vpc_id>" } }, "Action": [ "ec2:DeleteNetworkInterface", "ec2:CreateNetworkInterface", "ec2:DescribeNetworkInterfaces", "ec2:UnassignPrivateIpAddresses", "ec2:AssignPrivateIpAddresses" ], "Resource": "*", "Effect": "Allow" } ] } Instructions Follow these steps to conﬁgure the automation: 1. Navigate to the AWSSupport-TroubleshootOpenSearchRedYellowCluster in the AWS Systems Manager console. 2. Select Execute automation. AWSSupport-TroubleshootOpenSearchRedYellowCluster 492 AWS Systems Manager Automation runbook reference User Guide 3. For the input parameters enter the following: • AutomationAssumeRole (Optional): The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • LambdaExecutionRole (Required): The ARN of the IAM role that Lambda will use to sign requests to your Amazon OpenSearch Service cluster. • DomainName (Required): The name of the OpenSearch Service domain with red or yellow cluster health status. • UtilizationThreshold (Optional): The utilization threshold percentage used to compare the CPUUtilization and JVMMemoryPressure metrics. Default value is 80. 4. If you have enabled ﬁne-grained access control on an OpenSearch Service cluster, make sure that the LambdaExecutionRole role arn is mapped to a role with at least cluster_monitor permission. AWSSupport-TroubleshootOpenSearchRedYellowCluster 493 AWS Systems Manager Automation runbook reference User Guide 5. Select Execute. 6. The automation initiates. 7. The automation runbook performs the following steps: • GetClusterConﬁguration: Fetches the OpenSearch Service cluster conﬁguration. • CreateAWSLambdaFunctionStack: Creates a temporary Lambda function in your account using AWS CloudFormation. The Lambda function is used to run the OpenSearch Service APIs. • WaitForAWSLambdaFunctionStack: Waits for the CloudFormation stack to complete. • GetClusterMetricsFromCloudWatch: Gets the Amazon CloudWatch ClusterStatus, CPUUtilization, and JVMMemoryPressure OpenSearch Service cluster related metrics and its creation date. • RunOpenSearchAPIs: Uses the Lambda function to call the OpenSearch Service APIs and analyze the cluster metrics data to diagnose the cause for the red or yellow cluster status. • DeleteAWSLambdaFunctionStack: Deletes the Lambda function created by this automation in your account. 8. After completed, review the Outputs section for the detailed results of the execution. • RootCause: Provides an overview of the identiﬁed cause for cluster health to be in red or yellow state. • IssueDescription: AWSSupport-TroubleshootOpenSearchRedYellowCluster 494 AWS Systems Manager Automation runbook reference User Guide Provides details for why the cluster is in red or yellow state and possible steps to return the cluster to green state. References Systems Manager Automation • Run this Automation (console) • Run an automation • Setting up an Automation • Support Automation Workﬂows landing page AWS service documentation • Refer toTroubleshooting Amazon OpenSearch Service for more information AWSSupport-TroubleshootOpenSearchHighCPU Description The AWSSupport-TroubleshootOpenSearchHighCPU runbook provides an automated solution to collect diagnostic data from an Amazon OpenSearch Service domain to troubleshoot high CPU issues. How does it work? The AWSSupport-TroubleshootOpenSearchHighCPU runbook helps to troubleshoot high CPU utilization in the Amazon OpenSearch Service domain. The runbook performs the following steps: • Runs the DescribeDomain API against the provided Amazon OpenSearch Service domain to get the cluster metadata. • Checks whether the Amazon OpenSearch Service domain is public or Amazon VPC-based and with the help of AWS CloudFormation, creates a public or Amazon VPC-based AWS Lambda function. • The Lambda function fetches diagnostic data from the Amazon OpenSearch Service domains. AWSSupport-TroubleshootOpenSearchHighCPU 495 AWS Systems Manager Automation runbook reference User Guide • Uses an AWS Step Functions state machine to orchestrate multiple Lambda function executions to gather more comprehensive data. • Stores the collected data in an Amazon CloudWatch log group for 24 hours by default. • Deletes the created resources, except the CloudWatch log group. Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • cloudformation:CreateStack • cloudformation:CreateStack • cloudformation:DescribeStacks • cloudformation:DescribeStackEvents • cloudformation:DeleteStack • lambda:CreateFunction • lambda:DeleteFunction • lambda:InvokeFunction • lambda:GetFunction • lambda:TagResource • es:DescribeDomain • ec2:DescribeSecurityGroups • ec2:DescribeSubnets AWSSupport-TroubleshootOpenSearchHighCPU 496 AWS Systems Manager Automation runbook reference User Guide • ec2:DescribeVpcs • ec2:DescribeNetworkInterfaces • ec2:CreateNetworkInterface • ec2:DescribeInstances • ec2:AttachNetworkInterface • ec2:DeleteNetworkInterface • logs:CreateLogGroup • logs:PutRetentionPolicy • logs:TagResource • states:CreateStateMachine • states:DeleteStateMachine • states:StartExecution • states:TagResource • states:DescribeStateMachine • states:DescribeExecution • iam:PassRole • iam:CreateRole • iam:DeleteRole • iam:GetRole • iam:PutRolePolicy • iam:DeleteRolePolicy • ssm:DescribeAutomationExecutions • ssm:GetAutomationExecution The LambdaExecutionRole parameter requires the following actions to successfully use the runbook: • es:ESHttpGet • ec2:CreateNetworkInterface • ec2:DescribeNetworkInterfaces • ec2:DeleteNetworkInterface AWSSupport-TroubleshootOpenSearchHighCPU 497 AWS Systems Manager Automation runbook reference User Guide • logs:CreateLogStream • logs:PutLogEvents The Lambda execution role grants the function permission to access AWS services and resources required by this runbook. For more information, see Lambda execution role.
systems-manager-automation-runbook-guide-122	systems-manager-automation-runbook-guide.pdf	122	ec2:CreateNetworkInterface • ec2:DescribeInstances • ec2:AttachNetworkInterface • ec2:DeleteNetworkInterface • logs:CreateLogGroup • logs:PutRetentionPolicy • logs:TagResource • states:CreateStateMachine • states:DeleteStateMachine • states:StartExecution • states:TagResource • states:DescribeStateMachine • states:DescribeExecution • iam:PassRole • iam:CreateRole • iam:DeleteRole • iam:GetRole • iam:PutRolePolicy • iam:DeleteRolePolicy • ssm:DescribeAutomationExecutions • ssm:GetAutomationExecution The LambdaExecutionRole parameter requires the following actions to successfully use the runbook: • es:ESHttpGet • ec2:CreateNetworkInterface • ec2:DescribeNetworkInterfaces • ec2:DeleteNetworkInterface AWSSupport-TroubleshootOpenSearchHighCPU 497 AWS Systems Manager Automation runbook reference User Guide • logs:CreateLogStream • logs:PutLogEvents The Lambda execution role grants the function permission to access AWS services and resources required by this runbook. For more information, see Lambda execution role. Note The ec2:DescribeNetworkInterfaces, ec2:CreateNetworkInterface, and ec2:DeleteNetworkInterface are only required if your OpenSearch Service cluster is Amazon VPC-based to allow the Lambda function to create and manage the Amazon VPC network interfaces. For more information, see Connecting outbound networking to resources in a Amazon VPC and Lambda execution role. Instructions Follow these steps to conﬁgure the automation: 1. Navigate to the AWSSupport-TroubleshootOpenSearchHighCPU in the AWS Systems Manager console. 2. Select Execute automation. 3. For the input parameters enter the following: • AutomationAssumeRole (Optional): The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • DomainName (Required): The name of the Amazon OpenSearch Service domain that you want to troubleshoot for high CPU issues. • LambdaExecutionRoleForOpenSearch (Required): The ARN of the IAM role to attach to the Lambda function. The Lambda function uses the credentials from this role to sign requests to the Amazon OpenSearch Service domain. If AWSSupport-TroubleshootOpenSearchHighCPU 498 AWS Systems Manager Automation runbook reference User Guide ﬁne-grained access control is enabled on the Amazon OpenSearch Service domain, you must map this role to an OpenSearch Service Dashboards backend role with a minimum of "cluster_monitor" permission. • DataRetentionDays (Optional): The number of days to retain the diagnostic data collected from the Amazon OpenSearch Service domain. By default, the data is retained for 24 hours (one day). You can choose to retain the data for a maximum of up to 30 days. • NumberOfDataSamples (Optional): The number of data samples to collect from the Amazon OpenSearch Service domain. By default, 5 data sample are collected. You can collect up to 10 samples and the Lambda function will be invoked for each sample collection. 4. If you have enabled ﬁne-grained access control on an OpenSearch Service cluster, make sure that the LambdaExecutionRole role arn is mapped to a role with at least cluster_monitor permission. 5. Select Execute. AWSSupport-TroubleshootOpenSearchHighCPU 499 AWS Systems Manager Automation runbook reference User Guide 6. The automation initiates. 7. The automation runbook performs the following steps: • checkConcurrency: Ensures that there is only one execution of this runbook targeting the speciﬁed Amazon OpenSearch Service domain. If the runbook ﬁnds another execution targeting the same domain name, it returns an error and ends. • getDomainConﬁg: Gets the conﬁguration details for the target OpenSearch Service domain. • provisionResources: Provisions the resources for data collection using AWS CloudFormation. • waitForStackCreation: Waits for the AWS CloudFormation stack to complete. • describeStackResources: Describes the AWS CloudFormation stack and gets the ARN of the state machine. • runStateMachine: Invokes the data collector Lambda function one or more times by running a Step Functions state machine. • describeErrorsFromStackEvents: Describes errors from the AWS CloudFormation stack for errors. • unstageOpenSearchHighCPUAutomation: Deletes the AWSSupport-TroubleshootOpenSearchHighCPU AWS CloudFormation stack. • describeErrorsFromStackDeletion: Describes errors encountered while deleting the AWS CloudFormation stack. • ﬁnalStatus: Returns the ﬁnal output of the AWSSupport-TroubleshootOpenSearchHighCPU runbook. 8. After completed, review the Outputs section for the detailed results of the execution. AWSSupport-TroubleshootOpenSearchHighCPU • ﬁnalStatus.FinalOutput: 500 AWS Systems Manager Automation runbook reference User Guide Provides the CloudWatch log group where the diagnostic data is stored. References Systems Manager Automation • Run this Automation (console) • Run an automation • Setting up an Automation • Support Automation Workﬂows landing page AWS service documentation • Refer toTroubleshooting Amazon OpenSearch Service for more information EventBridge AWS Systems Manager Automation provides predeﬁned runbooks for Amazon EventBridge. For more information about runbooks, see Working with runbooks. For information about how to view runbook content, see View runbook content. Topics • AWS-AddOpsItemDedupStringToEventBridgeRule • AWS-DisableEventBridgeRule AWS-AddOpsItemDedupStringToEventBridgeRule Description The AWS-AddOpsItemDedupStringToEventBridgeRule runbook adds a deduplication string for all AWS Systems Manager OpsItems associated with an Amazon EventBridge rule. The runbook doesn't add a deduplication string to the rule if one has already been applied. To learn more EventBridge 501 AWS Systems Manager Automation runbook reference User Guide deduplication strings and OpsItems, see Reducing duplicate OpsItems in the AWS Systems Manager User Guide . Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Optional) The
systems-manager-automation-runbook-guide-123	systems-manager-automation-runbook-guide.pdf	123	to view runbook content, see View runbook content. Topics • AWS-AddOpsItemDedupStringToEventBridgeRule • AWS-DisableEventBridgeRule AWS-AddOpsItemDedupStringToEventBridgeRule Description The AWS-AddOpsItemDedupStringToEventBridgeRule runbook adds a deduplication string for all AWS Systems Manager OpsItems associated with an Amazon EventBridge rule. The runbook doesn't add a deduplication string to the rule if one has already been applied. To learn more EventBridge 501 AWS Systems Manager Automation runbook reference User Guide deduplication strings and OpsItems, see Reducing duplicate OpsItems in the AWS Systems Manager User Guide . Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • DedupString Type: String Description: (Required) The deduplication string you want to add to the rule. • RuleName Type: String Description: (Required) The name of the rule you want to add the deduplication string to. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. AWS-AddOpsItemDedupStringToEventBridgeRule 502 AWS Systems Manager Automation runbook reference User Guide • ssm:StartAutomationExecution • ssm:GetAutomationExecution • events:ListTargetsByRule • events:PutTargets Document Steps • aws:executeScript - Adds a deduplication string to the EventBridge rule you specify in the RuleName parameter. AWS-DisableEventBridgeRule Description The AWS-DisableEventBridgeRule runbook disables the Amazon EventBridge rule you specify.To learn more about EventBridge rules, see Amazon EventBridge rules in the Amazon EventBridge User Guide . Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on AWS-DisableEventBridgeRule 503 AWS Systems Manager Automation runbook reference User Guide your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • EventBusName Type: String Default: default Description: (Optional) The event bus associated with the rule you want to disable. • RuleName Type: String Description: (Required) The name of the rule you want to disable. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • events:DisableRule Document Steps • aws:executeAwsApi - Disables the EventBridge rule you specify in the RuleName parameter. AWS Glue AWS Systems Manager Automation provides predeﬁned runbooks for AWS Glue. For more information about runbooks, see Working with runbooks. For information about how to view runbook content, see View runbook content. Topics • AWSSupport-TroubleshootGlueConnection AWS Glue 504 AWS Systems Manager Automation runbook reference User Guide AWSSupport-TroubleshootGlueConnection Description The AWSSupport-TroubleshootGlueConnections runbook helps troubleshoot AWS Glue connection issues. The target of the tested connection must be reached through a JDBC connection and can be either an Amazon Relational Database Service (Amazon RDS) cluster/instance, a Amazon Redshift cluster, or any other target accessible through JDBC. In the ﬁrst two cases, the Reachability Analyzer tool is used to determine if the connectivity between the source (AWS Glue) and the target (Amazon RDS or Amazon Redshift) is granted. If the target of the connection is not Amazon RDS nor Amazon Redshift, connectivity is still tested by creating an AWS Lambda function in the same subnet as the AWS Glue connection (a network point of presence) and checking if the target name is resolvable and if it's reachable in the target port. Important In order to run the Reachability Analyzer checks, Elastic Network Interfaces will be created in each of the connection's datasource subnets. Please make sure you have enough free IPs on those subnets and that the consumption of one IP will not impact your workload before running this automation. Important All the resources created by this automation are tagged so that they can be easily found. The tags used are: • AWSSupport-TroubleshootGlueConnection: true • AutomationExecutionId: Amazon EC2 Systems Manager Execution Id How does it work? The runbook performs the following steps: • Describes the AWS Glue connection to get the source information (subnet and security groups) for the connectivity checks. AWSSupport-TroubleshootGlueConnection 505 AWS Systems Manager Automation runbook reference User Guide • Fetches the target information (subnet and security groups) from the datasource referenced in the JDBC URL or from the DatasourceSecurityGroups and DatasourceSubnets parameters if they are present. • If the datasource present in the JDBC URL is a Amazon RDS instance or cluster or a Amazon Redshift cluster, this automation creates ENIs using both the source and target information gathered in the previous steps and uses Reachability Analyzer to perform a connectivity check between them. • A Lambda function (network point of presence, in the context of this automation) is used to perform L4 connectivity and name resolution checks.
systems-manager-automation-runbook-guide-124	systems-manager-automation-runbook-guide.pdf	124	• Fetches the target information (subnet and security groups) from the datasource referenced in the JDBC URL or from the DatasourceSecurityGroups and DatasourceSubnets parameters if they are present. • If the datasource present in the JDBC URL is a Amazon RDS instance or cluster or a Amazon Redshift cluster, this automation creates ENIs using both the source and target information gathered in the previous steps and uses Reachability Analyzer to perform a connectivity check between them. • A Lambda function (network point of presence, in the context of this automation) is used to perform L4 connectivity and name resolution checks. • The same Lambda function is used to perform the checks against the Amazon S3 endpoint. • Policy Simulator is used to determine if the IAM role used in the connection has the needed permissions. • The automation checks if the security group used by the connection has the expected conﬁguration. • A report is generated containing the possible causes for the failure in the test connection operation and/or also the succeeded tests that were performed. Run this Automation (console) Document type Automation Owner Amazon Platforms / Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • cloudformation:CreateStack • cloudformation:DeleteStack • ec2:CreateNetworkInsightsPath AWSSupport-TroubleshootGlueConnection 506 AWS Systems Manager Automation runbook reference User Guide • ec2:CreateNetworkInterface • ec2:CreateTags • ec2:DeleteNetworkInsightsAnalysis • ec2:DeleteNetworkInsightsPath • ec2:DeleteNetworkInterface • ec2:StartNetworkInsightsAnalysis • iam:AttachRolePolicy • iam:CreateRole • iam:DeleteRole • iam:DeleteRolePolicy • iam:DetachRolePolicy • iam:PutRolePolicy • iam:TagRole • lambda:CreateFunction • lambda:DeleteFunction • lambda:TagResource • logs:CreateLogGroup • logs:DeleteLogGroup • logs:PutRetentionPolicy • logs:TagResource • glue:GetConnection • glue:GetDataCatalogEncryptionSettings • cloudformation:DescribeStacks • cloudformation:DescribeStackEvents • ec2:DescribeDhcpOptions • ec2:DescribeNetworkInsightsPaths • ec2:DescribeNetworkInsightsAnalyses • ec2:DescribeSecurityGroupRules • ec2:DescribeSecurityGroups • ec2:DescribeSubnets AWSSupport-TroubleshootGlueConnection 507 AWS Systems Manager Automation runbook reference User Guide • ec2:DescribeVpcs • ec2:DescribeVpcAttribute • iam:GetRole • iam:ListAttachedRolePolicies • iam:SimulatePrincipalPolicy • kms:DescribeKey • lambda:InvokeFunction • lambda:GetFunction • s3:GetEncryptionConfiguration • iam:PassRole Important In addition to the above mentioned actions, the AutomationAssumeRole should have the AmazonVPCReachabilityAnalyzerFullAccessPolicy as an attached managed policy so that the Reachability Analyzer tests are performed successfully. Here is an example of a policy that could be granted for the AutomationAssumeRole: { "Version": "2012-10-17", "Statement": [{ "Sid": "TaggedAWSResourcesPermissions", "Effect": "Allow", "Condition": { "StringEquals": { "aws:ResourceTag/AWSSupport-TroubleshootGlueConnection": "true" } }, "Action": [ "iam:AttachRolePolicy", "iam:CreateRole", "iam:DeleteRole", "iam:DeleteRolePolicy", "iam:DetachRolePolicy", AWSSupport-TroubleshootGlueConnection 508 AWS Systems Manager Automation runbook reference User Guide "iam:TagRole", "lambda:CreateFunction", "lambda:DeleteFunction", "lambda:TagResource", "logs:DeleteLogGroup", "logs:CreateLogGroup", "logs:PutRetentionPolicy", "logs:TagResource", "cloudformation:CreateStack", "cloudformation:DeleteStack" ], "Resource": "" }, { "Sid": "TaggedEC2ResourcesPermissions", "Effect": "Allow", "Condition": { "StringEquals": { "ec2:ResourceTag/AWSSupport-TroubleshootGlueConnection": "true" } }, "Action": [ "ec2:DeleteNetworkInterface" ], "Resource": "" }, { "Sid": "PutRolePolicy", "Effect": "Allow", "Condition": { "StringEquals": { "iam:ResourceTag/AWSSupport-TroubleshootGlueConnection": "true" } }, "Action": [ "iam:PutRolePolicy", "iam:DeleteRolePolicy" ], "Resource": "" }, { "Sid": "InvokeFunction", "Effect": "Allow", "Action": [ AWSSupport-TroubleshootGlueConnection 509 AWS Systems Manager Automation runbook reference User Guide "lambda:InvokeFunction" ], "Resource": "arn::lambda:::function:point-of-presence-" }, { "Sid": "UnTaggedActions", "Effect": "Allow", "Action": [ "ec2:CreateNetworkInsightsPath", "ec2:DeleteNetworkInsightsAnalysis", "ec2:DeleteNetworkInsightsPath", "ec2:CreateNetworkInterface", "ec2:CreateTags", "ec2:StartNetworkInsightsAnalysis", "glue:GetConnection", "glue:GetDataCatalogEncryptionSettings", "cloudformation:DescribeStacks", "cloudformation:DescribeStackEvents", "ec2:DescribeDhcpOptions", "ec2:DescribeNetworkInsightsPaths", "ec2:DescribeNetworkInsightsAnalyses", "ec2:DescribeSecurityGroupRules", "ec2:DescribeSecurityGroups", "ec2:DescribeSubnets", "ec2:DescribeVpcs", "ec2:DescribeVpcAttribute", "iam:GetRole", "iam:ListAttachedRolePolicies", "iam:SimulatePrincipalPolicy", "kms:DescribeKey", "lambda:GetFunction", "s3:GetEncryptionConfiguration" ], "Resource": "" }, { "Effect": "Allow", "Action": [ "iam:PassRole" ], "Resource": "arn::iam:::role/point-of-presence-*", "Condition": { "StringLikeIfExists": { "iam:PassedToService": "lambda.amazonaws.com" AWSSupport-TroubleshootGlueConnection 510 AWS Systems Manager Automation runbook reference User Guide } } } ] } Instructions Follow these steps to conﬁgure the automation: 1. Navigate to AWSSupport-TroubleshootGlueConnection in Systems Manager under Documents. 2. Select Execute automation. 3. For the input parameters, enter the following: • AutomationAssumeRole (Optional): The Amazon Resource Name (ARN) of the AWS AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user who starts this runbook. • TestConnectionRole (Required) The Amazon Resource Name (ARN) of the IAM role that is used during the connection test. • ConnectionName (Required) AWS Glue failed test connection name you want to troubleshoot. • PersistReachabilityAnalyzerResults (Optional) The ﬂag informing if the results of the Reachability Analyzer execution should be kept or not. Default: false. • PointOfPresenceLogRetentionPeriod (Optional) The amount of days the logs for the point of presence Lambda will be stored for. Default: 7. • DatasourceSubnets (Optional) If the original datasource is not available, use this parameter to provide the subnets that it used so that the connectivity tests are still performed. Must be used with DatasourceSecurityGroups. Example: subnet-1,subnet-2. AWSSupport-TroubleshootGlueConnection 511 AWS Systems Manager Automation runbook reference User Guide • DatasourceSecurityGroups (Optional) If the original datasource is not available, use this parameter to provide the security groups it used so that the connectivity tests are still performed. Must be used with DatasourceSubnets. Example: sg-1,sg-2. 4. Select Execute. 5. The automation initiates. 6. The automation runbook performs the following steps: • ParseInputs: This step validates the combination of inputs. If both DatasourceSecurityGroups and DatasourceSubnets are provided, they are valid and returned as is. If none are provided, two
systems-manager-automation-runbook-guide-125	systems-manager-automation-runbook-guide.pdf	125	connectivity tests are still performed. Must be used with DatasourceSecurityGroups. Example: subnet-1,subnet-2. AWSSupport-TroubleshootGlueConnection 511 AWS Systems Manager Automation runbook reference User Guide • DatasourceSecurityGroups (Optional) If the original datasource is not available, use this parameter to provide the security groups it used so that the connectivity tests are still performed. Must be used with DatasourceSubnets. Example: sg-1,sg-2. 4. Select Execute. 5. The automation initiates. 6. The automation runbook performs the following steps: • ParseInputs: This step validates the combination of inputs. If both DatasourceSecurityGroups and DatasourceSubnets are provided, they are valid and returned as is. If none are provided, two empty lists are returned. If just one of them is provided, the step raises a ValueException. • GetConnectionDetails: This steps returns the details of the provided AWS Glue connection. • ParseSecurityGroupList: This step is used to concatenate the SecurityGroupIdList in a String for future utilization in this automation. • GetConnectionData: AWSSupport-TroubleshootGlueConnection 512 AWS Systems Manager Automation runbook reference User Guide Determines based on the JDBC URL, what type of connection between: RedShift, RdsInstance, RdsCluster and Other. In addition, returns the domain and port used in the JDBC connection, the connection's Amazon VPC and its domain name servers. • GetNetworkDetails: Gets the subnet and security group information from the Amazon RDS or Amazon Redshift target. • CreateENITemplate: Generates the AWS CloudFormation template used to create the network interfaces that are used to test connectivity. This is required to run the Reachability Analyzer tool. • CreateENIStack: Creates the AWS CloudFormation stack from the template created in the previous step. • GetStackDetails: Describes the AWS CloudFormation stack created in the previous stack and retrieve the SourceNetworkInterface an TargetNetworkInterfaces information. • RunSourceToTargetCheck: Runs checks between the source and target ENIs created in the previous step using the Reachability Analyzer tool. • DeleteENIStack: Deletes the AWS CloudFormation stack that creates Network Interfaces • CreateNetworkPointOfPresence: AWS CloudFormation creates the Lambda function used as network point of presence. • GetFunctionName: Performs a AWS CloudFormation describe stack API call to retrieve the name of the Lambda function created in the previous step. • RunEndpointChecks: Uses the network point of presence to determine if the endpoint present in the JDBC connection is resolvable and reachable in the declared port. • CheckS3Connectivity: AWSSupport-TroubleshootGlueConnection 513 AWS Systems Manager Automation runbook reference User Guide Checks the network connectivity from the AWS Glue connection to the Amazon S3 service. • DeletePointOfPresence: Deletes the AWS CloudFormation stack that creates the network point of presence Lambda. • TestIAMRolePermissions: Checks if the IAM role used for the test has the needed permissions to execute it. • CheckConnectionSecurityGroupReferencingRule: Checks if the security group used in the AWS Glue connection is allowing all ingress traﬃc from itself. It will return a list of the security groups without this rule, if any. • GenerateReport: Generates a report containing a list o ﬁndings (possible reasons for the failure in the connection test) and next steps (attempts to resolve the connection test failure). 7. After completed, review the Outputs section for the detailed results of the execution: • Automation Results In this section, you will ﬁnd scenarios describing possible causes for the test connection operation to fail (ﬁndings) and how they can be ﬁxed (next steps). If the automation cannot ﬁnd the cause of the test failure, this will be informed in this section as well. • Successful Tests In this section, you will ﬁnd scenarios informing what has been successfully tested by this automation. Succeeded tests are useful in case the automation is not able to identify the cause of the test connection failure as they reduce the scope of the investigation by informing what is not contributing for the issue. • Automation Errors In this section, you will ﬁnd scenarios describing issues that happened during the automation, that may have limited the number of tests the automation could perform. The description of the scenario will inform which step has failed. AWSSupport-TroubleshootGlueConnection 514 AWS Systems Manager Automation runbook reference User Guide References Systems Manager Automation • Run this Automation (console) • Run an automation • Setting up an Automation • Support Automation Workﬂows landing page Amazon FSx AWS Systems Manager Automation provides predeﬁned runbooks for Amazon FSx. For more information about runbooks, see Working with runbooks. For information about how to view runbook content, see View runbook content. Topics • AWSSupport-ValidateFSxWindowsADConﬁg Amazon FSx 515 AWS Systems Manager Automation runbook reference User Guide AWSSupport-ValidateFSxWindowsADConfig Description The AWSSupport-ValidateFSxWindowsADConfig runbook is used to validate the self-managed Active Directory (AD) conﬁguration of an Amazon FSx for Windows File Server How does it work? The runbook AWSSupport-ValidateFSxWindowsADConfig executes the Amazon FSx validation script on the temporary Amazon Elastic Compute Cloud (Amazon EC2) Windows instance launched by the runbook on the Amazon FSx subnet. The script performs multiple checks to validate the network connectivity to self-managed
systems-manager-automation-runbook-guide-126	systems-manager-automation-runbook-guide.pdf	126	about runbooks, see Working with runbooks. For information about how to view runbook content, see View runbook content. Topics • AWSSupport-ValidateFSxWindowsADConﬁg Amazon FSx 515 AWS Systems Manager Automation runbook reference User Guide AWSSupport-ValidateFSxWindowsADConfig Description The AWSSupport-ValidateFSxWindowsADConfig runbook is used to validate the self-managed Active Directory (AD) conﬁguration of an Amazon FSx for Windows File Server How does it work? The runbook AWSSupport-ValidateFSxWindowsADConfig executes the Amazon FSx validation script on the temporary Amazon Elastic Compute Cloud (Amazon EC2) Windows instance launched by the runbook on the Amazon FSx subnet. The script performs multiple checks to validate the network connectivity to self-managed AD/DNS servers and permissions of the Amazon FSx service account. The runbook can validate a failed or misconﬁgured Amazon FSx for Windows File Server or create a new Amazon FSx for Windows File Server with self-managed AD. By default, the runbook creates the Amazon EC2 Windows instance, security group for AWS Systems Manager (SSM) access, AWS Identity and Access Management (IAM) role and policy using AWS CloudFormation on the Amazon FSx subnet. If you want to run the script on an existing Amazon EC2 instance, provide the ID in the parameter InstanceId. On successful execution, it deletes the CloudFormation resources. However, to retain the resources, set the RetainCloudFormationStack parameter to true. The CloudFormation template creates an IAM role on your behalf with required permissions to attach to the Amazon EC2 instance to run the Amazon FSx validation script. To specify an existing IAM instance proﬁle for the temporary instance, use the InstanceProfileName parameter. The associated IAM role must contain the following permissions: • ec2:DescribeSubnets and ec2:DescribeVpcs permissions and the Amazon Managed Policy AmazonSSMManagedInstanceCore. • Permissions to get the Amazon FSx service account username and password from Systems Manager by calling the GetSecretValue API. • Permissions to put object in the Amazon Simple Storage Service (Amazon S3) bucket for the script output. Prerequisites The subnet where the temporary Amazon EC2 instance is created (or the existing instance provided in the InstanceId parameter) must allow access to the AWS Systems Manager, AWS Secrets AWSSupport-ValidateFSxWindowsADConfig 516 AWS Systems Manager Automation runbook reference User Guide Manager, and Amazon S3 endpoints in order to run the AmazonFSxADValidation script using SSM Run Command. AWS Secrets Manager setup The validation script connects to the Microsoft AD domain by retrieving the Amazon FSx service account username and password with a runtime call to Secrets Manager. Follow the steps in Create an AWS Secrets Manager secret to create a new Secrets Manager secret. Make sure that the username and password are stored using a key/value pair in the format {"username":"EXAMPLE-USER","password":"EXAMPLE-PASSWORD"}". Refer to Authentication and access control for AWS Secrets Manager for information about securing access to secrets. For more information about the tool, refer to the TROUBLESHOOTING.md and README.md ﬁles in the AmazonFSxADValidation ﬁle. Runbook execution Execute the runbook with Amazon FSx ID or AD parameters. Following is the runbook workﬂow: • Gets the parameters from the Amazon FSx ID or uses the input AD parameters. • Creates the temporary validation Amazon EC2 Windows instance on the Amazon FSx subnet, security group for SSM access, IAM role and policy (conditional) using CloudFormation. If the InstanceId parameter is speciﬁed, it is used. • Downloads and executes the validation script on the target Amazon EC2 instance in Amazon FSx primary subnet. • Provides the AD validation result code in the automation output. Additionally, the complete script output is uploaded to the Amazon S3 bucket. Run this Automation (console) Document type Automation Owner Amazon Platforms AWSSupport-ValidateFSxWindowsADConfig 517 AWS Systems Manager Automation runbook reference User Guide Windows Parameters Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • cloudformation:CreateStack • cloudformation:DeleteStack • cloudformation:DescribeStacks • cloudformation:DescribeStackResources • cloudformation:DescribeStackEvents • ec2:CreateTags • ec2:RunInstances • ec2:TerminateInstances • ec2:CreateLaunchTemplate • ec2:DeleteLaunchTemplate • ec2:DescribeSubnets • ec2:DescribeSecurityGroups • ec2:DescribeImages • ec2:DescribeInstances • ec2:DescribeLaunchTemplates • ec2:DescribeLaunchTemplateVersions • ec2:CreateSecurityGroup • ec2:DeleteSecurityGroup • ec2:RevokeSecurityGroupEgress • ec2:AuthorizeSecurityGroupEgress • iam:CreateRole • iam:CreateInstanceProfile • iam:GetInstanceProfile AWSSupport-ValidateFSxWindowsADConfig 518 AWS Systems Manager Automation runbook reference User Guide • iam:getRolePolicy • iam:DeleteRole • iam:DeleteInstanceProfile • iam:AddRoleToInstanceProfile • iam:RemoveRoleFromInstanceProfile • iam:AttachRolePolicy • iam:DetachRolePolicy • iam:PutRolePolicy • iam:DeleteRolePolicy • iam:GetRole • iam:PassRole • ssm:SendCommand • ssm:StartAutomationExecution • ssm:DescribeInstanceInformation • ssm:DescribeAutomationExecutions • ssm:GetDocument • ssm:GetAutomationExecution • ssm:DescribeAutomationStepExecutions • ssm:ListCommandInvocations • ssm:GetParameters • ssm:ListCommands • ssm:GetCommandInvocation • fsx:DescribeFileSystems • ds:DescribeDirectories • s3:GetEncryptionConfiguration • s3:GetBucketPublicAccessBlock • s3:GetAccountPublicAccessBlock • s3:GetBucketPolicyStatus • s3:GetBucketAcl • s3:GetBucketLocation AWSSupport-ValidateFSxWindowsADConfig 519 AWS Systems Manager Automation runbook reference User Guide Example IAM Policy for the Automation Assume Role { "Version": "2012-10-17", "Statement": [ { "Sid": "AllowDescribe", "Effect": "Allow", "Action": [ "ec2:DescribeSubnets", "ec2:DescribeSecurityGroups", "ec2:DescribeImages", "ec2:DescribeInstances", "ec2:DescribeLaunchTemplates", "ec2:DescribeLaunchTemplateVersions", "ssm:DescribeInstanceInformation", "ssm:DescribeAutomationExecutions", "ssm:DescribeAutomationStepExecutions", "fsx:DescribeFileSystems", "ds:DescribeDirectories" ], "Resource": "" }, { "Sid": "CloudFormation", "Effect": "Allow", "Action": [ "cloudformation:DescribeStacks", "cloudformation:DescribeStackResources", "cloudformation:DescribeStackEvents", "cloudformation:CreateStack", "cloudformation:DeleteStack" ], "Resource": "arn::cloudformation:::stack/AWSSupport- ValidateFSxWindowsADConfig-*" }, { "Sid": "AllowCreateLaunchTemplate", "Effect": "Allow", "Action": [ "ec2:CreateLaunchTemplate", "ec2:CreateTags" ], AWSSupport-ValidateFSxWindowsADConfig 520
systems-manager-automation-runbook-guide-127	systems-manager-automation-runbook-guide.pdf	127	• ssm:DescribeAutomationStepExecutions • ssm:ListCommandInvocations • ssm:GetParameters • ssm:ListCommands • ssm:GetCommandInvocation • fsx:DescribeFileSystems • ds:DescribeDirectories • s3:GetEncryptionConfiguration • s3:GetBucketPublicAccessBlock • s3:GetAccountPublicAccessBlock • s3:GetBucketPolicyStatus • s3:GetBucketAcl • s3:GetBucketLocation AWSSupport-ValidateFSxWindowsADConfig 519 AWS Systems Manager Automation runbook reference User Guide Example IAM Policy for the Automation Assume Role { "Version": "2012-10-17", "Statement": [ { "Sid": "AllowDescribe", "Effect": "Allow", "Action": [ "ec2:DescribeSubnets", "ec2:DescribeSecurityGroups", "ec2:DescribeImages", "ec2:DescribeInstances", "ec2:DescribeLaunchTemplates", "ec2:DescribeLaunchTemplateVersions", "ssm:DescribeInstanceInformation", "ssm:DescribeAutomationExecutions", "ssm:DescribeAutomationStepExecutions", "fsx:DescribeFileSystems", "ds:DescribeDirectories" ], "Resource": "" }, { "Sid": "CloudFormation", "Effect": "Allow", "Action": [ "cloudformation:DescribeStacks", "cloudformation:DescribeStackResources", "cloudformation:DescribeStackEvents", "cloudformation:CreateStack", "cloudformation:DeleteStack" ], "Resource": "arn::cloudformation:::stack/AWSSupport- ValidateFSxWindowsADConfig-" }, { "Sid": "AllowCreateLaunchTemplate", "Effect": "Allow", "Action": [ "ec2:CreateLaunchTemplate", "ec2:CreateTags" ], AWSSupport-ValidateFSxWindowsADConfig 520 AWS Systems Manager Automation runbook reference User Guide "Resource": [ "arn:aws:ec2:::launch-template/" ] }, { "Sid": "AllowEC2RunInstances", "Effect": "Allow", "Action": [ "ec2:RunInstances", "ec2:CreateTags" ], "Resource": [ "arn:aws:ec2:::image/", "arn:aws:ec2:::snapshot/", "arn:aws:ec2:::subnet/", "arn:aws:ec2:::network-interface/", "arn:aws:ec2:::security-group/", "arn:aws:ec2:::key-pair/", "arn:aws:ec2:::launch-template/" ] }, { "Sid": "AllowEC2RunInstancesWithTags", "Effect": "Allow", "Action": [ "ec2:RunInstances", "ec2:CreateTags" ], "Resource": [ "arn:aws:ec2:::instance/", "arn:aws:ec2:::volume/" ] }, { "Sid": "EC2SecurityGroup", "Effect": "Allow", "Action": [ "ec2:CreateSecurityGroup", "ec2:RevokeSecurityGroupEgress", "ec2:AuthorizeSecurityGroupEgress", "ec2:CreateTags" ], "Resource": [ "arn::ec2:::security-group/", AWSSupport-ValidateFSxWindowsADConfig 521 AWS Systems Manager Automation runbook reference User Guide "arn::ec2:::vpc/" ] }, { "Sid": "EC2Remove", "Effect": "Allow", "Action": [ "ec2:TerminateInstances", "ec2:DeleteLaunchTemplate", "ec2:DeleteSecurityGroup" ], "Resource": [ "arn:aws:ec2:::instance/", "arn:aws:ec2:::launch-template/", "arn::ec2:::security-group/" ] }, { "Sid": "IAMInstanceProfile", "Effect": "Allow", "Action": [ "iam:CreateInstanceProfile", "iam:DeleteInstanceProfile", "iam:GetInstanceProfile", "iam:AddRoleToInstanceProfile", "iam:RemoveRoleFromInstanceProfile" ], "Resource": "arn::iam:::instance-profile/" }, { "Sid": "IAM", "Effect": "Allow", "Action": [ "iam:CreateRole", "iam:DeleteRole", "iam:AttachRolePolicy", "iam:DetachRolePolicy", "iam:getRolePolicy", "iam:PutRolePolicy", "iam:DeleteRolePolicy", "iam:GetRole", "iam:TagRole" ], "Resource": "arn::iam:::role/" AWSSupport-ValidateFSxWindowsADConfig 522 AWS Systems Manager Automation runbook reference User Guide }, { "Sid": "SSM", "Effect": "Allow", "Action": [ "ssm:StartAutomationExecution", "ssm:GetDocument", "ssm:GetAutomationExecution", "ssm:ListCommandInvocations", "ssm:GetParameters", "ssm:ListCommands", "ssm:GetCommandInvocation" ], "Resource": "" }, { "Sid": "SSMSendCommand", "Effect": "Allow", "Action": [ "ssm:SendCommand" ], "Resource": "arn:aws:ssm:::document/AWS- RunPowerShellScript" }, { "Sid": "SSMSendCommandOnlyFsxInstance", "Effect": "Allow", "Action": [ "ssm:SendCommand" ], "Resource": [ "arn:aws:ec2:::instance/" ], "Condition": { "StringLike": { "ssm:resourceTag/CreatedBy": [ "AWSSupport-ValidateFSxWindowsADConfig" ] } } }, { "Effect": "Allow", "Action": "iam:PassRole", AWSSupport-ValidateFSxWindowsADConfig 523 AWS Systems Manager Automation runbook reference User Guide "Resource": "", "Condition": { "StringEquals": { "iam:PassedToService": [ "ec2.amazonaws.com" ] } } }, { "Effect": "Allow", "Action": [ "s3:GetEncryptionConfiguration", "s3:GetBucketPublicAccessBlock", "s3:GetAccountPublicAccessBlock", "s3:GetBucketPolicyStatus", "s3:GetBucketAcl", "s3:GetBucketLocation" ], "Resource": "*" } ] } Instructions Follow these steps to conﬁgure the automation: 1. Navigate to AWSSupport-ValidateFSxWindowsADConfig in Systems Manager under Documents. 2. Select Execute automation. 3. To validate self-managed AD with an existing failed or misconﬁgured Amazon FSx, enter the following parameters: • AutomationAssumeRole (Optional): The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user who starts this runbook. • FSxId (Conditional): AWSSupport-ValidateFSxWindowsADConfig 524 AWS Systems Manager Automation runbook reference User Guide The Amazon FSx for Windows File Server ID. This is required to validate existing failed or misconﬁgured Amazon FSx. • SecretArn (Required): The ARN of your Secrets Manager secret containing the Amazon FSx service account username and password. Make sure that the username and password are stored using a key/value pair in the format {"username":"EXAMPLE-USER","password":"EXAMPLE-PASSWORD"}. The CloudFormation stack creates the validation instance with permissions to perform GetSecretValue to this ARN. • FSxSecurityGroupId (Required): The security group ID for the Amazon FSx for Windows File Server. • BucketName (Required): The Amazon S3 bucket to upload the validation results to. Make sure that the bucket is conﬁgured with server-side encryption (SSE) and the bucket policy does not grant unnecessary read/write permissions to parties that do not need to access the logs. Also make sure that the Amazon EC2 Windows instance has necessary access to the Amazon S3 bucket. 4. To validate self-managed AD conﬁguration for a new Amazon FSx creation, enter the following parameters: • AutomationAssumeRole (Optional): AWSSupport-ValidateFSxWindowsADConfig 525 AWS Systems Manager Automation runbook reference User Guide The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user who starts this runbook. • SecretArn (Required): The ARN of your Secrets Manager secret containing the Amazon FSx service account username and password. Make sure that the username and password are stored using a key/value pair in the format {"username":"EXAMPLE-USER","password":"EXAMPLE-PASSWORD"}. The CloudFormation stack creates the validation instance with permissions to perform GetSecretValue to this ARN. • FSxSecurityGroupId (Required): The security group ID for the Amazon FSx for Windows File Server. • BucketName (Required): The Amazon S3 bucket to upload the validation results to. Make sure that the bucket is conﬁgured with server-side encryption (SSE) and the bucket policy does not grant unnecessary read/write permissions to parties that do not need to access the logs. Also make sure that the Amazon EC2 Windows instance has necessary access to the Amazon S3 bucket. • FSxPreferredSubnetId (Conditional): The Amazon FSx for Windows File Server preferred subnet. • DomainName
systems-manager-automation-runbook-guide-128	systems-manager-automation-runbook-guide.pdf	128	validation instance with permissions to perform GetSecretValue to this ARN. • FSxSecurityGroupId (Required): The security group ID for the Amazon FSx for Windows File Server. • BucketName (Required): The Amazon S3 bucket to upload the validation results to. Make sure that the bucket is conﬁgured with server-side encryption (SSE) and the bucket policy does not grant unnecessary read/write permissions to parties that do not need to access the logs. Also make sure that the Amazon EC2 Windows instance has necessary access to the Amazon S3 bucket. • FSxPreferredSubnetId (Conditional): The Amazon FSx for Windows File Server preferred subnet. • DomainName (Conditional): The fully qualiﬁed domain name of your self-managed Microsoft AD domain. • DnsIpAddresses (Conditional): A list of up to two DNS server or domain controller IP addresses in your self-managed AD domain. For up to two IPs, enter them separated by a comma. • FSxAdminsGroup (Conditional): The Amazon FSx for Windows File Server delegated ﬁle system administrators group. By default, this is Domain Admins. • FSxOrganizationalUnit (Conditional): AWSSupport-ValidateFSxWindowsADConfig 526 AWS Systems Manager Automation runbook reference User Guide The Organizational Unit (OU) within which you want to join your ﬁle system. Provide the distinguished path name of the OU. Example: OU=org,DC=example,DC=com. 5. Select Execute. 6. The automation initiates. 7. The document performs the following steps: • CheckBucketPublicStatus (aws:executeScript): Checks if the target Amazon S3 bucket potentially grants read and/or write public access to its objects. • BranchOnInputParameters (aws:branch): Branches on the provided input parameters such as Amazon FSx ID or Amazon FSx parameters. • AssertFileSystemTypeIsWindows (aws:assertAwsResourceProperty): If Amazon FSx ID is provided, validates the ﬁle system type is Amazon FSx for Windows File Server. • GetValidationInputs (aws:executeScript): AWSSupport-ValidateFSxWindowsADConfig 527 AWS Systems Manager Automation runbook reference User Guide Returns the self-managed Microsoft AD conﬁguration required by the CloudFormation template to create the Amazon EC2 instance. • BranchOnInstanceId (aws:branch): Branches on the provided input InstanceId. If InstanceId is provided, the validation script runs on the target Amazon EC2 instance from automation step:RunValidationScript. • CreateEC2InstanceStack (aws:createStack): Creates the Amazon EC2 instance in the preferred subnet using AWS CloudFormation where the AmazonFSxADValidation tool will be executed • DescribeStackResources (aws:executeAwsApi): Describes the CloudFormation stack to get the temporary Amazon EC2 instance ID. • WaitForEC2InstanceToBeManaged (aws:waitForAwsResourceProperty): Waits until the Amazon EC2 instance is managed by Systems Manager in order to run the validation script using SSM Run Command. • GetAmazonFSxADValidationAttachment (aws:executeAwsApi): Gets the AmazonFSxADValidation tool URL from the runbook attachments. • RunValidationScript (aws:runCommand): Runs the AmazonFSxADValidation tool on the temporary Amazon EC2 instance and stores the result in the Amazon S3 bucket speciﬁed in the BucketName parameter. • DescribeErrorsFromStackEvents (aws:executeScript): Describes the CloudFormation stack events if the runbooks fails to create the stack. • BranchOnRetainCloudFormationStack (aws:branch): Branches on the RetainCloudFormationStack and InstanceId parameters to determine if the CloudFormation stack should be deleted. • DeleteCloudFormationStack (aws:deleteStack): Deletes the AWS CloudFormation stack. 8. After completed, review the Outputs section for the results of the execution: AWSSupport-ValidateFSxWindowsADConfig 528 AWS Systems Manager Automation runbook reference User Guide The runbook will upload the results of the validation script execution to the Amazon S3 bucket. References Systems Manager Automation • Run this Automation (console) • Run an automation • Setting up an Automation • Support Automation Workﬂows landing page AWS service documentation • What is Amazon FSx for Windows File Server? • Validating self-managed AD conﬁguration for Amazon FSx for Windows File Server GuardDuty AWS Systems Manager Automation provides predeﬁned runbooks for Amazon GuardDuty. For more information about runbooks, see Working with runbooks. For information about how to view runbook content, see View runbook content. GuardDuty 529 AWS Systems Manager Automation runbook reference User Guide Topics • AWSConﬁgRemediation-CreateGuardDutyDetector AWSConfigRemediation-CreateGuardDutyDetector Description The AWSConfigRemediation-CreateGuardDutyDetector runbook creates an Amazon GuardDuty (GuardDuty) detector in the AWS Region where you run the automation. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution AWSConfigRemediation-CreateGuardDutyDetector 530 AWS Systems Manager Automation runbook reference User Guide • ssm:GetAutomationExecution • guardduty:CreateDetector • guardduty:GetDetector Document Steps • aws:executeAwsApi - Creates a GuardDuty detector. • aws:assertAwsResourceProperty - Veriﬁes the Status of the detector is ENABLED . IAM AWS Systems Manager Automation provides predeﬁned runbooks for AWS Identity and Access Management. For more information about runbooks, see Working with runbooks. For information about how to view runbook content, see View runbook content. Topics • AWSSupport-TroubleshootIAMAccessDeniedEvents • AWS-AttachIAMToInstance • AWS-DeleteIAMInlinePolicy • AWSConﬁgRemediation-DeleteIAMRole • AWSConﬁgRemediation-DeleteIAMUser • AWSConﬁgRemediation-DeleteUnusedIAMGroup • AWSConﬁgRemediation-DeleteUnusedIAMPolicy • AWSConﬁgRemediation-DetachIAMPolicy • AWSConﬁgRemediation-EnableAccountAccessAnalyzer • AWSSupport-GrantPermissionsToIAMUser • AWSConﬁgRemediation-RemoveUserPolicies • AWSConﬁgRemediation-ReplaceIAMInlinePolicy • AWSConﬁgRemediation-RevokeUnusedIAMUserCredentials • AWSConﬁgRemediation-SetIAMPasswordPolicy • AWSSupport-ContainIAMPrincipal IAM 531 AWS Systems Manager Automation runbook reference
systems-manager-automation-runbook-guide-129	systems-manager-automation-runbook-guide.pdf	129	ssm:GetAutomationExecution • guardduty:CreateDetector • guardduty:GetDetector Document Steps • aws:executeAwsApi - Creates a GuardDuty detector. • aws:assertAwsResourceProperty - Veriﬁes the Status of the detector is ENABLED . IAM AWS Systems Manager Automation provides predeﬁned runbooks for AWS Identity and Access Management. For more information about runbooks, see Working with runbooks. For information about how to view runbook content, see View runbook content. Topics • AWSSupport-TroubleshootIAMAccessDeniedEvents • AWS-AttachIAMToInstance • AWS-DeleteIAMInlinePolicy • AWSConﬁgRemediation-DeleteIAMRole • AWSConﬁgRemediation-DeleteIAMUser • AWSConﬁgRemediation-DeleteUnusedIAMGroup • AWSConﬁgRemediation-DeleteUnusedIAMPolicy • AWSConﬁgRemediation-DetachIAMPolicy • AWSConﬁgRemediation-EnableAccountAccessAnalyzer • AWSSupport-GrantPermissionsToIAMUser • AWSConﬁgRemediation-RemoveUserPolicies • AWSConﬁgRemediation-ReplaceIAMInlinePolicy • AWSConﬁgRemediation-RevokeUnusedIAMUserCredentials • AWSConﬁgRemediation-SetIAMPasswordPolicy • AWSSupport-ContainIAMPrincipal IAM 531 AWS Systems Manager Automation runbook reference User Guide AWSSupport-TroubleshootIAMAccessDeniedEvents Description The AWSSupport-TroubleshootIAMAccessDeniedEvents automation runbook helps troubleshooting AWS Identity and Access Management (IAM) access denied issues. The runbook queries CloudTrail for recent access denied events related to the speciﬁed IAM entity and AWS service event source. It analyzes events within a conﬁgurable time window of up to 24 hours, processing up to 10 events per execution. Each identiﬁed access denied event is examined to help understand the context of the denial and the attempted actions. The automation analyzes both identity-based and resource-based IAM policies. For identity-based policies, it examines inline and managed policies attached to the IAM entity. For resource-based policies, it evaluates policies across multiple AWS services including Amazon Simple Storage Service(Amazon S3), AWS Key Management Service (AWS KMS), AWS Lambda, Amazon Simple Notiﬁcation Service (Amazon SNS), Amazon Elastic Container Registry (Amazon ECR), Amazon API Gateway, CodeArtifact, Amazon Elastic File System (Amazon EFS), Amazon Simple Queue Service (Amazon SQS), AWS Cloud9, Amazon OpenSearch Service, AWS Signer, AWS Serverless Application Repository, and AWS Secrets Manager. The runbook utilizes IAM policy simulation capabilities to evaluate these policies against the denied actions found in the CloudTrail events. The runbook leverages IAM's policy simulation capabilities through both SimulatePrincipalPolicy for IAM users and SimulateCustomPolicy for IAM roles to evaluate these policies against the denied actions found in the CloudTrail events. The automation outputs a report that helps identify the speciﬁc actions that were denied, diﬀerentiating between implicit and explicit denies, listing the policies responsible for access denials and provides explanations for each denial. The report also suggests potential resolutions, such as identifying missing allow statements or conﬂicting deny statements How does it work? The runbook performs the following steps: • Describes and validates RequesterARN (role or user) to get information such as IAM entity type, and IAM Id. • Fetches CloudTrail events associated with the RequesterARN, EventSource, and ResourceARN if provided. • Analyzes the CloudTrail events to get the action that was performed when the Access Denied error was returned, then examines all the IAM policies such as inline and managed policies AWSSupport-TroubleshootIAMAccessDeniedEvents 532 AWS Systems Manager Automation runbook reference User Guide attached to the IAM entity, as well as resource-based policies. It then simulates these policies against the actions found in the Access Denied errors from the CloudTrail events in question to determine the cause of the error. • Outputs a report determining the type of Access Denied error, the policies responsible for the errors, and gives suggestions for potential solution to the error. Run this Automation (console) Document type Automation Owner Amazon Platforms / Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • apigateway:GetRestApis • cloudtrail:LookupEvents • cloud9:GetEnvironment • codeartifact:GetRepositoryPermissionsPolicy • ecr:GetRepositoryPolicy • elasticfilesystem:GetFileSystemPolicy • es:DescribeDomain • iam:GetPolicy • iam:GetPolicyVersion • iam:GetRole • iam:GetRolePolicy • iam:GetUser AWSSupport-TroubleshootIAMAccessDeniedEvents 533 AWS Systems Manager Automation runbook reference User Guide • iam:GetUserPolicy • iam:ListAttachedRolePolicies • iam:ListAttachedUserPolicies • iam:ListRolePolicies • iam:ListUserPolicies • iam:SimulatePrincipalPolicy • iam:SimulateCustomPolicy • kms:GetKeyPolicy • lambda:GetPolicy • secretsmanager:GetResourcePolicy • serverlessrepo:GetApplication • signer:GetSigningProfile • sns:GetTopicAttributes • ssm:StartAutomationExecution • ssm:StopAutomationExecution • sqs:GetQueueAttributes • s3:GetBucketPolicy Example Policy: { "Version": "2012-10-17", "Statement": [ { "Action": [ "iam:GetUser", "iam:GetRole", "iam:SimulatePrincipalPolicy", "iam:ListUserPolicies", "iam:ListRolePolicies", "iam:GetRolePolicy", "iam:ListAttachedRolePolicies", "iam:GetPolicy", "iam:GetUserPolicy", AWSSupport-TroubleshootIAMAccessDeniedEvents 534 AWS Systems Manager Automation runbook reference User Guide "iam:GetPolicyVersion", "iam:ListAttachedUserPolicies", "ssm:StartAutomationExecution", "ssm:StopAutomationExecution", "cloudtrail:LookupEvents", "iam:SimulateCustomPolicy" ], "Resource": "", "Effect": "Allow" }, { "Action": [ "s3:GetBucketPolicy", "kms:GetKeyPolicy", "lambda:GetPolicy", "sns:GetTopicAttributes", "ecr:GetRepositoryPolicy", "apigateway:GET", "codeartifact:GetRepositoryPermissionsPolicy", "elasticfilesystem:GetFileSystemPolicy", "sqs:GetQueueAttributes", "cloud9:GetEnvironment", "es:DescribeDomain", "signer:GetSigningProfile", "serverlessrepo:GetApplication", "secretsmanager:GetResourcePolicy" ], "Resource": "", "Effect": "Allow" } ] } Instructions Follow these steps to conﬁgure the automation: 1. Navigate to AWSSupport-TroubleshootIAMAccessDeniedEvents in Systems Manager under Documents. 2. Select Execute automation. 3. For the input parameters, enter the following: AWSSupport-TroubleshootIAMAccessDeniedEvents 535 AWS Systems Manager Automation runbook reference User Guide • AutomationAssumeRole (Optional): • Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows SSM Automation to perform the actions on your behalf. The role needs to be added to your Amazon EKS cluster access entry or RBAC permission to allow Kubernetes API calls. • Type: AWS::IAM::Role::Arn • RequesterARN (Required): • Description: (Required) The ARN of the IAM user or role for which you want to investigate the access permissions on a speciﬁc AWS resource. • Type: String •
systems-manager-automation-runbook-guide-130	systems-manager-automation-runbook-guide.pdf	130	enter the following: AWSSupport-TroubleshootIAMAccessDeniedEvents 535 AWS Systems Manager Automation runbook reference User Guide • AutomationAssumeRole (Optional): • Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows SSM Automation to perform the actions on your behalf. The role needs to be added to your Amazon EKS cluster access entry or RBAC permission to allow Kubernetes API calls. • Type: AWS::IAM::Role::Arn • RequesterARN (Required): • Description: (Required) The ARN of the IAM user or role for which you want to investigate the access permissions on a speciﬁc AWS resource. • Type: String • Allow Pattern: ^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso(-[a-z])?):iam::[0-9] {12}:(role\|user)\\/[\\w+\\/=,.@-]+$ • ResourceARN (Optional): • Description: (Optional) The ARN of AWS the resource for which the access denied is evaluated. The AWS target resource should exist in the same region where the automation runbook is executed. • Type: String • Allow Pattern: ^$\|^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso(-[a-z])?):([a-zA- Z0-9\\-]{1,63}):([a-z0-9\\-]{0,63})?:(\\d{12})?:([a-zA-Z0-9\\-_/:.] {1,1024})$ • EventSource (Required): • Description: (Required) The Amazon API endpoint where the CloudTrail event originated. For example: s3.amazonaws.com. • Type: String • Allow Pattern: ^([a-zA-Z0-9.-]+)\\.amazonaws\\.com$ • EventName (Optional): • Description: (Optional) The Amazon API action name associated with the CloudTrail event. For example: s3:CreateBucket. • Type: String • Allow Pattern: ^$\|^[a-z0-9]+:[A-Za-z0-9]+$ • LookBackHours (Optional): AWSSupport-TroubleshootIAMAccessDeniedEvents 536 AWS Systems Manager Automation runbook reference User Guide • Description: (Optional) The number of hours to look back in the CloudTrail events when searching for Access Denied events. Valid range: 1 to 24 hours. • Type: Integer • Allow Pattern: ^([1-9]\|1[0-9]\|2[0-4])$ • Default: 12 • MaxEvents (Optional): • Description: (Optional) The maximum number of CloudTrail Access Denied events returned when searching for events. Valid range: 1 to 5 events. • Type: Integer • Allow Pattern: ^([1-9]\|1[0-9]\|2[0-4])$ • Default: 3 • UseContextEntries (Optional): • Description: (Optional) If you specify true, the automation extracts details about the context of the API request from the CloudTrail event and include them for the IAM policy simulation. • Type: Boolean • Allow Pattern: ^([1-9]\|1[0-9]\|2[0-4])$ • Default: 3 4. Select Execute. 5. The automation initiates. 6. The document performs the following steps: • ValidateRequesterArn Validates and deconstructs the RequesterArn ARN, retrieving information about the target IAM user or role. • GetCloudTrailEventsWithAccessDeniedError Queries the CloudTrail events for recent Access Denied events related to the speciﬁed IAM entity and AWS service EventSource. • EvaluateIAMRequesterPolicies Evaluates the IAM permissions of the requester IAM entity against the actions from CloudTrail AWSSupport-TroubleshootIAMAccessDeniedEvents events. This evaluation includes analyzing both identity-based and resource-based policies 537 AWS Systems Manager Automation runbook reference User Guide associated with the requester. The automation utilizes IAM's policy simulation capabilities to assess these policies in the context of the denied actions identiﬁed in the CloudTrail events. 7. After completed, review the Outputs section for the detailed results of the execution: • PermissionEvaluationResults Outputs a report that helps to identify the speciﬁc actions that were denied, diﬀerentiating between implicit and explicit denials. It also lists the policies responsible for access denials and provides explanations for each denial. The report also suggests potential resolutions, such as identifying missing allow statements or conﬂicting deny statements References Systems Manager Automation • Run this Automation (console) • Run an automation • Setting up an Automation • Support Automation Workﬂows landing page AWS-AttachIAMToInstance Description Attach an AWS Identity and Access Management (IAM) role to a managed instance. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters AWS-AttachIAMToInstance 538 AWS Systems Manager Automation runbook reference User Guide • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • ForceReplace Type: Boolean Description: (Optional) Flag to specify whether to replace the existing IAM proﬁle or not. Default: true • InstanceId Type: String Description: (Required) The ID of the instance on which you want to assign an IAM role. • RoleName Type: String Description: (Required) The IAM role name to add to the managed instance. Document Steps 1. aws:executeAwsApi - DescribeInstanceProﬁle - Find the IAM instance proﬁle attached to the EC2 instance. 2. aws:branch - CheckInstanceProﬁleAssociations - Check the IAM instance proﬁle attached to the EC2 instance. a. If an IAM instance proﬁle is attached and ForceReplace is set to true : i. aws:executeAwsApi - DisassociateIamInstanceProﬁle - Disassociate the IAM instance proﬁle from the EC2 instance. b. aws:executeAwsApi - ListInstanceProﬁlesForRole - List instance proﬁles for the IAM role provided. AWS-AttachIAMToInstance 539 AWS Systems Manager Automation runbook reference User Guide c. aws:branch - CheckInstanceProﬁleCreated - Check if the IAM role provided has an associated instance proﬁle. i. If the IAM role has an associated instance proﬁle: A. aws:executeAwsApi - AttachIAMProﬁleToInstance - Attach the IAM instance proﬁle role to the EC2
systems-manager-automation-runbook-guide-131	systems-manager-automation-runbook-guide.pdf	131	IAM instance proﬁle attached to the EC2 instance. a. If an IAM instance proﬁle is attached and ForceReplace is set to true : i. aws:executeAwsApi - DisassociateIamInstanceProﬁle - Disassociate the IAM instance proﬁle from the EC2 instance. b. aws:executeAwsApi - ListInstanceProﬁlesForRole - List instance proﬁles for the IAM role provided. AWS-AttachIAMToInstance 539 AWS Systems Manager Automation runbook reference User Guide c. aws:branch - CheckInstanceProﬁleCreated - Check if the IAM role provided has an associated instance proﬁle. i. If the IAM role has an associated instance proﬁle: A. aws:executeAwsApi - AttachIAMProﬁleToInstance - Attach the IAM instance proﬁle role to the EC2 instance. i. If the IAM role does not have an associated instance proﬁle: A. aws:executeAwsApi - CreateInstanceProﬁleForRole - Create an instance proﬁle role for the speciﬁed IAM role. B. aws:executeAwsApi - AddRoleToInstanceProﬁle - Attach the instance proﬁle role to the speciﬁed IAM role. C. aws:executeAwsApi - GetInstanceProﬁle - Get the instance proﬁle data for the speciﬁed IAM role. D. aws:executeAwsApi - AttachIAMProﬁleToInstanceWithRetry - Attach the IAM instance proﬁle role to the EC2 instance. Outputs AttachIAMProﬁleToInstanceWithRetry.AssociationId GetInstanceProﬁle.InstanceProﬁleName GetInstanceProﬁle.InstanceProﬁleArn AttachIAMProﬁleToInstance.AssociationId ListInstanceProﬁlesForRole.InstanceProﬁleName ListInstanceProﬁlesForRole.InstanceProﬁleArn AWS-DeleteIAMInlinePolicy Description The AWS-DeleteIAMInlinePolicy runbook deletes all AWS Identity and Access Management (IAM) inline policies attached to the IAM identities you specify. Run this Automation (console) AWS-DeleteIAMInlinePolicy 540 AWS Systems Manager Automation runbook reference User Guide Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • IamArns Type: String Description: (Required) A comma separated list of ARNs for the IAM identities you want to delete inline policies from. This list can include IAM users, groups, or roles. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • iam:DeleteGroupPolicy • iam:DeleteRolePolicy • iam:DeleteUserPolicy • iam:ListGroupPolicies • iam:ListRolePolicies AWS-DeleteIAMInlinePolicy 541 AWS Systems Manager Automation runbook reference User Guide • iam:ListUserPolicies Document Steps • aws:executeScript - Deletes the IAM inline policies attached to the targeted IAM identities. AWSConfigRemediation-DeleteIAMRole Description The AWSConfigRemediation-DeleteIAMRole runbook deletes the AWS Identity and Access Management (IAM) role you specify. This automation does not delete instance proﬁles associated with the IAM role, or service-linked roles. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. • IAMRoleID Type: String AWSConfigRemediation-DeleteIAMRole 542 AWS Systems Manager Automation runbook reference User Guide Description: (Required) The ID of the IAM role you want to delete. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • iam:DeleteRole • iam:DeleteRolePolicy • iam:GetRole • iam:ListAttachedRolePolicies • iam:ListInstanceProfilesForRole • iam:ListRolePolicies • iam:ListRoles • iam:RemoveRoleFromInstanceProfile Document Steps • aws:executeScript - Gathers the name of the IAM role you specify in the IAMRoleID parameter. • aws:executeScript - Gathers policies and instance proﬁles associated with the IAM role. • aws:executeScript - Deletes attached policies. • aws:executeScript - Deletes the IAM role and veriﬁes the role has been deleted. AWSConfigRemediation-DeleteIAMUser Description The AWSConfigRemediation-DeleteIAMUser runbook deletes the AWS Identity and Access Management (IAM) user you specify. This automation deletes or detaches the following resources associated with the IAM user: AWSConfigRemediation-DeleteIAMUser 543 AWS Systems Manager Automation runbook reference User Guide • Access keys • Attached managed policies • Git credentials • IAM group memberships • IAM user password • Inline policies • Multi-factor authentication (MFA) devices • Signing certiﬁcates • SSH public keys Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. • IAMUserId Type: String Description: (Required) The ID of the IAM user you want to delete. AWSConfigRemediation-DeleteIAMUser 544 AWS Systems Manager Automation runbook reference User Guide Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • iam:DeactivateMFADevice • iam:DeleteAccessKey • iam:DeleteLoginProfile • iam:DeleteServiceSpecificCredential • iam:DeleteSigningCertificate • iam:DeleteSSHPublicKey • iam:DeleteVirtualMFADevice • iam:DeleteUser • iam:DeleteUserPolicy • iam:DetachUserPolicy • iam:GetUser • iam:ListAttachedUserPolicies • iam:ListAccessKeys • iam:ListGroupsForUser • iam:ListMFADevices • iam:ListServiceSpecificCredentials • iam:ListSigningCertificates • iam:ListSSHPublicKeys • iam:ListUserPolicies • iam:ListUsers • iam:RemoveUserFromGroup Document Steps • aws:executeScript - Gathers the user name of the IAM user you specify in the IAMUserId parameter. AWSConfigRemediation-DeleteIAMUser 545 AWS Systems Manager Automation runbook reference User Guide • aws:executeScript - Gathers access keys, certiﬁcates, credentials, MFA devices, and SSH keys associated with the
systems-manager-automation-runbook-guide-132	systems-manager-automation-runbook-guide.pdf	132	requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • iam:DeactivateMFADevice • iam:DeleteAccessKey • iam:DeleteLoginProfile • iam:DeleteServiceSpecificCredential • iam:DeleteSigningCertificate • iam:DeleteSSHPublicKey • iam:DeleteVirtualMFADevice • iam:DeleteUser • iam:DeleteUserPolicy • iam:DetachUserPolicy • iam:GetUser • iam:ListAttachedUserPolicies • iam:ListAccessKeys • iam:ListGroupsForUser • iam:ListMFADevices • iam:ListServiceSpecificCredentials • iam:ListSigningCertificates • iam:ListSSHPublicKeys • iam:ListUserPolicies • iam:ListUsers • iam:RemoveUserFromGroup Document Steps • aws:executeScript - Gathers the user name of the IAM user you specify in the IAMUserId parameter. AWSConfigRemediation-DeleteIAMUser 545 AWS Systems Manager Automation runbook reference User Guide • aws:executeScript - Gathers access keys, certiﬁcates, credentials, MFA devices, and SSH keys associated with the IAM user. • aws:executeScript - Gathers group memberships and policies for the IAM user. • aws:executeScript - Deletes access keys, certiﬁcates, credentials, MFA devices, and SSH keys associated with the IAM user. • aws:executeScript - Deletes group memberships and policies for the IAM user. • aws:executeScript - Deletes the IAM user and veriﬁes the user has been deleted. AWSConfigRemediation-DeleteUnusedIAMGroup Description The AWSConfigRemediation-DeleteUnusedIAMGroup runbook deletes an IAM group that does not contain any users. The AWSConfigRemediation-DeleteUnusedIAMGroup runbook deletes an IAM group that does not contain any users. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. AWSConfigRemediation-DeleteUnusedIAMGroup 546 AWS Systems Manager Automation runbook reference User Guide • GroupName Type: String Description: (Required) The name of the IAM group that you want to delete. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • iam:DeleteGroup • iam:DeleteGroupPolicy • iam:DetachGroupPolicy Document Steps • aws:executeScript - Removes managed and inline IAM policies attached to the target IAM group, and then deletes the IAM group. AWSConfigRemediation-DeleteUnusedIAMPolicy Description The AWSConfigRemediation-DeleteUnusedIAMPolicy runbook deletes an AWS Identity and Access Management (IAM) policy that is not attached to any users, groups, or roles. Run this Automation (console) Document type Automation Owner Amazon AWSConfigRemediation-DeleteUnusedIAMPolicy 547 AWS Systems Manager Automation runbook reference User Guide Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. • IAMResourceId Type: String Description: (Required) The resource identiﬁer of the IAM policy that you want to delete. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • config:GetResourceConfigHistory • config:ListDiscoveredResources • iam:DeletePolicy • iam:DeletePolicyVersion • iam:GetPolicy • iam:ListEntitiesForPolicy • iam:ListPolicyVersions Document Steps • aws:executeScript - Deletes the policy you specify in the IAMResourceId parameter, and veriﬁes the policy was deleted. AWSConfigRemediation-DeleteUnusedIAMPolicy 548 AWS Systems Manager Automation runbook reference User Guide AWSConfigRemediation-DetachIAMPolicy Description The AWSConfigRemediation-DetachIAMPolicy runbook detaches the AWS Identity and Access Management (IAM) policy you specify. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. • IAMResourceId Type: String Description: (Required) The ID of the IAM policy you want to detach. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution AWSConfigRemediation-DetachIAMPolicy 549 AWS Systems Manager Automation runbook reference User Guide • ssm:GetAutomationExecution • config:GetResourceConfigHistory • config:ListDiscoveredResources • iam:DetachGroupPolicy • iam:DetachRolePolicy • iam:DetachUserPolicy • iam:GetPolicy • iam:ListEntitiesForPolicy Document Steps • aws:executeScript - Detaches the IAM policy from all resources. AWSConfigRemediation-EnableAccountAccessAnalyzer Description The AWSConfigRemediation-EnableAccountAccessAnalyzer runbook creates an AWS Identity and Access Management (IAM) Access Analyzer in your AWS account. For information about Access Analyzer, see Using AWS IAM Access Analyzer in the IAM User Guide . Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AnalyzerName AWSConfigRemediation-EnableAccountAccessAnalyzer 550 AWS Systems Manager Automation runbook reference User Guide Type: String Description: (Required) The name of the analyzer to create. • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • access-analyzer:CreateAnalyzer • access-analyzer:GetAnalyzer Document Steps • aws:executeAwsApi - Creates an access analyzer for your account. • aws:waitForAwsResourceProperty - Waits for the status of the access analyzer to be ACTIVE . • aws:assertAwsResourceProperty - Conﬁrms the status of the access analyzer is ACTIVE . AWSSupport-GrantPermissionsToIAMUser Description This runbook grants the speciﬁed permissions to an IAM group (new or existing), and adds the existing IAM user to it. Policies you can choose from: Billing or Support
systems-manager-automation-runbook-guide-133	systems-manager-automation-runbook-guide.pdf	133	perform the actions on your behalf. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • access-analyzer:CreateAnalyzer • access-analyzer:GetAnalyzer Document Steps • aws:executeAwsApi - Creates an access analyzer for your account. • aws:waitForAwsResourceProperty - Waits for the status of the access analyzer to be ACTIVE . • aws:assertAwsResourceProperty - Conﬁrms the status of the access analyzer is ACTIVE . AWSSupport-GrantPermissionsToIAMUser Description This runbook grants the speciﬁed permissions to an IAM group (new or existing), and adds the existing IAM user to it. Policies you can choose from: Billing or Support . To enable billing access for IAM, remember to also activate IAM user and federated user access to the Billing and Cost Management pages . AWSSupport-GrantPermissionsToIAMUser 551 AWS Systems Manager Automation runbook reference User Guide Important If you provide an existing IAM group, all current IAM users in the group receive the new permissions. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user that starts this runbook. • IAMGroupName Type: String Default: ExampleSupportAndBillingGroup Description: (Required) Can be a new or existing group. Must comply with IAM Entity Name Limits . • IAMUserName Type: String AWSSupport-GrantPermissionsToIAMUser 552 AWS Systems Manager Automation runbook reference User Guide Default: ExampleUser Description: (Required) Must be an existing user. • LambdaAssumeRole Type: String Description: (Optional) The ARN of the role assumed by lambda. • Permissions Type: String Valid values: SupportFullAccess \| BillingFullAccess \| SupportAndBillingFullAccess Default: SupportAndBillingFullAccess Description: (Required) Choose one of: SupportFullAccess grants full access to the Support center. BillingFullAccess grants full access to the Billing dashboard. SupportAndBillingFullAccess grants full access to both Support center and the Billing dashboard. More info on policies under Document details. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. The permissions required depend on how AWSSupport-GrantPermissionsToIAMUser is run. Running as the currently logged in user or role It is recommended you have the AmazonSSMAutomationRole Amazon managed policy attached, and the following additional permissions to be able to create the Lambda function and the IAM role to pass to Lambda: { "Version": "2012-10-17", "Statement": [ { "Action": [ "lambda:InvokeFunction", AWSSupport-GrantPermissionsToIAMUser 553 AWS Systems Manager Automation runbook reference User Guide "lambda:CreateFunction", "lambda:DeleteFunction", "lambda:GetFunction" ], "Resource": "arn:aws:lambda::ACCOUNTID:function:AWSSupport-", "Effect": "Allow" }, { "Effect" : "Allow", "Action" : [ "iam:CreateGroup", "iam:AddUserToGroup", "iam:ListAttachedGroupPolicies", "iam:GetGroup", "iam:GetUser" ], "Resource" : [ "arn:aws:iam:::user/", "arn:aws:iam:::group/" ] }, { "Effect" : "Allow", "Action" : [ "iam:AttachGroupPolicy" ], "Resource": "", "Condition": { "ArnEquals": { "iam:PolicyArn": [ "arn:aws:iam::aws:policy/job-function/Billing", "arn:aws:iam::aws:policy/AWSSupportAccess" ] } } }, { "Effect" : "Allow", "Action" : [ "iam:ListAccountAliases", "iam:GetAccountSummary" ], "Resource" : "" AWSSupport-GrantPermissionsToIAMUser 554 AWS Systems Manager Automation runbook reference User Guide } ] } Using AutomationAssumeRole and LambdaAssumeRole The user must have the ssm:StartAutomationExecution permissions on the runbook, and iam:PassRole on the IAM roles passed as AutomationAssumeRole and LambdaAssumeRole . Here are the permissions each IAM role needs: AutomationAssumeRole { "Version": "2012-10-17", "Statement": [ { "Action": [ "lambda:InvokeFunction", "lambda:CreateFunction", "lambda:DeleteFunction", "lambda:GetFunction" ], "Resource": "arn:aws:lambda::ACCOUNTID:function:AWSSupport-", "Effect": "Allow" } ] } LambdaAssumeRole { "Version": "2012-10-17", "Statement": [ { "Effect" : "Allow", "Action" : [ "iam:CreateGroup", "iam:AddUserToGroup", "iam:ListAttachedGroupPolicies", "iam:GetGroup", "iam:GetUser" AWSSupport-GrantPermissionsToIAMUser 555 AWS Systems Manager Automation runbook reference User Guide ], "Resource" : [ "arn:aws:iam:::user/", "arn:aws:iam:::group/" ] }, { "Effect" : "Allow", "Action" : [ "iam:AttachGroupPolicy" ], "Resource": "", "Condition": { "ArnEquals": { "iam:PolicyArn": [ "arn:aws:iam::aws:policy/job-function/Billing", "arn:aws:iam::aws:policy/AWSSupportAccess" ] } } }, { "Effect" : "Allow", "Action" : [ "iam:ListAccountAliases", "iam:GetAccountSummary" ], "Resource" : "" } ] } Document Steps 1. aws:createStack - Run AWS CloudFormation Template to create a Lambda function. 2. aws:invokeLambdaFunction - Run Lambda to set IAM permissions. 3. aws:deleteStack - Delete CloudFormation Template. Outputs conﬁgureIAM.Payload AWSSupport-GrantPermissionsToIAMUser 556 AWS Systems Manager Automation runbook reference User Guide AWSConfigRemediation-RemoveUserPolicies Description The AWSConfigRemediation-RemoveUserPolicies runbook deletes the AWS Identity and Access Management (IAM) inline policies and detaches any managed policies attached to the user you specify. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. • IAMUserID Type: String Description: (Required) The ID of the user you want to remove policies from. • PolicyType Type: String Valid values: All \| Inline \| Managed AWSConfigRemediation-RemoveUserPolicies 557 AWS Systems Manager Automation runbook reference User Guide Default: All Description: (Required) The type of IAM policies you want to remove from the user. Required IAM permissions The AutomationAssumeRole parameter requires the following actions
systems-manager-automation-runbook-guide-134	systems-manager-automation-runbook-guide.pdf	134	Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. • IAMUserID Type: String Description: (Required) The ID of the user you want to remove policies from. • PolicyType Type: String Valid values: All \| Inline \| Managed AWSConfigRemediation-RemoveUserPolicies 557 AWS Systems Manager Automation runbook reference User Guide Default: All Description: (Required) The type of IAM policies you want to remove from the user. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • iam:DeleteUserPolicy • iam:DetachUserPolicy • iam:ListAttachedUserPolicies • iam:ListUserPolicies • iam:ListUsers Document Steps • aws:executeScript - Deletes and detaches IAM policies from the user you specify in the IAMUserID parameter. AWSConfigRemediation-ReplaceIAMInlinePolicy Description The AWSConfigRemediation-ReplaceIAMInlinePolicy runbook replaces an inline AWS Identity and Access Management (IAM) policy with a replicated managed IAM policy. For an inline policy attached to a user, group, or role, the inline policy permissions are cloned into a managed IAM policy. The managed IAM policy is added to the resource, and the inline policy is removed. AWS Conﬁg must be enabled in the AWS Region where you run this automation. Run this Automation (console) Document type Automation AWSConfigRemediation-ReplaceIAMInlinePolicy 558 AWS Systems Manager Automation runbook reference User Guide Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. • InlinePolicyName Type: StringList Description: (Required) The inline IAM policy you want to replace. • ResourceId Type: String Description: (Required) The ID of the IAM user, group, or role whose inline policy you want to replace. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • iam:AttachGroupPolicy • iam:AttachRolePolicy • iam:AttachUserPolicy AWSConfigRemediation-ReplaceIAMInlinePolicy 559 AWS Systems Manager Automation runbook reference User Guide • iam:CreatePolicy • iam:CreatePolicyVersion • iam:DeleteGroupPolicy • iam:DeleteRolePolicy • iam:DeleteUserPolicy • iam:GetGroupPolicy • iam:GetRolePolicy • iam:GetUserPolicy • iam:ListGroupPolicies • iam:ListRolePolicies • iam:ListUserPolicies Document Steps • aws:executeScript - Replace the inline IAM policy with an AWS replicated policy on the resource that you specify. AWSConfigRemediation-RevokeUnusedIAMUserCredentials Description The AWSConfigRemediation-RevokeUnusedIAMUserCredentials runbook revokes unused AWS Identity and Access Management (IAM) passwords and active access keys. This runbook also deactivates expired access keys, and deletes expired login proﬁles. AWS Conﬁg must be enabled in the AWS Region where you run this automation. Run this Automation (console) Document type Automation Owner Amazon AWSConfigRemediation-RevokeUnusedIAMUserCredentials 560 AWS Systems Manager Automation runbook reference User Guide Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. • IAMResourceId Type: String Description: (Required) The ID of the IAM resource you want to revoke unused credentials from. • MaxCredentialUsageAge Type: String Default: 90 Description: (Required) The number of days within which the credential must have been used. Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. • ssm:StartAutomationExecution • ssm:GetAutomationExecution • config:ListDiscoveredResources • iam:DeleteAccessKey • iam:DeleteLoginProfile • iam:GetAccessKeyLastUsed • iam:GetLoginProfile AWSConfigRemediation-RevokeUnusedIAMUserCredentials 561 AWS Systems Manager Automation runbook reference User Guide • iam:GetUser • iam:ListAccessKeys • iam:UpdateAccessKey Document Steps • aws:executeScript - Revokes IAM credentials for the user speciﬁed in the IAMResourceId parameter. Expired access keys are deactivated, and expired login proﬁles are deleted. Note Make sure to conﬁgure the MaxCredentialUsageAgeparameter of this remediation action to match the maxAccessKeyAge parameter of the AWS Conﬁg rule you use to trigger this action: access-keys-rotated. AWSConfigRemediation-SetIAMPasswordPolicy Description The AWSConfigRemediation-SetIAMPasswordPolicy runbook sets the AWS Identity and Access Management (IAM) user password policy for your AWS account. Run this Automation (console) Document type Automation Owner Amazon Platforms Linux, macOS, Windows Parameters • AutomationAssumeRole AWSConfigRemediation-SetIAMPasswordPolicy 562 AWS Systems Manager Automation runbook reference User Guide Type: String Description: (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. • AllowUsersToChangePassword Type: Boolean Default: false Description: (Optional) If set to true , all IAM users in your AWS account can use the AWS Management Console to change their passwords. • HardExpiry Type: Boolean Default: false Description: (Optional) If set to true , IAM users are prevented from resetting their passwords after their password expires. • MaxPasswordAge Type: Integer Default: 0 Description: (Optional) The number of days an IAM user's password is valid. • MinimumPasswordLength Type: Integer Default: 6 Description: (Optional) The minimum number of characters an IAM user's password can be. • PasswordReusePrevention Type: Integer Default: 0 AWSConfigRemediation-SetIAMPasswordPolicy 563 AWS Systems Manager Automation runbook
systems-manager-automation-runbook-guide-135	systems-manager-automation-runbook-guide.pdf	135	false Description: (Optional) If set to true , all IAM users in your AWS account can use the AWS Management Console to change their passwords. • HardExpiry Type: Boolean Default: false Description: (Optional) If set to true , IAM users are prevented from resetting their passwords after their password expires. • MaxPasswordAge Type: Integer Default: 0 Description: (Optional) The number of days an IAM user's password is valid. • MinimumPasswordLength Type: Integer Default: 6 Description: (Optional) The minimum number of characters an IAM user's password can be. • PasswordReusePrevention Type: Integer Default: 0 AWSConfigRemediation-SetIAMPasswordPolicy 563 AWS Systems Manager Automation runbook reference User Guide Description: (Optional) The number of previous passwords that an IAM user is prevented from reusing. • RequireLowercaseCharacters Type: Boolean Default: false Description: (Optional) If set to true , an IAM user's password must contain a lowercase character from the ISO basic Latin alphabet (a to z). • RequireNumbers Type: Boolean Default: false Description: (Optional) If set to true , an IAM user's password must contain a numeric character (0-9). • RequireSymbols Type: Boolean Default: false Description: (Optional) If set to true , an IAM user's password must contain a non-alphanumeric character (! @ # $ % ^ * ( ) _ + - = [ ] { } \| '). • RequireUppercaseCharacters Type: Boolean Default: false Description: (Optional) If set to true , an IAM user's password must contain an uppercase character from the ISO basic Latin alphabet (A to Z). Required IAM permissions The AutomationAssumeRole parameter requires the following actions to use the runbook successfully. AWSConfigRemediation-SetIAMPasswordPolicy 564 AWS Systems Manager Automation runbook reference User Guide • ssm:StartAutomationExecution • ssm:GetAutomationExecution • iam:GetAccountPasswordPolicy • iam:UpdateAccountPasswordPolicy Document Steps • aws:executeScript - Sets the IAM user password policy based on the values you specify for the runbook parameters for your AWS account. AWSSupport-ContainIAMPrincipal Description In the event of a security incident or a suspected compromise of an AWS Identity and Access Management (IAM) User/Role or AWS Identity Center (IDC) user, swift isolation of the aﬀected identity is crucial while preserving its conﬁguration for investigation. The AWSSupport- ContainIAMPrincipal runbook provides a structured, reversible approach to contain compromised IAM or IDC identities, eﬀectively blocking their access to AWS resources and preventing potential spread of the compromise. This automated process enables investigation without permanent alteration of the identity's conﬁguration, allowing for restoration of normal access when deemed appropriate. The containment process maintains the user or role within IAM or the user within IDC, while eﬀectively isolating it from all network activities. This isolation prevents the contained identity resource from communicating with resources inside your Amazon Virtual Private Cloud or accessing internet resources. The containment is designed to be reversible, allowing for restoration of normal access when deemed appropriate. How does it work? The AWSSupport-ContainIAMPrincipal runbook implements a comprehensive containment process for IAM users, roles, and Identity Center users. When executed in Contain mode, it ﬁrst validates all input parameters and performs security checks on the speciﬁed Amazon S3 bucket. It then gathers detailed information about the target IAM principal and applies appropriate containment measures based on the principal type. For IAM users, it disables access keys, removes console access, and attaches a deny policy. For IAM roles, it attaches a deny policy that revokes AWSSupport-ContainIAMPrincipal 565 AWS Systems Manager Automation runbook reference User Guide permissions for sessions created before containment. For Identity Center users, it removes permission sets, group memberships, and applies a deny policy. Throughout the process, the runbook backs up the original conﬁguration to an Amazon S3 bucket for potential restoration. When executed in Restore mode, it attempts to revert the principal to its pre-containment state using the backed-up conﬁguration. The runbook includes a DryRun option to preview changes without applying them, and provides comprehensive reporting on both successful operations and failure scenarios. Important • Use of Elevated Privileges: This SSM document performs various operations that require elevated privileges, such as modifying IAM and IDC identity policies and applying quarantine conﬁgurations. These actions could potentially lead to a privilege escalation or impact other workloads that depend on the targeted identities. You should review the permissions granted to the role speciﬁed by the AutomationAssumeRole parameter and ensure they are appropriate for the intended use case. You can refer to the following AWS documentation for more information on IAM permissions: • Identity and Access Management (IAM) Permissions • AWS Systems Manager Automation Permissions • Workload Unavailability Risks: This Systems Manager document performs isolation actions that could potentially cause unavailability or disruption to your workloads. When executed during a security event, it will restrict access to the aﬀected resource by revoking AWS API permissions from the speciﬁed IAM and IDC identities, preventing them from making any AWS API calls or actions. This could impact any applications or services that depend on these identities. •
systems-manager-automation-runbook-guide-136	systems-manager-automation-runbook-guide.pdf	136	intended use case. You can refer to the following AWS documentation for more information on IAM permissions: • Identity and Access Management (IAM) Permissions • AWS Systems Manager Automation Permissions • Workload Unavailability Risks: This Systems Manager document performs isolation actions that could potentially cause unavailability or disruption to your workloads. When executed during a security event, it will restrict access to the aﬀected resource by revoking AWS API permissions from the speciﬁed IAM and IDC identities, preventing them from making any AWS API calls or actions. This could impact any applications or services that depend on these identities. • Creation of Additional Resources: The automation document may conditionally create additional resources, such as an Amazon Simple Storage Service (Amazon S3) bucket and Amazon S3 objects stored in them, depending on the execution parameters. These resources will incur additional charges based on your AWS usage. • Restoration Risks: If the Action parameter is set to Restore, this SSM document attempts to restore the IAM or IDC identity conﬁguration to its original state. However, there is a risk that the restoration process may fail, leaving the IAM or IDC identity in an inconsistent state. The document provides instructions for manual restoration in case of such failures, but you should be prepared to handle potential issues during the restoration process. AWSSupport-ContainIAMPrincipal 566 AWS Systems Manager Automation runbook reference User Guide It is recommended to review the runbook thoroughly, understand its potential impacts, and test it in a non-production environment before executing it in your production environment. Run this Automation (console) Document type Automation Owner Amazon Platforms / Required IAM permissions The AutomationAssumeRole parameter requires the following permissions to successfully use the runbook: • s3:GetBucketLocation • s3:GetBucket • s3:ListBucket • s3:GetBucketPublicAccessBlocks • s3:GetAccountPublicAccessBlocks • s3:GetBucketPolicyStatus • s3:GetBucketAcl • s3:GetObject • s3:CreateBucket • s3:PutObject • iam:GetUser • iam:GetUserPolicy • iam:GetRole AWSSupport-ContainIAMPrincipal 567 AWS Systems Manager Automation runbook reference User Guide • iam:ListUserPolicies • iam:ListAttachedUserPolicies • iam:ListAccessKeys • iam:ListMfaDevices • iam:ListVirtualMFADevices • iam:GetLoginProﬁle • iam:GetPolicy • iam:GetRolePolicy • iam:ListPolicies • iam:ListAttachedRolePolicies • iam:ListRolePolicies • iam:UpdateAccessKey • iam:CreateAccessKey • iam:DeleteLoginProﬁle • iam:DeleteAccessKey • iam:PutUserPolicy • iam:DeleteUserPolicy • iam:DeactivateMFADevice • iam:AttachRolePolicy • iam:AttachUserPolicy • iam:DeleteRolePolicy • iam:TagMFADevice • iam:PutRolePolicy • iam:TagPolicy • iam:TagRole • iam:TagUser • iam:UntagUser • iam:UntagRole • organizations:ListAccounts • sso:ListPermissionSetsProvisionedToAccount AWSSupport-ContainIAMPrincipal 568 AWS Systems Manager Automation runbook reference User Guide • sso:GetInlinePolicyForPermissionSet • sso:ListInstances • sso-directory:SearchUsers • sso:ListPermissionSets • sso:ListAccountAssignments • sso-directory:DescribeUser • identitystore:ListUsers • identitystore:ListGroups • identitystore:IsMemberInGroups • identitystore:ListGroupMemberships • secretsmanager:CreateSecret • secretsmanager:DeleteSecret • sso:DeleteAccountAssignment • sso:PutInlinePolicyToPermissionSet • sso:CreateAccountAssignment • sso:DeleteInlinePolicyFromPermissionSet • sso:TagResource • sso:UntagResource • identitystore:DeleteGroupMembership • identitystore:CreateGroupMembership Here is an example of an IAM policy that grants the necessary permissions for the AutomationAssumeRole: { "Version": "2012-10-17", "Statement": [ { "Sid": "S3Permissions", "Effect": "Allow", "Action": [ "s3:GetBucketLocation", "s3:GetBucket", "s3:ListBucket", AWSSupport-ContainIAMPrincipal 569 AWS Systems Manager Automation runbook reference User Guide "s3:GetBucketPublicAccessBlocks", "s3:GetAccountPublicAccessBlocks", "s3:GetBucketPolicyStatus", "s3:GetBucketAcl", "s3:GetObject", "s3:CreateBucket", "s3:PutObject" ], "Resource": "" }, { "Sid": "IAMPermissions", "Effect": "Allow", "Action": [ "iam:GetUser", "iam:GetUserPolicy", "iam:GetRole", "iam:ListUserPolicies", "iam:ListAttachedUserPolicies", "iam:ListAccessKeys", "iam:ListMfaDevices", "iam:ListVirtualMFADevices", "iam:GetLoginProfile", "iam:GetPolicy", "iam:GetRolePolicy", "iam:ListPolicies", "iam:ListAttachedRolePolicies", "iam:ListRolePolicies", "iam:UpdateAccessKey", "iam:CreateAccessKey", "iam:DeleteLoginProfile", "iam:DeleteAccessKey", "iam:PutUserPolicy", "iam:DeleteUserPolicy", "iam:DeactivateMFADevice", "iam:AttachRolePolicy", "iam:AttachUserPolicy", "iam:DeleteRolePolicy", "iam:TagMFADevice", "iam:PutRolePolicy", "iam:TagPolicy", "iam:TagRole", "iam:TagUser", "iam:UntagUser", AWSSupport-ContainIAMPrincipal 570 AWS Systems Manager Automation runbook reference User Guide "iam:UntagRole" ], "Resource": "" }, { "Sid": "OrganizationsPermissions", "Effect": "Allow", "Action": [ "organizations:ListAccounts" ], "Resource": "" }, { "Sid": "SSOPermissions", "Effect": "Allow", "Action": [ "sso:ListPermissionSetsProvisionedToAccount", "sso:GetInlinePolicyForPermissionSet", "sso:ListInstances", "sso-directory:SearchUsers", "sso:ListPermissionSets", "sso:ListAccountAssignments", "sso-directory:DescribeUser", "sso:DeleteAccountAssignment", "sso:PutInlinePolicyToPermissionSet", "sso:CreateAccountAssignment", "sso:DeleteInlinePolicyFromPermissionSet", "sso:TagResource", "sso:UntagResource" ], "Resource": "" }, { "Sid": "IdentityStorePermissions", "Effect": "Allow", "Action": [ "identitystore:ListUsers", "identitystore:ListGroups", "identitystore:IsMemberInGroups", "identitystore:ListGroupMemberships", "identitystore:DeleteGroupMembership", "identitystore:CreateGroupMembership" ], "Resource": "" AWSSupport-ContainIAMPrincipal 571 AWS Systems Manager Automation runbook reference User Guide }, { "Sid": "SecretsManagerPermissions", "Effect": "Allow", "Action": [ "secretsmanager:CreateSecret", "secretsmanager:DeleteSecret" ], "Resource": "" } ] } Instructions Follow these steps to conﬁgure the automation: 1. Navigate to the AWSSupport-ContainIAMPrincipal in the AWS Systems Manager console. 2. Select Execute automation. 3. For the input parameters, enter the following: • AutomationAssumeRole (Optional): • Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is speciﬁed, Systems Manager Automation uses the permissions of the user who starts this runbook. • Type: AWS::IAM::Role::Arn • PrincipalType (Required): • Description: (Required) The AWS IAM principal type: IAM user, IAM role, or Identity Center user. • Type: String • Allowed Values: IAM user\|IAM role\|Identity Center user • PrincipalName (Required): • Description: (Required) The name of the IAM principal. For Identity Center users, provide the username. • Type: String • Allowed Pattern: ^[a-zA-Z0-9\\.\\-_\\\\!*'()/+=,@]{1,1024}$ AWSSupport-ContainIAMPrincipal 572 AWS Systems Manager Automation runbook reference User Guide • Action (Required): • Description: (Required) Select Contain to isolate the target IAM principal or Restore to try to restore the IAM principal to its original conﬁguration from a previous backup. • Type: String • Allowed Values: Contain\|Restore • DryRun (Optional): •
systems-manager-automation-runbook-guide-137	systems-manager-automation-runbook-guide.pdf	137	IAM principal type: IAM user, IAM role, or Identity Center user. • Type: String • Allowed Values: IAM user\|IAM role\|Identity Center user • PrincipalName (Required): • Description: (Required) The name of the IAM principal. For Identity Center users, provide the username. • Type: String • Allowed Pattern: ^[a-zA-Z0-9\\.\\-_\\\\!'()/+=,@]{1,1024}$ AWSSupport-ContainIAMPrincipal 572 AWS Systems Manager Automation runbook reference User Guide • Action (Required): • Description: (Required) Select Contain to isolate the target IAM principal or Restore to try to restore the IAM principal to its original conﬁguration from a previous backup. • Type: String • Allowed Values: Contain\|Restore • DryRun (Optional): • Description: (Optional) When set to true, the automation will not make any changes to the target IAM principal, instead it will output on what it would have attempted to change, detailing out on each step. Default value: true. • Type: Boolean • Allowed Values: true\|false • ActivateDisabledKeys (Conditional): • Description: (Conditional) If the input parameter Action is set to Restore and the PrincipalType is set to IAM user, this option determines if this automation should try to activate the associated access keys if deactivated. Please note that the integrity of a compromised access key cannot be veriﬁed. AWS strongly recommends against reactivating a compromised key. Instead, it is advisable to generate new keys. Default value: false. • Type: Boolean • Allowed Values: true\|false • BackupS3BucketName (Conditional): • Description: (Conditional) The Amazon Amazon S3 bucket to backup the IAM principal conﬁguration when the Action is set to Contain or to restore the conﬁguration from when the Action is Restore. Note that if the speciﬁed Action is Contain and the runbook is not able to access the bucket or a value is not provided, a new bucket is created in your account with the name awssupport-containiamprincipal-<random-string>. If DryRun is set to true this parameter is required. • Type: AWS::S3::Bucket::Name • BackupS3KeyName (Conditional): • Description: (Conditional) If Action is set to Restore, this speciﬁes the Amazon Amazon S3 key the automation will use to try to restore the IAM principal conﬁguration. The Amazon Amazon S3 key typically follows this format: {year}/{month}/{day}/{hour}/ {minute}/{automation_execution_id}.json. The key can be obtained from the output of a previous containment automation execution. 573 AWSSupport-ContainIAMPrincipal AWS Systems Manager Automation runbook reference User Guide • Type: String • Allowed Pattern: ^[a-zA-Z0-9\\.\\-_\\\\!'()/]{0,1024}$ • BackupS3BucketAccess (Conditional): • Description: (Conditional) The ARN of the IAM users or roles that will be allowed access to the backup Amazon Amazon S3 bucket after running the containment actions. This parameter is required when Action is Contain. The AutomationAssumeRole, or in its absence the user under whose context the automation is running is automatically added to the list. • Type: StringList • Allowed Pattern: ^$\|^arn:(aws\|aws-cn\|aws-us-gov\|aws-iso(-[a-z])?):iam:: [0-9]{12}:(role\|user)\\/[\\w+\\/=,.@-]+$ • TagIdentiﬁer (Optional): • Description: (Optional) Tag the IAM principal with a tag of your choice using the following format: Key=<EXAMPLE_KEY>,Value=<EXAMPLE_VALUE>. This option allows you to track the IAM principals that have been targeted by this runbook. Note: Tag keys and values are case-sensitive. • Type: String • Allowed Pattern: ^$\|^[Kk][Ee][Yy]=[\\+\\-\\=\\.\\_\\:\\/@a-zA-Z0-9] {1,128},[Vv][Aa][Ll][Uu][Ee]=[\\+\\-\\=\\.\\_\\:\\/@a-zA-Z0-9] {0,128}$ 4. Select Execute. 5. The automation initiates. 6. The document performs the following steps: • ValidateRequiredInputs Validates the required automation input parameters based on the Action speciﬁed. • CheckBackupS3BucketName Checks if the target Amazon Amazon S3 bucket potentially grants read or write public access to its objects. In case of containment workﬂow, a new Amazon Amazon S3 bucket is created if the BackupS3BucketName bucket doesn't exist. • BranchOnAction Branches the automation based on the value of the speciﬁed Action. AWSSupport-ContainIAMPrincipal 574 AWS Systems Manager Automation runbook reference User Guide • BranchOnPrincipalTypeAndDryRun Branches the automation based on the type of IAM principal (IAM user, IAM role, or Identity Center user) and if it is running in DryRun mode. • BranchOnPrincipalTypeForContain Branches the automation for the Contain action based and the IAM principal type (IAM user, IAM role, or Identity Center user) speciﬁed in the input. • GetIAMUser Gets the creation time and username of the target IAM user. • GetIAMUserDetails Gets and stores the conﬁguration of the target IAM user, including inline policies, managed policies, access keys, MFA devices, and login proﬁle. • UpdateS3KeyForUser Updates the automation 'S3Key' variable from output of the step GetIAMUserDetails. • GetIAMRole Gets the creation time, role name, and path of the target IAM role. • GetIAMRoleDetails Gets and stores the conﬁguration of the target IAM role, including inline policies and managed policies attached to the role. • UpdateS3KeyForRole Updates the automation 'S3Key' variable from output of the step GetIAMRoleDetails. • GetIdentityStoreId Gets the ID of the AWS IAM Identity Center instance associated with the AWS account. • GetIDCUser Gets the user ID of the target Identity Center user using the Identity Store ID. • GatherIDCUserDetails Gets and stores the conﬁguration of the target Identity Center user, including account AWSSupport-ContainIAMPrincipal assignments, associated permission sets, and