Skip to main content

AlbSchema

The AlbSchema class is the schema for the Alb resource, which represents the AWS Application Load Balancer resource. This resource can create an Application Load Balancer in AWS using the AWS JavaScript SDK V3 API. See official sdk docs.

@group

Resources/Alb

@overrideProperty

parents - This resource has parents.

@overrideProperty

resourceId - The resource id is of format alb-<region-id>-<alb-name>

Hierarchy

  • BaseResourceSchema
    • AlbSchema

Index

Properties

Properties

inheritedparents

parents: IResourceReference[]

properties

properties: { awsAccountId: string; awsRegionId: string; IpAddressType: ipv4; Name: string; Scheme: internet-facing; Type: application } = ...

Input properties.

  • properties.awsAccountId - The AWS account id.
  • properties.awsRegionId - The AWS region id.
  • properties.IpAddressType - The IP address type. Possible values are ipv4.
  • properties.Name - The name of the ALB.
  • properties.Scheme - The scheme of the ALB. Possible values are internet-facing.
  • properties.Type - The type of the ALB. Possible values are application.

Type declaration

  • awsAccountId: string
  • awsRegionId: string
  • IpAddressType: ipv4
  • Name: string
  • Scheme: internet-facing
  • Type: application

inheritedresourceId

resourceId: string

response

response: { DNSName?: string; LoadBalancerArn?: string } = ...

Saved response.

  • response.DNSName - The DNS name of the ALB.
  • response.LoadBalancerArn - The ARN of the ALB.

Type declaration

  • optionalDNSName?: string
  • optionalLoadBalancerArn?: string

inheritedtags

tags: {}

Type declaration

  • [key string]: string
Page Options