Skip to content

Latest commit

 

History

History
328 lines (192 loc) · 11.2 KB

API.md

File metadata and controls

328 lines (192 loc) · 11.2 KB
Raw

API Reference

Constructs

Redirect

A base redirect construct that takes source and destination ports and protocols.

Common use cases can be built from this construct

Initializers 

import { Redirect } from '@renovosolutions/cdk-library-elbv2-redirect'

new Redirect(scope: Construct, id: string, props: RedirectProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props RedirectProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { Redirect } from '@renovosolutions/cdk-library-elbv2-redirect'

Redirect.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

RedirectHttpHttps

A construct that redirects HTTP to HTTPS for the given application load balancer.

Initializers 

import { RedirectHttpHttps } from '@renovosolutions/cdk-library-elbv2-redirect'

new RedirectHttpHttps(scope: Construct, id: string, props: RedirectHttpHttpsProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props RedirectHttpHttpsProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { RedirectHttpHttps } from '@renovosolutions/cdk-library-elbv2-redirect'

RedirectHttpHttps.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

Structs

RedirectHttpHttpsProps

Properties for the RedirectHttpHttps construct.

Initializer 

import { RedirectHttpHttpsProps } from '@renovosolutions/cdk-library-elbv2-redirect'

const redirectHttpHttpsProps: RedirectHttpHttpsProps = { ... }

Properties

Name Type Description
alb aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer The application load balancer this redirect applies to.
albRequired 
public readonly alb: ApplicationLoadBalancer;
  • Type: aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer

The application load balancer this redirect applies to.

RedirectProps

The properties for the base redirect construct.

Initializer 

import { RedirectProps } from '@renovosolutions/cdk-library-elbv2-redirect'

const redirectProps: RedirectProps = { ... }

Properties

Name Type Description
alb aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer The application load balancer this redirect applies to.
sourcePort number The source port to redirect from.
sourceProtocol aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocol The source protocol to redirect from.
targetPort number The target port to redirect to.
targetProtocol aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocol The target protocol to redirect to.
albRequired 
public readonly alb: ApplicationLoadBalancer;
  • Type: aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer

The application load balancer this redirect applies to.

sourcePortRequired 
public readonly sourcePort: number;
  • Type: number

The source port to redirect from.

sourceProtocolRequired 
public readonly sourceProtocol: ApplicationProtocol;
  • Type: aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocol

The source protocol to redirect from.

targetPortRequired 
public readonly targetPort: number;
  • Type: number

The target port to redirect to.

targetProtocolRequired 
public readonly targetProtocol: ApplicationProtocol;
  • Type: aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocol

The target protocol to redirect to.