aws-cdk-lib.aws_scheduler.CfnSchedule.AwsVpcConfigurationProperty

interface AwsVpcConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.Scheduler.CfnSchedule.AwsVpcConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsscheduler#CfnSchedule_AwsVpcConfigurationProperty
Javasoftware.amazon.awscdk.services.scheduler.CfnSchedule.AwsVpcConfigurationProperty
Pythonaws_cdk.aws_scheduler.CfnSchedule.AwsVpcConfigurationProperty
TypeScript aws-cdk-lib » aws_scheduler » CfnSchedule » AwsVpcConfigurationProperty

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_scheduler as scheduler } from 'aws-cdk-lib';
const awsVpcConfigurationProperty: scheduler.CfnSchedule.AwsVpcConfigurationProperty = {
  subnets: ['subnets'],

  // the properties below are optional
  assignPublicIp: 'assignPublicIp',
  securityGroups: ['securityGroups'],
};

Properties

NameTypeDescription
subnetsstring[]Specifies the subnets associated with the task.
assignPublicIp?stringSpecifies whether the task's elastic network interface receives a public IP address.
securityGroups?string[]Specifies the security groups associated with the task.

subnets

Type: string[]

Specifies the subnets associated with the task.

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


assignPublicIp?

Type: string (optional)

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 .


securityGroups?

Type: string[] (optional)

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.