AWS::Events::Rule AwsVpcConfiguration - AWS CloudFormation
SyntaxPropertiesExamplesSee also

AWS::Events::Rule AwsVpcConfiguration

This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.

Syntax

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

JSON

{
  "AssignPublicIp" : String,
  "SecurityGroups" : [ String, ... ],
  "Subnets" : [ String, ... ]
}

YAML

  AssignPublicIp: String
  SecurityGroups: 
    - String
  Subnets: 
    - String

Properties

AssignPublicIp

Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE.

Required: No

Type: String

Allowed values: ENABLED | DISABLED

Update requires: No interruption

SecurityGroups

Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.

Required: No

Type: Array of String

Update requires: No interruption

Subnets

Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.

Required: Yes

Type: Array of String

Update requires: No interruption

Examples

Set the AwsVpcConfiguration parameter

The following example sets the AwsVpcConfiguration parameter to not assign a public IP and set the security groups for Vpc01.

JSON

"AwsVpcConfiguration": {
  "AssignPublicIp": "DISABLED",
  "SecurityGroups": [
    {
      "Fn: : GetAtt": [
        "ScheduledFargateTaskScheduledTaskDefSecurityGroupE075BC19",
        "GroupId"
      ]
    }
  ],
  "Subnets": [
    {
      "Ref": "Vpc01"
    }
  ]
}

YAML

AwsVpcConfiguration:
  AssignPublicIp: "DISABLED"
  SecurityGroups:
    Fn: : GetAtt:
      "ScheduledFargateTaskScheduledTaskDefSecurityGroupE075BC19",
      "GroupId"
  Subnets:
    Ref: 
      "Vpc01"

See also