AWSConfigRemediation-EnforceHTTPSOnOpenSearchDomain - 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-EnforceHTTPSOnOpenSearchDomain

Description

The AWSConfigRemediation-EnforceHTTPSOnOpenSearchDomain runbook enables EnforceHTTPS on a given Amazon OpenSearch Service domain using the UpdateDomainConfig 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 use to enforce HTTPS.

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

Required IAM permissions

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

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