AWS::ElasticLoadBalancingV2::Listener FixedResponseConfig - AWS CloudFormation
SyntaxPropertiesExamples
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::ElasticLoadBalancingV2::Listener FixedResponseConfig

Specifies information required when returning a custom HTTP response.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "ContentType" : String,
  "MessageBody" : String,
  "StatusCode" : String
}

YAML

  ContentType: String
  MessageBody: String
  StatusCode: String

Properties

ContentType

The content type.

Valid Values: text/plain | text/css | text/html | application/javascript | application/json

Required: No

Type: String

Minimum: 0

Maximum: 32

Update requires: No interruption

MessageBody

The message.

Required: No

Type: String

Minimum: 0

Maximum: 1024

Update requires: No interruption

StatusCode

The HTTP response code (2XX, 4XX, or 5XX).

Required: Yes

Type: String

Pattern: ^(2|4|5)\d\d$

Update requires: No interruption

Examples

The following example defines a listener with a default action that returns the specified HTTP response.

YAML

myHTTPListener:
  Type: 'AWS::ElasticLoadBalancingV2::Listener'
  Properties:
    LoadBalancerArn: !Ref myLoadBalancer
    Protocol: HTTP
    Port: 80
    DefaultActions:
      - Type: fixed-response
        FixedResponseConfig:
          ContentType: text/plain
          MessageBody: "Hello world"
          StatusCode: 200

JSON

{
    "myHTTPListener": {
        "Type": "AWS::ElasticLoadBalancingV2::Listener",
        "Properties": {
            "LoadBalancerArn": {
                "Ref": "myLoadBalancer"
            },
            "Protocol": "HTTP",
            "Port": 80,
            "DefaultActions": [
                {
                    "Type": "fixed-response",
                    "FixedResponseConfig": {
                        "ContentType": "text/plain",
                        "MessageBody": "Hello world",
                        "StatusCode": 200
                    }
                }
            ]
        }
    }
}