Skip to main content

AlbTargetGroupSchema

The AlbTargetGroupSchema class is the schema for the AlbTargetGroup resource, which represents the AWS Application Load Balancer Target Group resource. This resource can create a alb target group in AWS using the AWS JavaScript SDK V3 API. See official sdk docs.

@group

Resources/AlbTargetGroup

@overrideProperty

parents - This resource has parents.

@overrideProperty

resourceId - The resource id is of format alb-target-group-<execution-id>

Hierarchy

  • BaseResourceSchema
    • AlbTargetGroupSchema

Index

Properties

Properties

inheritedparents

parents: IResourceReference[]

properties

properties: { awsAccountId: string; awsRegionId: string; healthCheck?: AlbTargetGroupHealthCheckSchema; IpAddressType: ipv4; Name: string; Port: number; Protocol: HTTP; ProtocolVersion: HTTP1; TargetType: ip } = ...

Input properties.

  • properties.awsAccountId - The AWS account id.
  • properties.awsRegionId - The AWS region id.
  • properties.healthCheck - The health check configuration. See AlbTargetGroupHealthCheckSchema for options.
  • properties.IpAddressType - The IP address type. Possible values are ipv4.
  • properties.Name - The name of the target group. The name should be unique across all your target groups since the target groups are referenced in the ALB listener by name.
  • properties.Port - The port of the target group. This port is where the target will receive traffic. If your target has multiple ports, you must create a separate target group for each port.
  • properties.Protocol - The protocol of the target group. Possible values are HTTP.
  • properties.ProtocolVersion - The protocol version of the target group. Possible values are HTTP1.
  • properties.TargetType - The target type of the target group. Possible values are ip.

Type declaration

  • awsAccountId: string
  • awsRegionId: string
  • optionalhealthCheck?: AlbTargetGroupHealthCheckSchema
  • IpAddressType: ipv4
  • Name: string
  • Port: number
  • Protocol: HTTP
  • ProtocolVersion: HTTP1
  • TargetType: ip

inheritedresourceId

resourceId: string

response

response: { TargetGroupArn?: string } = ...

Saved response.

  • response.TargetGroupArn - The ARN of the target group.

Type declaration

  • optionalTargetGroupArn?: string

inheritedtags

tags: {}

Type declaration

  • [key string]: string
Page Options