AWSConfigRemediation-EnableCloudFrontDefaultRootObject - Amazon Systems Manager Automation runbook reference
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWSConfigRemediation-EnableCloudFrontDefaultRootObject

Description

The AWSConfigRemediation-EnableCloudFrontDefaultRootObject runbook configures the default root object for the Amazon CloudFront (CloudFront) distribution that you specify.

Run this Automation (console)

Document type

Automation

Owner

Amazon

Platforms

Linux, macOS, Windows

Parameters

  • AutomationAssumeRole

    Type: String

    Allowed values: ^arn:(?:aws|aws-us-gov|aws-cn):iam::\d{12}:role\/[\w+=,.@/-]+$

    Description: (Required) The Amazon Resource Name (ARN) of the Amazon Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf.

  • CloudFrontDistributionId

    Type: String

    Description: (Required) The ID of the CloudFront distribution that you want to configure the default root object for.

  • DefaultRootObject

    Type: String

    Description: (Required) The object that you want CloudFront to return when a viewer request points to your root URL.

Required IAM permissions

The AutomationAssumeRole parameter requires the following actions to successfully use the runbook.

  • ssm:StartAutomationExecution

  • ssm:GetAutomationExecution

  • cloudfront:GetDistributionConfig

  • cloudfront:UpdateDistribution

Document Steps

  • aws:executeScript - Configures the default root object for the CloudFront distribution that you specify in the CloudFrontDistributionId parameter.