diff --git a/classes/constructs_acm.GuCertificate.html b/classes/constructs_acm.GuCertificate.html index 11ededd0d1..e01a333b21 100644 --- a/classes/constructs_acm.GuCertificate.html +++ b/classes/constructs_acm.GuCertificate.html @@ -3,7 +3,7 @@ validate your certificate.

If your DNS is not managed via Route 53, or you omit the hostedZoneId props, then the CloudFormation operation which adds this construct will pause until the relevant DNS record has been added manually.

-

Hierarchy

Constructors

constructor +

Hierarchy

  • Mixin<typeof Certificate, this> & Certificate<this>
    • GuCertificate

Constructors

constructor

Properties

certificateArn env idWithApp @@ -22,7 +22,7 @@ isConstruct isOwnedResource isResource -

Constructors

constructor

Properties

ReadonlycertificateArn

certificateArn: string

The certificate's ARN

+

Constructors

constructor

Properties

ReadonlycertificateArn

certificateArn: string

The certificate's ARN

Readonlyenv

env: ResourceEnvironment

The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), @@ -32,7 +32,7 @@ that might be different than the stack they were imported into.

ReadonlyidWithApp

idWithApp: string

The ID of the construct with the App suffix. This should be used in place of id when trying to reference the construct.

-

Readonlynode

node: Node

The tree node.

+

Readonlynode

node: Node

The tree node.

Protected ReadonlyphysicalName

physicalName: string

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

diff --git a/classes/constructs_autoscaling.GuAutoScalingGroup.html b/classes/constructs_autoscaling.GuAutoScalingGroup.html index fdd818f780..1c0d00e529 100644 --- a/classes/constructs_autoscaling.GuAutoScalingGroup.html +++ b/classes/constructs_autoscaling.GuAutoScalingGroup.html @@ -13,7 +13,7 @@ additionalSecurityGroups prop.

All EC2 instances provisioned via this construct will use IMDSv2.

-

Hierarchy

  • Mixin<typeof AutoScalingGroup, this> & AutoScalingGroup<this>
    • GuAutoScalingGroup

Constructors

constructor +

Hierarchy

  • Mixin<typeof AutoScalingGroup, this> & AutoScalingGroup<this>
    • GuAutoScalingGroup

Constructors

constructor

Properties

albTargetGroup? amiParameter app @@ -63,7 +63,7 @@ isConstruct isOwnedResource isResource -

Constructors

constructor

Properties

Protected OptionalalbTargetGroup

albTargetGroup?: ApplicationTargetGroup

ReadonlyamiParameter

amiParameter: GuAmiParameter

Readonlyapp

app: string

ReadonlyautoScalingGroupArn

autoScalingGroupArn: string

Arn of the AutoScalingGroup

+

Constructors

constructor

Properties

Protected OptionalalbTargetGroup

albTargetGroup?: ApplicationTargetGroup

ReadonlyamiParameter

amiParameter: GuAmiParameter

Readonlyapp

app: string

ReadonlyautoScalingGroupArn

autoScalingGroupArn: string

Arn of the AutoScalingGroup

ReadonlyautoScalingGroupName

autoScalingGroupName: string

Name of the AutoScalingGroup

Readonlyenv

env: ResourceEnvironment

The environment this resource belongs to. For resources that are created and managed by the CDK @@ -75,7 +75,7 @@

ReadonlygrantPrincipal

grantPrincipal: IPrincipal

The principal to grant permissions to

ProtectedhasCalledScaleOnRequestCount

hasCalledScaleOnRequestCount: boolean

ReadonlyidWithApp

idWithApp: string

The ID of the construct with the App suffix. This should be used in place of id when trying to reference the construct.

-

Optional ReadonlyimageRecipe

imageRecipe?: string | AmigoProps

ReadonlyinstanceLaunchTemplate

instanceLaunchTemplate: LaunchTemplate

Optional ReadonlymaxInstanceLifetime

maxInstanceLifetime?: Duration

The maximum amount of time that an instance can be in service.

+

Optional ReadonlyimageRecipe

imageRecipe?: string | AmigoProps

ReadonlyinstanceLaunchTemplate

instanceLaunchTemplate: LaunchTemplate

Optional ReadonlymaxInstanceLifetime

maxInstanceLifetime?: Duration

The maximum amount of time that an instance can be in service.

Protected OptionalnewInstancesProtectedFromScaleIn

newInstancesProtectedFromScaleIn?: boolean

Readonlynode

node: Node

The tree node.

ReadonlyosType

osType: OperatingSystemType

The type of OS instances of this fleet are running.

Protected ReadonlyphysicalName

physicalName: string

Returns a string-encoded token that resolves to the physical name that diff --git a/classes/constructs_autoscaling.GuUserData.html b/classes/constructs_autoscaling.GuUserData.html index 1e4ccee021..811bc9272a 100644 --- a/classes/constructs_autoscaling.GuUserData.html +++ b/classes/constructs_autoscaling.GuUserData.html @@ -5,9 +5,9 @@

  • download distributable
  • execute distributable
    • -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    configuration?

    Accessors

    userData

    Methods

    addCommands addS3DownloadCommand -

    Constructors

    constructor

    Properties

    Optional Readonlyconfiguration

    configuration?: GuPrivateS3ConfigurationProps

    Accessors

    userData

    Methods

    addCommands

    addS3DownloadCommand

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Constructors

    constructor

    Properties

    Optional Readonlyconfiguration

    configuration?: GuPrivateS3ConfigurationProps

    Accessors

    userData

    Methods

    addCommands

    addS3DownloadCommand

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/constructs_cloudwatch.GuAlarm.html b/classes/constructs_cloudwatch.GuAlarm.html index 1484f92b0b..907d3e1178 100644 --- a/classes/constructs_cloudwatch.GuAlarm.html +++ b/classes/constructs_cloudwatch.GuAlarm.html @@ -6,7 +6,7 @@

    This library provides an implementation of some commonly used alarms, which require less boilerplate than this construct, for example the [[GuAlb5xxPercentageAlarm]]. Prefer using these more specific implementations where possible.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    alarmActionArns? alarmArn alarmName @@ -33,7 +33,7 @@ isConstruct isOwnedResource isResource -

    Constructors

    constructor

    Properties

    Protected OptionalalarmActionArns

    alarmActionArns?: string[]

    ReadonlyalarmArn

    alarmArn: string

    ARN of this alarm

    +

    Constructors

    constructor

    Properties

    Protected OptionalalarmActionArns

    alarmActionArns?: string[]

    ReadonlyalarmArn

    alarmArn: string

    ARN of this alarm

    Attribute

    ReadonlyalarmName

    alarmName: string

    Name of this alarm.

    Attribute

    Readonlyenv

    env: ResourceEnvironment

    The environment this resource belongs to. For resources that are created and managed by the CDK diff --git a/classes/constructs_cloudwatch.GuAlb4xxPercentageAlarm.html b/classes/constructs_cloudwatch.GuAlb4xxPercentageAlarm.html index 7441a126f2..2185656d5c 100644 --- a/classes/constructs_cloudwatch.GuAlb4xxPercentageAlarm.html +++ b/classes/constructs_cloudwatch.GuAlb4xxPercentageAlarm.html @@ -1,6 +1,6 @@ GuAlb4xxPercentageAlarm | @guardian/cdk

    Class GuAlb4xxPercentageAlarm

    Creates an alarm which is triggered whenever the percentage of requests with a 4xx response code exceeds the specified threshold.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    alarmActionArns? alarmArn alarmName @@ -27,7 +27,7 @@ isConstruct isOwnedResource isResource -

    Constructors

    constructor

    Properties

    Protected OptionalalarmActionArns

    alarmActionArns?: string[]

    ReadonlyalarmArn

    alarmArn: string

    ARN of this alarm

    +

    Constructors

    constructor

    Properties

    Protected OptionalalarmActionArns

    alarmActionArns?: string[]

    ReadonlyalarmArn

    alarmArn: string

    ARN of this alarm

    Attribute

    ReadonlyalarmName

    alarmName: string

    Name of this alarm.

    Attribute

    Readonlyenv

    env: ResourceEnvironment

    The environment this resource belongs to. For resources that are created and managed by the CDK diff --git a/classes/constructs_cloudwatch.GuAlb5xxPercentageAlarm.html b/classes/constructs_cloudwatch.GuAlb5xxPercentageAlarm.html index 661656df59..35f4c51bb7 100644 --- a/classes/constructs_cloudwatch.GuAlb5xxPercentageAlarm.html +++ b/classes/constructs_cloudwatch.GuAlb5xxPercentageAlarm.html @@ -1,6 +1,6 @@ GuAlb5xxPercentageAlarm | @guardian/cdk

    Class GuAlb5xxPercentageAlarm

    Creates an alarm which is triggered whenever the percentage of requests with a 5xx response code exceeds the specified threshold.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    alarmActionArns? alarmArn alarmName @@ -27,7 +27,7 @@ isConstruct isOwnedResource isResource -

    Constructors

    constructor

    Properties

    Protected OptionalalarmActionArns

    alarmActionArns?: string[]

    ReadonlyalarmArn

    alarmArn: string

    ARN of this alarm

    +

    Constructors

    constructor

    Properties

    Protected OptionalalarmActionArns

    alarmActionArns?: string[]

    ReadonlyalarmArn

    alarmArn: string

    ARN of this alarm

    Attribute

    ReadonlyalarmName

    alarmName: string

    Name of this alarm.

    Attribute

    Readonlyenv

    env: ResourceEnvironment

    The environment this resource belongs to. For resources that are created and managed by the CDK diff --git a/classes/constructs_cloudwatch.GuLambdaErrorPercentageAlarm.html b/classes/constructs_cloudwatch.GuLambdaErrorPercentageAlarm.html index 62eb560334..eeea09a765 100644 --- a/classes/constructs_cloudwatch.GuLambdaErrorPercentageAlarm.html +++ b/classes/constructs_cloudwatch.GuLambdaErrorPercentageAlarm.html @@ -1,5 +1,5 @@ GuLambdaErrorPercentageAlarm | @guardian/cdk

    Class GuLambdaErrorPercentageAlarm

    Creates an alarm which is triggered whenever the error percentage specified is exceeded.

    -

    Hierarchy (view full)

    • GuAlarm
      • GuLambdaErrorPercentageAlarm

    Constructors

    constructor +

    Hierarchy (view full)

    • GuAlarm
      • GuLambdaErrorPercentageAlarm

    Constructors

    constructor

    Properties

    alarmActionArns? alarmArn alarmName @@ -26,7 +26,7 @@ isConstruct isOwnedResource isResource -

    Constructors

    constructor

    Properties

    Protected OptionalalarmActionArns

    alarmActionArns?: string[]

    ReadonlyalarmArn

    alarmArn: string

    ARN of this alarm

    +

    Constructors

    constructor

    Properties

    Protected OptionalalarmActionArns

    alarmActionArns?: string[]

    ReadonlyalarmArn

    alarmArn: string

    ARN of this alarm

    Attribute

    ReadonlyalarmName

    alarmName: string

    Name of this alarm.

    Attribute

    Readonlyenv

    env: ResourceEnvironment

    The environment this resource belongs to. For resources that are created and managed by the CDK diff --git a/classes/constructs_cloudwatch.GuLambdaThrottlingAlarm.html b/classes/constructs_cloudwatch.GuLambdaThrottlingAlarm.html index de7b241e94..16e3778205 100644 --- a/classes/constructs_cloudwatch.GuLambdaThrottlingAlarm.html +++ b/classes/constructs_cloudwatch.GuLambdaThrottlingAlarm.html @@ -6,7 +6,7 @@

    This library provides an implementation of some commonly used alarms, which require less boilerplate than this construct, for example the [[GuAlb5xxPercentageAlarm]]. Prefer using these more specific implementations where possible.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    alarmActionArns? alarmArn alarmName @@ -33,7 +33,7 @@ isConstruct isOwnedResource isResource -

    Constructors

    constructor

    Properties

    Protected OptionalalarmActionArns

    alarmActionArns?: string[]

    ReadonlyalarmArn

    alarmArn: string

    ARN of this alarm

    +

    Constructors

    constructor

    Properties

    Protected OptionalalarmActionArns

    alarmActionArns?: string[]

    ReadonlyalarmArn

    alarmArn: string

    ARN of this alarm

    Attribute

    ReadonlyalarmName

    alarmName: string

    Name of this alarm.

    Attribute

    Readonlyenv

    env: ResourceEnvironment

    The environment this resource belongs to. For resources that are created and managed by the CDK diff --git a/classes/constructs_cloudwatch.GuUnhealthyInstancesAlarm.html b/classes/constructs_cloudwatch.GuUnhealthyInstancesAlarm.html index 768017e1db..d7e51aa236 100644 --- a/classes/constructs_cloudwatch.GuUnhealthyInstancesAlarm.html +++ b/classes/constructs_cloudwatch.GuUnhealthyInstancesAlarm.html @@ -1,5 +1,5 @@ GuUnhealthyInstancesAlarm | @guardian/cdk

    Class GuUnhealthyInstancesAlarm

    Creates an alarm which is triggered whenever there have been several healthcheck failures within a single hour.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    alarmActionArns? alarmArn alarmName @@ -26,7 +26,7 @@ isConstruct isOwnedResource isResource -

    Constructors

    constructor

    Properties

    Protected OptionalalarmActionArns

    alarmActionArns?: string[]

    ReadonlyalarmArn

    alarmArn: string

    ARN of this alarm

    +

    Constructors

    constructor

    Properties

    Protected OptionalalarmActionArns

    alarmActionArns?: string[]

    ReadonlyalarmArn

    alarmArn: string

    ARN of this alarm

    Attribute

    ReadonlyalarmName

    alarmName: string

    Name of this alarm.

    Attribute

    Readonlyenv

    env: ResourceEnvironment

    The environment this resource belongs to. For resources that are created and managed by the CDK diff --git a/classes/constructs_core.GuAccessLoggingBucketParameter.html b/classes/constructs_core.GuAccessLoggingBucketParameter.html index e9000efece..f3b8290200 100644 --- a/classes/constructs_core.GuAccessLoggingBucketParameter.html +++ b/classes/constructs_core.GuAccessLoggingBucketParameter.html @@ -1,6 +1,6 @@ GuAccessLoggingBucketParameter | @guardian/cdk

    Class GuAccessLoggingBucketParameter

    Creates a CloudFormation parameter which references the bucket used to store load balancer access logs. By default, the bucket name is stored in an SSM Parameter called /account/services/access-logging/bucket.

    -

    Hierarchy (view full)

    Properties

    id +

    Hierarchy (view full)

    Properties

    id logicalId node stack @@ -28,7 +28,7 @@ getInstance isCfnElement isConstruct -

    Properties

    Readonlyid

    id: string

    ReadonlylogicalId

    logicalId: string

    The logical ID for this CloudFormation stack element. The logical ID of the element +

    Properties

    Readonlyid

    id: string

    ReadonlylogicalId

    logicalId: string

    The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree.

    To override this value, use overrideLogicalId(newLogicalId).

    Returns

    the logical ID as a stringified token. This value will only get @@ -104,7 +104,7 @@

    Returns void

    _toCloudFormation

    overrideLogicalId

    • overrideLogicalId(newLogicalId): void

    • Overrides the auto-generated logical ID with a specific ID.

      Parameters

      • newLogicalId: string

        The new logical ID to use for this stack element.

      Returns void

    resolve

    • resolve(_context): any

    • Parameters

      • _context: IResolveContext

      Returns any

    toString

    • toString(): string

    • Returns a string representation of this construct.

      -

      Returns string

    StaticgetInstance

    StaticisCfnElement

    • isCfnElement(x): x is CfnElement

    • Returns true if a construct is a stack element (i.e. part of the +

      Returns string

    StaticgetInstance

    StaticisCfnElement

    Properties

    Readonlyid

    id: string

    ReadonlylogicalId

    logicalId: string

    The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree.

    To override this value, use overrideLogicalId(newLogicalId).

    Returns

    the logical ID as a stringified token. This value will only get @@ -108,7 +108,7 @@

    Returns string

    StaticgetInstance

    StaticisCfnElement

    • isCfnElement(x): x is CfnElement

    • Returns true if a construct is a stack element (i.e. part of the +

    Returns GuAnghammaradTopicParameter

    StaticisCfnElement

    _toCloudFormation

    overrideLogicalId

    • overrideLogicalId(newLogicalId): void

    • Overrides the auto-generated logical ID with a specific ID.

      Parameters

      • newLogicalId: string

        The new logical ID to use for this stack element.

      Returns void

    resolve

    • resolve(_context): any

    • Parameters

      • _context: IResolveContext

      Returns any

    toString

    • toString(): string

    • Returns a string representation of this construct.

      -

      Returns string

    StaticgetInstance

    StaticisCfnElement

    • isCfnElement(x): x is CfnElement

    • Returns true if a construct is a stack element (i.e. part of the +

      Returns string

    StaticgetInstance

    StaticisCfnElement

    • isCfnElement(x): x is CfnElement

    • Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

      Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

      diff --git a/classes/constructs_core.GuFastlyCustomerIdParameter.html b/classes/constructs_core.GuFastlyCustomerIdParameter.html index 9e18c90af3..037d62b9a3 100644 --- a/classes/constructs_core.GuFastlyCustomerIdParameter.html +++ b/classes/constructs_core.GuFastlyCustomerIdParameter.html @@ -1,7 +1,7 @@ GuFastlyCustomerIdParameter | @guardian/cdk

      Class GuFastlyCustomerIdParameter

      Creates a CloudFormation parameter which contains the Fastly customer ID to use in setting up a Fastly logging role. By default, the customer ID is stored in an SSM Parameter called /account/external/fastly/customer.id.

      -

      Hierarchy (view full)

      Properties

      id +

      Hierarchy (view full)

      Properties

      id logicalId node stack @@ -29,7 +29,7 @@ getInstance isCfnElement isConstruct -

      Properties

      Readonlyid

      id: string

      ReadonlylogicalId

      logicalId: string

      The logical ID for this CloudFormation stack element. The logical ID of the element +

      Properties

      Readonlyid

      id: string

      ReadonlylogicalId

      logicalId: string

      The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree.

      To override this value, use overrideLogicalId(newLogicalId).

      Returns

      the logical ID as a stringified token. This value will only get @@ -105,7 +105,7 @@

      Returns void

    _toCloudFormation

    overrideLogicalId

    • overrideLogicalId(newLogicalId): void

    • Overrides the auto-generated logical ID with a specific ID.

      Parameters

      • newLogicalId: string

        The new logical ID to use for this stack element.

      Returns void

    resolve

    • resolve(_context): any

    • Parameters

      • _context: IResolveContext

      Returns any

    toString

    • toString(): string

    • Returns a string representation of this construct.

      -

      Returns string

    StaticgetInstance

    StaticisCfnElement

    • isCfnElement(x): x is CfnElement

    • Returns true if a construct is a stack element (i.e. part of the +

      Returns string

    StaticgetInstance

    StaticisCfnElement

    • isCfnElement(x): x is CfnElement

    • Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

      Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

      diff --git a/classes/constructs_core.GuLoggingStreamNameParameter.html b/classes/constructs_core.GuLoggingStreamNameParameter.html index 948ec7010f..674903d075 100644 --- a/classes/constructs_core.GuLoggingStreamNameParameter.html +++ b/classes/constructs_core.GuLoggingStreamNameParameter.html @@ -1,4 +1,4 @@ -GuLoggingStreamNameParameter | @guardian/cdk

      Class GuLoggingStreamNameParameter

      Hierarchy (view full)

      Properties

      id +GuLoggingStreamNameParameter | @guardian/cdk

      Class GuLoggingStreamNameParameter

      Hierarchy (view full)

      Properties

      id logicalId node stack @@ -26,7 +26,7 @@ getInstance isCfnElement isConstruct -

      Properties

      Readonlyid

      id: string

      ReadonlylogicalId

      logicalId: string

      The logical ID for this CloudFormation stack element. The logical ID of the element +

      Properties

      Readonlyid

      id: string

      ReadonlylogicalId

      logicalId: string

      The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree.

      To override this value, use overrideLogicalId(newLogicalId).

      Returns

      the logical ID as a stringified token. This value will only get @@ -102,7 +102,7 @@

      Returns void

    _toCloudFormation

    overrideLogicalId

    • overrideLogicalId(newLogicalId): void

    • Overrides the auto-generated logical ID with a specific ID.

      Parameters

      • newLogicalId: string

        The new logical ID to use for this stack element.

      Returns void

    resolve

    • resolve(_context): any

    • Parameters

      • _context: IResolveContext

      Returns any

    toString

    • toString(): string

    • Returns a string representation of this construct.

      -

      Returns string

    StaticgetInstance

    StaticisCfnElement

    • isCfnElement(x): x is CfnElement

    • Returns true if a construct is a stack element (i.e. part of the +

      Returns string

    StaticgetInstance

    StaticisCfnElement

    • isCfnElement(x): x is CfnElement

    • Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

      Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

      diff --git a/classes/constructs_core.GuParameter.html b/classes/constructs_core.GuParameter.html index 0ca4c63b03..ff7ade10f5 100644 --- a/classes/constructs_core.GuParameter.html +++ b/classes/constructs_core.GuParameter.html @@ -1,4 +1,4 @@ -GuParameter | @guardian/cdk

      Class GuParameter

      Hierarchy (view full)

      Constructors

      constructor +GuParameter | @guardian/cdk

      Class GuParameter

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      id logicalId node @@ -26,7 +26,7 @@ toString isCfnElement isConstruct -

      Constructors

      constructor

      Properties

      Readonlyid

      id: string

      ReadonlylogicalId

      logicalId: string

      The logical ID for this CloudFormation stack element. The logical ID of the element +

      Constructors

      constructor

      Properties

      Readonlyid

      id: string

      ReadonlylogicalId

      logicalId: string

      The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree.

      To override this value, use overrideLogicalId(newLogicalId).

      Returns

      the logical ID as a stringified token. This value will only get diff --git a/classes/constructs_core.GuPrivateConfigBucketParameter.html b/classes/constructs_core.GuPrivateConfigBucketParameter.html index 006b46defa..77e5e2fd44 100644 --- a/classes/constructs_core.GuPrivateConfigBucketParameter.html +++ b/classes/constructs_core.GuPrivateConfigBucketParameter.html @@ -1,4 +1,4 @@ -GuPrivateConfigBucketParameter | @guardian/cdk

      Class GuPrivateConfigBucketParameter

      Hierarchy (view full)

      Constructors

      constructor +GuPrivateConfigBucketParameter | @guardian/cdk

      Class GuPrivateConfigBucketParameter

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      id logicalId node @@ -27,14 +27,14 @@ toString isCfnElement isConstruct -

      Constructors

      constructor

      Properties

      Readonlyid

      id: string

      ReadonlylogicalId

      logicalId: string

      The logical ID for this CloudFormation stack element. The logical ID of the element +

      Constructors

      constructor

      Properties

      Readonlyid

      id: string

      ReadonlylogicalId

      logicalId: string

      The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree.

      To override this value, use overrideLogicalId(newLogicalId).

      Returns

      the logical ID as a stringified token. This value will only get resolved during synthesis.

      Readonlynode

      node: Node

      The tree node.

      Readonlystack

      stack: Stack

      The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly).

      -

      StaticparameterName

      parameterName: string = "PrivateConfigBucketName"

      Accessors

      allowedPattern

      • get allowedPattern(): undefined | string

      • A regular expression that represents the patterns to allow for String types.

        +

      StaticparameterName

      parameterName: string = "PrivateConfigBucketName"

      Accessors

      allowedPattern

      • get allowedPattern(): undefined | string

      • A regular expression that represents the patterns to allow for String types.

        Returns undefined | string

        Default

        - No constraints on patterns allowed for parameter.
        diff --git a/classes/constructs_core.GuStack.html b/classes/constructs_core.GuStack.html index 2650cf8b4a..f2b148805d 100644 --- a/classes/constructs_core.GuStack.html +++ b/classes/constructs_core.GuStack.html @@ -15,7 +15,7 @@ 
        class MyStack extends GuStack {
          constructor(scope: App, id: string, props: GuStackProps) {
            super(scope, id, props)
          }

          // add resources here
        }
        -

      Hierarchy

      • Stack
        • GuStack

      Implements

      Constructors

      constructor +

      Hierarchy

      • Stack
        • GuStack

      Implements

      Constructors

      constructor

      Properties

      _crossRegionReferences _notificationArns _versionReportingEnabled @@ -72,7 +72,7 @@ isConstruct isStack of -

      Constructors

      constructor

      Properties

      Readonly Internal_crossRegionReferences

      _crossRegionReferences: boolean

      Whether cross region references are enabled for this stack

      +

      Constructors

      constructor

      Properties

      Readonly Internal_crossRegionReferences

      _crossRegionReferences: boolean

      Whether cross region references are enabled for this stack

      Readonly Internal_notificationArns

      _notificationArns: string[]

      SNS Notification ARNs to receive stack events.

      Readonly Internal_versionReportingEnabled

      _versionReportingEnabled: boolean

      Whether version reporting is enabled for this stack

      Controls whether the CDK Metadata resource is injected

      @@ -93,7 +93,7 @@ into a account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

      -

      Readonlyapp

      app: undefined | string

      ReadonlyartifactId

      artifactId: string

      The ID of the cloud assembly artifact for this stack.

      +

      Readonlyapp

      app: undefined | string

      ReadonlyartifactId

      artifactId: string

      The ID of the cloud assembly artifact for this stack.

      Readonlyenvironment

      environment: string

      The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

      @@ -125,7 +125,7 @@ implement some other region-agnostic behavior.

      ReadonlyrepositoryName

      repositoryName: undefined | string

      The repository name, if it can be determined from the context or the git remote origin url. If it cannot be determined from either of these sources, it will be undefined.

      -

      Readonlystack

      stack: string

      Readonlystage

      stage: string

      Readonlysynthesizer

      synthesizer: IStackSynthesizer

      Synthesis method for this stack

      +

      Readonlystack

      stack: string

      Readonlystage

      stage: string

      Readonlysynthesizer

      synthesizer: IStackSynthesizer

      Synthesis method for this stack

      Readonlytags

      tags: TagManager

      Tags to be applied to the stack.

      ReadonlytemplateFile

      templateFile: string

      The name of the CloudFormation template file emitted to the output directory during synthesis.

      @@ -148,7 +148,7 @@

      Returns undefined | Stack

    notificationArns

    • get notificationArns(): string[]

    • Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      Returns string[]

    parameters

    partition

    • get partition(): string

    • The partition in which this stack is defined

      +

    partition

    • get partition(): string

    • The partition in which this stack is defined

      Returns string

    stackId

    • get stackId(): string

    • The ID of the stack

      Returns string

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
      @@ -191,7 +191,7 @@

      Parameters

      • key: string

        the tag name

      • value: string

        the value of the tag

      • applyToLaunchedInstances: boolean = true

        whether or not to apply the tag to instances launched in an ASG.

        -

      Returns void

    addTransform

    • addTransform(transform): void

    • Add a Transform to this stack. A Transform is a macro that AWS +

    Returns void

    addTransform

    • addTransform(transform): void

    • Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.

      Duplicate values are removed when stack is synthesized.

      Parameters

    regionalFact

    • regionalFact(factName, defaultValue?): string

    • Look up a fact value for the given fact for the region of this stack

      +
    • __namedParameters: GuStaticLogicalId

    Returns void

    regionalFact

    _toCloudFormation

    • _toCloudFormation(): object
    • Internal

      Returns object

    overrideLogicalId

    • overrideLogicalId(newLogicalId): void

    • Overrides the auto-generated logical ID with a specific ID.

      Parameters

      • newLogicalId: string

        The new logical ID to use for this stack element.

      Returns void

    resolve

    • resolve(_context): any

    • Parameters

      • _context: IResolveContext

      Returns any

    toString

    • toString(): string

    • Returns a string representation of this construct.

      -

      Returns string

    StaticgetInstance

    StaticisCfnElement

    • isCfnElement(x): x is CfnElement

    • Returns true if a construct is a stack element (i.e. part of the +

      Returns string

    StaticgetInstance

    StaticisCfnElement

    Returns string

    toEgressRuleConfig

    • toEgressRuleConfig(): any

    • Produce the egress rule JSON for the given connection

      Returns any

    toIngressRuleConfig

    • toIngressRuleConfig(): any

    • Produce the ingress rule JSON for the given connection

      Returns any

    toString

    • toString(): string

    • Returns a string representation of an object.

      -

      Returns string

    StaticforVpc

    StaticfromLookupById

    • fromLookupById(scope, id, securityGroupId): ISecurityGroup

    • Look up a security group by id.

      +

      Returns string

    StaticforVpc

    StaticfromLookupById

    • fromLookupById(scope, id, securityGroupId): ISecurityGroup

    • Look up a security group by id.

      Parameters

      • scope: Construct
      • id: string
      • securityGroupId: string

      Returns ISecurityGroup

    StaticfromLookupByName

    • fromLookupByName(scope, id, securityGroupName, vpc): ISecurityGroup

    • Look up a security group by name.

      Parameters

      • scope: Construct
      • id: string
      • securityGroupName: string
      • vpc: IVpc

      Returns ISecurityGroup

    StaticfromSecurityGroupId

    StaticisConstruct

    • isConstruct(x): x is Construct

    • Checks if x is a construct.

      +

    Returns GuWazuhAccess

    StaticisConstruct

    • isConstruct(x): x is Construct

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on diff --git a/classes/constructs_ecs.GuEcsTask.html b/classes/constructs_ecs.GuEcsTask.html index 90da0c54cd..8cc320c77a 100644 --- a/classes/constructs_ecs.GuEcsTask.html +++ b/classes/constructs_ecs.GuEcsTask.html @@ -3,13 +3,13 @@

      For all configuration options, see [[GuEcsTaskProps]].

      Note that if your task reliably completes in less than 15 minutes then you should probably use a [[GuLambda]] instead. This pattern was mainly created to work around the 15 minute lambda timeout.

      -

    Hierarchy

    • Construct
      • GuEcsTask

    Constructors

    constructor +

    Hierarchy

    • Construct
      • GuEcsTask

    Constructors

    constructor

    Properties

    node stateMachine

    Methods

    toString isConstruct -

    Constructors

    constructor

    Properties

    Readonlynode

    node: Node

    The tree node.

    -

    stateMachine

    stateMachine: StateMachine

    Methods

    toString

    • toString(): string

    • Returns a string representation of this construct.

      +

    Constructors

    constructor

    Properties

    Readonlynode

    node: Node

    The tree node.

    +

    stateMachine

    stateMachine: StateMachine

    Methods

    toString

    • toString(): string

    • Returns a string representation of this construct.

      Returns string

    StaticisConstruct

    -

    Hierarchy (view full)

    Properties

    document +

    Hierarchy (view full)

    Properties

    document env grantPrincipal node @@ -83,7 +83,7 @@ Commonly this is the resource's ref.

    Returns string

    toString

    • toString(): string

    • Returns a string representation of this construct.

      Returns string

    StaticfromPolicyName

    • fromPolicyName(scope, id, policyName): IPolicy

    • Import a policy in this app based on its name

      -

      Parameters

      • scope: Construct
      • id: string
      • policyName: string

      Returns IPolicy

    StaticgetInstance

    StaticisConstruct

    • isConstruct(x): x is Construct

    • Checks if x is a construct.

      +

      Parameters

      • scope: Construct
      • id: string
      • policyName: string

      Returns IPolicy

    StaticgetInstance

    StaticisConstruct

    Returns string

    toString

    • toString(): string

    • Returns a string representation of this construct.

      Returns string

    StaticfromPolicyName

    • fromPolicyName(scope, id, policyName): IPolicy

    • Import a policy in this app based on its name

      -

      Parameters

      • scope: Construct
      • id: string
      • policyName: string

      Returns IPolicy

    StaticgetInstance

    StaticisConstruct

    • isConstruct(x): x is Construct

    • Checks if x is a construct.

      +

      Parameters

      • scope: Construct
      • id: string
      • policyName: string

      Returns IPolicy

    StaticgetInstance

    StaticisConstruct

    Returns string

    toString

    • toString(): string

    • Returns a string representation of this construct.

      Returns string

    StaticfromPolicyName

    • fromPolicyName(scope, id, policyName): IPolicy

    • Import a policy in this app based on its name

      -

      Parameters

      • scope: Construct
      • id: string
      • policyName: string

      Returns IPolicy

    StaticgetInstance

    StaticisConstruct

    • isConstruct(x): x is Construct

    • Checks if x is a construct.

      +

      Parameters

      • scope: Construct
      • id: string
      • policyName: string

      Returns IPolicy

    StaticgetInstance

    StaticisConstruct

    • isConstruct(x): x is Construct

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on diff --git a/classes/constructs_iam.GuParameterStoreReadPolicy.html b/classes/constructs_iam.GuParameterStoreReadPolicy.html index c359422909..de8841fb50 100644 --- a/classes/constructs_iam.GuParameterStoreReadPolicy.html +++ b/classes/constructs_iam.GuParameterStoreReadPolicy.html @@ -1,6 +1,6 @@ GuParameterStoreReadPolicy | @guardian/cdk

      Class GuParameterStoreReadPolicy

      Grants read-only permissions for Parameter Store. These permissions are typically used for accessing private configuration. See [[ReadParametersByPath]] and [[ReadParametersByName]] for more details.

      -

      Hierarchy

      Constructors

      constructor +

      Hierarchy

      Constructors

      constructor

      Properties

      document env grantPrincipal @@ -23,7 +23,7 @@ isConstruct isOwnedResource isResource -

      Constructors

      constructor

      Properties

      Readonlydocument

      document: PolicyDocument

      The policy document.

      +

      Constructors

      constructor

      Properties

      Readonlydocument

      document: PolicyDocument

      The policy document.

      Readonlyenv

      env: ResourceEnvironment

      The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), @@ -34,7 +34,7 @@

      ReadonlygrantPrincipal

      grantPrincipal: IPrincipal

      The principal to grant permissions to

      ReadonlyidWithApp

      idWithApp: string

      The ID of the construct with the App suffix. This should be used in place of id when trying to reference the construct.

      -

      Readonlynode

      node: Node

      The tree node.

      +

      Readonlynode

      node: Node

      The tree node.

      Protected ReadonlyphysicalName

      physicalName: string

      Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

      This value will resolve to one of the following:

      diff --git a/classes/constructs_iam.GuPolicy.html b/classes/constructs_iam.GuPolicy.html index 98bdb792d1..1608ed5a88 100644 --- a/classes/constructs_iam.GuPolicy.html +++ b/classes/constructs_iam.GuPolicy.html @@ -1,4 +1,4 @@ -GuPolicy | @guardian/cdk

      Class GuPolicy

      Hierarchy (view full)

      Constructors

      constructor +GuPolicy | @guardian/cdk

      Class GuPolicy

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      document env grantPrincipal @@ -20,7 +20,7 @@ isConstruct isOwnedResource isResource -

      Constructors

      constructor

      Properties

      Readonlydocument

      document: PolicyDocument

      The policy document.

      +

      Constructors

      constructor

      Properties

      Readonlydocument

      document: PolicyDocument

      The policy document.

      Readonlyenv

      env: ResourceEnvironment

      The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), diff --git a/classes/constructs_iam.GuPutCloudwatchMetricsPolicy.html b/classes/constructs_iam.GuPutCloudwatchMetricsPolicy.html index 28b6015bc1..4c47dd9368 100644 --- a/classes/constructs_iam.GuPutCloudwatchMetricsPolicy.html +++ b/classes/constructs_iam.GuPutCloudwatchMetricsPolicy.html @@ -1,4 +1,4 @@ -GuPutCloudwatchMetricsPolicy | @guardian/cdk

      Class GuPutCloudwatchMetricsPolicy

      Hierarchy

      • GuCloudwatchPolicy
        • GuPutCloudwatchMetricsPolicy

      Constructors

      constructor +GuPutCloudwatchMetricsPolicy | @guardian/cdk

      Class GuPutCloudwatchMetricsPolicy

      Hierarchy

      • GuCloudwatchPolicy
        • GuPutCloudwatchMetricsPolicy

      Constructors

      constructor

      Properties

      document env grantPrincipal @@ -20,7 +20,7 @@ isConstruct isOwnedResource isResource -

      Constructors

      constructor

      Properties

      Readonlydocument

      document: PolicyDocument

      The policy document.

      +

      Constructors

      constructor

      Properties

      Readonlydocument

      document: PolicyDocument

      The policy document.

      Readonlyenv

      env: ResourceEnvironment

      The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), diff --git a/classes/constructs_iam.GuPutS3ObjectsPolicy.html b/classes/constructs_iam.GuPutS3ObjectsPolicy.html index 114d0c619d..f0ad5d8170 100644 --- a/classes/constructs_iam.GuPutS3ObjectsPolicy.html +++ b/classes/constructs_iam.GuPutS3ObjectsPolicy.html @@ -1,4 +1,4 @@ -GuPutS3ObjectsPolicy | @guardian/cdk

      Class GuPutS3ObjectsPolicy

      Hierarchy (view full)

      Constructors

      constructor +GuPutS3ObjectsPolicy | @guardian/cdk

      Class GuPutS3ObjectsPolicy

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      document env grantPrincipal @@ -20,7 +20,7 @@ isConstruct isOwnedResource isResource -

      Constructors

      constructor

      Properties

      Readonlydocument

      document: PolicyDocument

      The policy document.

      +

      Constructors

      constructor

      Properties

      Readonlydocument

      document: PolicyDocument

      The policy document.

      Readonlyenv

      env: ResourceEnvironment

      The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), diff --git a/classes/constructs_iam.GuRole.html b/classes/constructs_iam.GuRole.html index 2d7c6faf14..5d6cf75258 100644 --- a/classes/constructs_iam.GuRole.html +++ b/classes/constructs_iam.GuRole.html @@ -1,4 +1,4 @@ -GuRole | @guardian/cdk

      Class GuRole

      Hierarchy (view full)

      Constructors

      constructor +GuRole | @guardian/cdk

      Class GuRole

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      assumeRoleAction assumeRolePolicy? env @@ -33,7 +33,7 @@ isOwnedResource isResource isRole -

      Constructors

      constructor

      Properties

      ReadonlyassumeRoleAction

      assumeRoleAction: string

      When this Principal is used in an AssumeRole policy, the action to use.

      +

      Constructors

      constructor

      Properties

      ReadonlyassumeRoleAction

      assumeRoleAction: string

      When this Principal is used in an AssumeRole policy, the action to use.

      Optional ReadonlyassumeRolePolicy

      assumeRolePolicy?: PolicyDocument

      The assume role policy document associated with this role.

      Readonlyenv

      env: ResourceEnvironment

      The environment this resource belongs to. For resources that are created and managed by the CDK diff --git a/classes/constructs_iam.GuSESSenderPolicy.html b/classes/constructs_iam.GuSESSenderPolicy.html index 4cb23aedee..f1fb5ad217 100644 --- a/classes/constructs_iam.GuSESSenderPolicy.html +++ b/classes/constructs_iam.GuSESSenderPolicy.html @@ -1,4 +1,4 @@ -GuSESSenderPolicy | @guardian/cdk

      Class GuSESSenderPolicy

      Hierarchy (view full)

      Constructors

      constructor +GuSESSenderPolicy | @guardian/cdk

      Class GuSESSenderPolicy

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      document env grantPrincipal @@ -20,7 +20,7 @@ isConstruct isOwnedResource isResource -

      Constructors

      constructor

      Properties

      Readonlydocument

      document: PolicyDocument

      The policy document.

      +

      Constructors

      constructor

      Properties

      Readonlydocument

      document: PolicyDocument

      The policy document.

      Readonlyenv

      env: ResourceEnvironment

      The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), diff --git a/classes/constructs_iam.ReadParametersByName.html b/classes/constructs_iam.ReadParametersByName.html index 91697e1790..36efe82120 100644 --- a/classes/constructs_iam.ReadParametersByName.html +++ b/classes/constructs_iam.ReadParametersByName.html @@ -1,7 +1,7 @@ ReadParametersByName | @guardian/cdk

      Class ReadParametersByName

      This is helpful for accessing specific pieces of private configuration. For example, the play-secret-rotation library requires ssm:GetParameters permissions.

      -

      Hierarchy

      • PolicyStatement
        • ReadParametersByName

      Constructors

      constructor +

      Hierarchy

      • PolicyStatement
        • ReadParametersByName

      Constructors

      constructor

      Accessors

      actions conditions effect @@ -43,7 +43,7 @@ validateForIdentityPolicy validateForResourcePolicy fromJson -

      Constructors

      constructor

      Accessors

      actions

      • get actions(): string[]

      • The Actions added to this statement

        +

      Constructors

      constructor

      Accessors

      actions

      • get actions(): string[]

      • The Actions added to this statement

        Returns string[]

      conditions

      • get conditions(): any

      • The conditions added to this statement

        Returns any

      effect

      Constructors

      constructor

      Properties

      Protected ReadonlyautoCreatePolicy

      autoCreatePolicy = true

      Indicates if a stream resource policy should automatically be created upon the first call to addToResourcePolicy.

      Set by subclasses.

      Optional ReadonlyencryptionKey

      encryptionKey?: IKey

      Optional KMS encryption key associated with this stream.

      diff --git a/classes/constructs_lambda.GuLambdaFunction.html b/classes/constructs_lambda.GuLambdaFunction.html index 38f7114ccb..d388cbc32c 100644 --- a/classes/constructs_lambda.GuLambdaFunction.html +++ b/classes/constructs_lambda.GuLambdaFunction.html @@ -21,7 +21,7 @@

      Note that this construct creates a Lambda without an event source. Depending on your use-case, you may wish to consider using a pattern which instantiates a Lambda with an event source e.g. [[GuScheduledLambda]].

      -

      Hierarchy (view full)

      Constructors

      constructor +

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      _connections? _functionUrlInvocationGrants _invocationGrants @@ -102,7 +102,7 @@ metricAllInvocations metricAllThrottles metricAllUnreservedConcurrentExecutions -

      Constructors

      constructor

      Properties

      Protected Optional Internal_connections

      _connections?: Connections

      Actual connections object for this Lambda

      +

      Constructors

      constructor

      Properties

      Protected Optional Internal_connections

      _connections?: Connections

      Actual connections object for this Lambda

      May be unset, in which case this Lambda is not configured use in a VPC.

      Protected Internal_functionUrlInvocationGrants

      _functionUrlInvocationGrants: Record<string, Grant>

      Mapping of fucntion URL invocation principals to grants. Used to de-dupe grantInvokeUrl() calls.

      Protected Internal_invocationGrants

      _invocationGrants: Record<string, Grant>

      Mapping of invocation principals to grants. Used to de-dupe grantInvoke() calls.

      @@ -111,8 +111,8 @@ where the user commits to modifying the permisssions on the imported lambda outside CDK.

      Protected Internal_warnIfCurrentVersionCalled

      _warnIfCurrentVersionCalled: boolean

      Flag to delay adding a warning message until current version is invoked.

      -

      Optional Readonlyalias

      alias?: Alias

      Readonlyapp

      app: string

      Readonlyarchitecture

      architecture: Architecture

      The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).

      -

      ReadonlybucketNamePath

      bucketNamePath: undefined | string

      Protected ReadonlycanCreatePermissions

      canCreatePermissions = true

      Whether the addPermission() call adds any permissions

      +

      Optional Readonlyalias

      alias?: Alias

      Readonlyapp

      app: string

      Readonlyarchitecture

      architecture: Architecture

      The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).

      +

      ReadonlybucketNamePath

      bucketNamePath: undefined | string

      Protected ReadonlycanCreatePermissions

      canCreatePermissions = true

      Whether the addPermission() call adds any permissions

      True for new Lambdas, false for version $LATEST and imported Lambdas from different accounts.

      Optional ReadonlydeadLetterQueue

      deadLetterQueue?: IQueue

      The DLQ (as queue) associated with this Lambda Function (this is an optional attribute).

      @@ -124,7 +124,7 @@ however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

      -

      ReadonlyfileName

      fileName: string

      ReadonlyfunctionArn

      functionArn: string

      ARN of this function

      +

      ReadonlyfileName

      fileName: string

      ReadonlyfunctionArn

      functionArn: string

      ARN of this function

      ReadonlyfunctionName

      functionName: string

      Name of this function

      ReadonlygrantPrincipal

      grantPrincipal: IPrincipal

      The principal this Lambda Function is running as

      Readonlynode

      node: Node

      The tree node.

      @@ -142,7 +142,7 @@

      Readonlyruntime

      runtime: Runtime

      The runtime configured for this lambda.

      Readonlystack

      stack: Stack

      The stack in which this resource is defined.

      Optional Readonlytimeout

      timeout?: Duration

      The timeout configured for this lambda.

      -

      ReadonlywithoutArtifactUpload

      withoutArtifactUpload: boolean

      ReadonlywithoutFilePrefix

      withoutFilePrefix: boolean

      Static Internal_VER_PROPS

      _VER_PROPS: {
          [key: string]: boolean;
      }

      Accessors

      connections

      • get connections(): Connections

      • Access the Connections object

        +

      ReadonlywithoutArtifactUpload

      withoutArtifactUpload: boolean

      ReadonlywithoutFilePrefix

      withoutFilePrefix: boolean

      Static Internal_VER_PROPS

      _VER_PROPS: {
          [key: string]: boolean;
      }

      Accessors

      connections

      • get connections(): Connections

      • Access the Connections object

        Will fail if not a VPC-enabled Lambda Function

        Returns Connections

      currentVersion

      • get currentVersion(): Version

      • Returns a lambda.Version which represents the current version of this Lambda function. A new version will be created every time the function's diff --git a/classes/constructs_loadbalancing.GuApplicationListener.html b/classes/constructs_loadbalancing.GuApplicationListener.html index 152743fe9c..bd1ec9161c 100644 --- a/classes/constructs_loadbalancing.GuApplicationListener.html +++ b/classes/constructs_loadbalancing.GuApplicationListener.html @@ -6,7 +6,7 @@ to reduce the amount of boilerplate needed when configuring your Listener.

        This resource is stateful.

        See

        https://github.com/guardian/cdk/blob/main/docs/stateful-resources.md

        -

      Hierarchy

      • Mixin<typeof ApplicationListener, this> & ApplicationListener<this>
        • GuApplicationListener

      Constructors

      constructor +

      Hierarchy

      • Mixin<typeof ApplicationListener, this> & ApplicationListener<this>
        • GuApplicationListener

      Constructors

      constructor

      Properties

      connections env idWithApp @@ -37,7 +37,7 @@ isConstruct isOwnedResource isResource -

      Constructors

      constructor

      Properties

      Readonlyconnections

      connections: Connections

      Manage connections to this ApplicationListener

      +

      Constructors

      constructor

      Properties

      Readonlyconnections

      connections: Connections

      Manage connections to this ApplicationListener

      Readonlyenv

      env: ResourceEnvironment

      The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), @@ -47,7 +47,7 @@ that might be different than the stack they were imported into.

      ReadonlyidWithApp

      idWithApp: string

      The ID of the construct with the App suffix. This should be used in place of id when trying to reference the construct.

      -

      ReadonlylistenerArn

      listenerArn: string

      Attribute

      ReadonlyloadBalancer

      loadBalancer: IApplicationLoadBalancer

      Load balancer this listener is associated with

      +

      ReadonlylistenerArn

      listenerArn: string

      Attribute

      ReadonlyloadBalancer

      loadBalancer: IApplicationLoadBalancer

      Load balancer this listener is associated with

      Readonlynode

      node: Node

      The tree node.

      Protected ReadonlyphysicalName

      physicalName: string

      Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

      diff --git a/classes/constructs_loadbalancing.GuApplicationLoadBalancer.html b/classes/constructs_loadbalancing.GuApplicationLoadBalancer.html index 807479754d..ee4a1e617a 100644 --- a/classes/constructs_loadbalancing.GuApplicationLoadBalancer.html +++ b/classes/constructs_loadbalancing.GuApplicationLoadBalancer.html @@ -4,7 +4,7 @@ AWS documentation.

      This resource is stateful.

      See

      https://github.com/guardian/cdk/blob/main/docs/stateful-resources.md

      -

      Hierarchy

      • Mixin<typeof ApplicationLoadBalancer, this> & ApplicationLoadBalancer<this>
        • GuApplicationLoadBalancer

      Constructors

      constructor +

      Hierarchy

      • Mixin<typeof ApplicationLoadBalancer, this> & ApplicationLoadBalancer<this>
        • GuApplicationLoadBalancer

      Constructors

      constructor

      Properties

      connections env idWithApp @@ -65,7 +65,7 @@ isConstruct isOwnedResource isResource -

      Constructors

      constructor

      Properties

      Readonlyconnections

      connections: Connections

      The network connections associated with this resource.

      +

      Constructors

      constructor

      Properties

      Readonlyconnections

      connections: Connections

      The network connections associated with this resource.

      Readonlyenv

      env: ResourceEnvironment

      The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), @@ -75,7 +75,7 @@ that might be different than the stack they were imported into.

      ReadonlyidWithApp

      idWithApp: string

      The ID of the construct with the App suffix. This should be used in place of id when trying to reference the construct.

      -

      Optional ReadonlyipAddressType

      ipAddressType?: IpAddressType

      The IP Address Type for this load balancer

      +

      Optional ReadonlyipAddressType

      ipAddressType?: IpAddressType

      The IP Address Type for this load balancer

      Default

      IpAddressType.IPV4
      diff --git a/classes/constructs_loadbalancing.GuApplicationTargetGroup.html b/classes/constructs_loadbalancing.GuApplicationTargetGroup.html index 2377e8ef2a..c5122f64b1 100644 --- a/classes/constructs_loadbalancing.GuApplicationTargetGroup.html +++ b/classes/constructs_loadbalancing.GuApplicationTargetGroup.html @@ -10,7 +10,7 @@

      This resource is stateful.

      See

      https://github.com/guardian/cdk/blob/main/docs/stateful-resources.md

      -

      Hierarchy

      • Mixin<typeof ApplicationTargetGroup, this> & ApplicationTargetGroup<this>
        • GuApplicationTargetGroup

      Constructors

      constructor +

      Hierarchy

      • Mixin<typeof ApplicationTargetGroup, this> & ApplicationTargetGroup<this>
        • GuApplicationTargetGroup

      Constructors

      constructor

      Properties

      defaultPort healthCheck idWithApp @@ -48,11 +48,11 @@ validateTargetGroup fromTargetGroupAttributes isConstruct -

      Constructors

      constructor

      Properties

      Protected ReadonlydefaultPort

      defaultPort: number

      Default port configured for members of this target group

      +

      Constructors

      constructor

      Properties

      Protected ReadonlydefaultPort

      defaultPort: number

      Default port configured for members of this target group

      healthCheck

      healthCheck: HealthCheck

      Health check for the members of this target group

      ReadonlyidWithApp

      idWithApp: string

      The ID of the construct with the App suffix. This should be used in place of id when trying to reference the construct.

      -

      ReadonlyloadBalancerArns

      loadBalancerArns: string

      A token representing a list of ARNs of the load balancers that route traffic to this target group

      +

      ReadonlyloadBalancerArns

      loadBalancerArns: string

      A token representing a list of ARNs of the load balancers that route traffic to this target group

      Protected ReadonlyloadBalancerAttachedDependencies

      loadBalancerAttachedDependencies: DependencyGroup

      Configurable dependable with all resources that lead to load balancer attachment

      Readonlynode

      node: Node

      The tree node.

      ReadonlytargetGroupArn

      targetGroupArn: string

      The ARN of the target group

      @@ -60,7 +60,7 @@

      ReadonlytargetGroupLoadBalancerArns

      targetGroupLoadBalancerArns: string[]

      ARNs of load balancers load balancing to this TargetGroup

      ReadonlytargetGroupName

      targetGroupName: string

      The name of the target group

      Protected OptionaltargetType

      targetType?: TargetType

      The types of the directly registered members of this target group

      -

      StaticDefaultHealthCheck

      DefaultHealthCheck: HealthCheck = ...

      Accessors

      firstLoadBalancerFullName

      • get firstLoadBalancerFullName(): string

      • Full name of first load balancer

        +

      StaticDefaultHealthCheck

      DefaultHealthCheck: HealthCheck = ...

      Accessors

      firstLoadBalancerFullName

      • get firstLoadBalancerFullName(): string

      • Full name of first load balancer

        Returns string

      loadBalancerAttached

      • get loadBalancerAttached(): IDependable

      • List of constructs that need to be depended on to ensure the TargetGroup is associated to a load balancer

        Returns IDependable

      metrics

      • get metrics(): IApplicationTargetGroupMetrics

      • All metrics available for this target group.

        Returns IApplicationTargetGroupMetrics

      Methods

      ProtectedaddLoadBalancerTarget

      • addLoadBalancerTarget(props): void

      • Register the given load balancing target as part of this group

        diff --git a/classes/constructs_loadbalancing.GuHttpsApplicationListener.html b/classes/constructs_loadbalancing.GuHttpsApplicationListener.html index 217699129d..2670416419 100644 --- a/classes/constructs_loadbalancing.GuHttpsApplicationListener.html +++ b/classes/constructs_loadbalancing.GuHttpsApplicationListener.html @@ -1,7 +1,7 @@ GuHttpsApplicationListener | @guardian/cdk

        Class GuHttpsApplicationListener

        Construct which creates a Listener which accepts HTTPS traffic.

        You must pass a [[GuCertificate]] to this Listener via the certificate prop.

        For general details about Listeners, see [[GuApplicationListener]].

        -

        Hierarchy

        • Mixin<typeof ApplicationListener, this> & ApplicationListener<this>
          • GuHttpsApplicationListener

        Constructors

        constructor +

        Hierarchy

        • Mixin<typeof ApplicationListener, this> & ApplicationListener<this>
          • GuHttpsApplicationListener

        Constructors

        constructor

        Properties

        connections env idWithApp @@ -32,7 +32,7 @@ isConstruct isOwnedResource isResource -

        Constructors

        constructor

        Properties

        Readonlyconnections

        connections: Connections

        Manage connections to this ApplicationListener

        +

        Constructors

        constructor

        Properties

        Readonlyconnections

        connections: Connections

        Manage connections to this ApplicationListener

        Readonlyenv

        env: ResourceEnvironment

        The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), @@ -42,7 +42,7 @@ that might be different than the stack they were imported into.

        ReadonlyidWithApp

        idWithApp: string

        The ID of the construct with the App suffix. This should be used in place of id when trying to reference the construct.

        -

        ReadonlylistenerArn

        listenerArn: string

        Attribute

        ReadonlyloadBalancer

        loadBalancer: IApplicationLoadBalancer

        Load balancer this listener is associated with

        +

        ReadonlylistenerArn

        listenerArn: string

        Attribute

        ReadonlyloadBalancer

        loadBalancer: IApplicationLoadBalancer

        Load balancer this listener is associated with

        Readonlynode

        node: Node

        The tree node.

        Protected ReadonlyphysicalName

        physicalName: string

        Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

        diff --git a/classes/constructs_rds.GuDatabaseInstance.html b/classes/constructs_rds.GuDatabaseInstance.html index 85b7645ffb..c0d3694131 100644 --- a/classes/constructs_rds.GuDatabaseInstance.html +++ b/classes/constructs_rds.GuDatabaseInstance.html @@ -1,4 +1,4 @@ -GuDatabaseInstance | @guardian/cdk

        Class GuDatabaseInstance

        Hierarchy

        • Mixin<typeof DatabaseInstance, this> & DatabaseInstance<this>
          • GuDatabaseInstance

        Constructors

        constructor +GuDatabaseInstance | @guardian/cdk

        Class GuDatabaseInstance

        Hierarchy

        • Mixin<typeof DatabaseInstance, this> & DatabaseInstance<this>
          • GuDatabaseInstance

        Constructors

        constructor

        Properties

        cloudwatchLogGroups connections dbInstanceEndpointAddress @@ -44,7 +44,7 @@ isConstruct isOwnedResource isResource -

        Constructors

        constructor

        Properties

        ReadonlycloudwatchLogGroups

        cloudwatchLogGroups: {
            [engine: string]: logs.ILogGroup;
        }

        The log group is created when cloudwatchLogsExports is set.

        +

        Constructors

        constructor

        Properties

        ReadonlycloudwatchLogGroups

        cloudwatchLogGroups: {
            [engine: string]: logs.ILogGroup;
        }

        The log group is created when cloudwatchLogsExports is set.

        Each export value will create a separate log group.

        Readonlyconnections

        connections: Connections

        Access to network connections.

        ReadonlydbInstanceEndpointAddress

        dbInstanceEndpointAddress: string

        ReadonlydbInstanceEndpointPort

        dbInstanceEndpointPort: string

        Protected OptionalenableIamAuthentication

        enableIamAuthentication?: boolean

        Optional Readonlyengine

        engine?: IInstanceEngine

        Readonlyenv

        env: ResourceEnvironment

        The environment this resource belongs to. @@ -56,7 +56,7 @@ that might be different than the stack they were imported into.

        ReadonlyidWithApp

        idWithApp: string

        The ID of the construct with the App suffix. This should be used in place of id when trying to reference the construct.

        -

        ReadonlyinstanceEndpoint

        instanceEndpoint: Endpoint

        ReadonlyinstanceIdentifier

        instanceIdentifier: string

        Optional ReadonlyinstanceResourceId

        instanceResourceId?: string

        Protected ReadonlyinstanceType

        instanceType: InstanceType

        Protected ReadonlynewCfnProps

        newCfnProps: CfnDBInstanceProps

        Readonlynode

        node: Node

        The tree node.

        +

        ReadonlyinstanceEndpoint

        instanceEndpoint: Endpoint

        ReadonlyinstanceIdentifier

        instanceIdentifier: string

        Optional ReadonlyinstanceResourceId

        instanceResourceId?: string

        Protected ReadonlyinstanceType

        instanceType: InstanceType

        Protected ReadonlynewCfnProps

        newCfnProps: CfnDBInstanceProps

        Readonlynode

        node: Node

        The tree node.

        Protected ReadonlyphysicalName

        physicalName: string

        Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

        This value will resolve to one of the following:

        diff --git a/classes/constructs_s3.GuS3Bucket.html b/classes/constructs_s3.GuS3Bucket.html index 5cd414c541..55b4b7d0df 100644 --- a/classes/constructs_s3.GuS3Bucket.html +++ b/classes/constructs_s3.GuS3Bucket.html @@ -1,5 +1,5 @@ GuS3Bucket | @guardian/cdk

        Class GuS3Bucket

        A construct to create a bucket with a "retain" policy to prevent it from being deleted. It will be orphaned instead.

        -

        Hierarchy

        • Mixin<typeof Bucket, this> & Bucket<this>
          • GuS3Bucket

        Constructors

        constructor +

        Hierarchy

        • Mixin<typeof Bucket, this> & Bucket<this>
          • GuS3Bucket

        Constructors

        constructor

        Properties

        autoCreatePolicy bucketArn bucketDomainName @@ -58,7 +58,7 @@ isOwnedResource isResource validateBucketName -

        Constructors

        constructor

        Properties

        ProtectedautoCreatePolicy

        autoCreatePolicy: boolean

        Indicates if a bucket resource policy should automatically created upon +

        Constructors

        constructor

        Properties

        ProtectedautoCreatePolicy

        autoCreatePolicy: boolean

        Indicates if a bucket resource policy should automatically created upon the first call to addToResourcePolicy.

        ReadonlybucketArn

        bucketArn: string

        ReadonlybucketDomainName

        bucketDomainName: string

        ReadonlybucketDualStackDomainName

        bucketDualStackDomainName: string

        ReadonlybucketName

        bucketName: string

        ReadonlybucketRegionalDomainName

        bucketRegionalDomainName: string

        ReadonlybucketWebsiteDomainName

        bucketWebsiteDomainName: string

        ReadonlybucketWebsiteUrl

        bucketWebsiteUrl: string

        Protected OptionaldisallowPublicAccess

        disallowPublicAccess?: boolean

        Whether to disallow public access

        Optional ReadonlyencryptionKey

        encryptionKey?: IKey

        Optional KMS encryption key associated with this bucket.

        @@ -71,7 +71,7 @@ that might be different than the stack they were imported into.

        ReadonlyidWithApp

        idWithApp: string

        The ID of the construct with the App suffix. This should be used in place of id when trying to reference the construct.

        -

        Optional ReadonlyisWebsite

        isWebsite?: boolean

        If this bucket has been configured for static website hosting.

        +

        Optional ReadonlyisWebsite

        isWebsite?: boolean

        If this bucket has been configured for static website hosting.

        Readonlynode

        node: Node

        The tree node.

        Protected OptionalnotificationsHandlerRole

        notificationsHandlerRole?: IRole

        Protected OptionalnotificationsSkipDestinationValidation

        notificationsSkipDestinationValidation?: boolean

        Protected OptionalobjectOwnership

        objectOwnership?: ObjectOwnership

        Protected ReadonlyphysicalName

        physicalName: string

        Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

        diff --git a/classes/constructs_ses.GuEmailIdentity.html b/classes/constructs_ses.GuEmailIdentity.html index d2886c4651..3f0b17bdf4 100644 --- a/classes/constructs_ses.GuEmailIdentity.html +++ b/classes/constructs_ses.GuEmailIdentity.html @@ -7,7 +7,7 @@

        Example

        new GuEmailIdentity(stack, "MyEmailIdentity", {
         domainName: "my-service.gutools.co.uk",
         app: "test",
        });
        -

        Hierarchy

        • Mixin<typeof EmailIdentity, this> & EmailIdentity<this>
          • GuEmailIdentity

        Constructors

        constructor +

        Hierarchy

        • Mixin<typeof EmailIdentity, this> & EmailIdentity<this>
          • GuEmailIdentity

        Constructors

        constructor

        Properties

        dkimDnsTokenName1 dkimDnsTokenName2 dkimDnsTokenName3 @@ -35,7 +35,7 @@ isConstruct isOwnedResource isResource -

        Constructors

        constructor

        Properties

        ReadonlydkimDnsTokenName1

        dkimDnsTokenName1: string

        The host name for the first token that you have to add to the +

      Constructors

      constructor

      Properties

      ReadonlydkimDnsTokenName1

      dkimDnsTokenName1: string

      The host name for the first token that you have to add to the DNS configurationfor your domain

      Attribute

      ReadonlydkimDnsTokenName2

      dkimDnsTokenName2: string

      The host name for the second token that you have to add to the DNS configuration for your domain

      @@ -59,7 +59,7 @@ that might be different than the stack they were imported into.

      ReadonlyidWithApp

      idWithApp: string

      The ID of the construct with the App suffix. This should be used in place of id when trying to reference the construct.

      -

      Readonlynode

      node: Node

      The tree node.

      +

      Readonlynode

      node: Node

      The tree node.

      Protected ReadonlyphysicalName

      physicalName: string

      Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

      This value will resolve to one of the following:

      @@ -70,7 +70,7 @@ cross-environment scenarios.

    Readonlystack

    stack: Stack

    The stack in which this resource is defined.

    -

    Accessors

    StaticvalidDomains

    Methods

    _enableCrossEnvironment

    • _enableCrossEnvironment(): void
    • Internal

      Called when this resource is referenced across environments +

    Accessors

    StaticvalidDomains

    Methods

    _enableCrossEnvironment

    • _enableCrossEnvironment(): void
    • Internal

      Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.

      diff --git a/classes/constructs_vpc.GuVpc.html b/classes/constructs_vpc.GuVpc.html index 25c7b23101..33622be485 100644 --- a/classes/constructs_vpc.GuVpc.html +++ b/classes/constructs_vpc.GuVpc.html @@ -29,7 +29,7 @@ https://github.com/guardian/recommendations/blob/main/AWS.md#vpc

      For more information on VPCs and AWS see: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html.

      -

    Hierarchy

    • Vpc
      • GuVpc

    Constructors

    constructor +

    Hierarchy

    • Vpc
      • GuVpc

    Constructors

    constructor

    Properties

    _vpnGatewayId? availabilityZones dnsHostnamesEnabled @@ -74,7 +74,7 @@ isConstruct isOwnedResource isResource -

    Constructors

    constructor

    Properties

    Protected Optional Internal_vpnGatewayId

    _vpnGatewayId?: string

    Mutable private field for the vpnGatewayId

    +

    Constructors

    constructor

    Properties

    Protected Optional Internal_vpnGatewayId

    _vpnGatewayId?: string

    Mutable private field for the vpnGatewayId

    ReadonlyavailabilityZones

    availabilityZones: string[]

    AZs for this VPC

    ReadonlydnsHostnamesEnabled

    dnsHostnamesEnabled: boolean

    Indicates if instances launched in this VPC will have public DNS hostnames.

    ReadonlydnsSupportEnabled

    dnsSupportEnabled: boolean

    Indicates if DNS support is enabled for this VPC.

    diff --git a/classes/experimental_patterns.GuKinesisLambdaExperimental.html b/classes/experimental_patterns.GuKinesisLambdaExperimental.html index 3ad0670e38..e0c2b70caf 100644 --- a/classes/experimental_patterns.GuKinesisLambdaExperimental.html +++ b/classes/experimental_patterns.GuKinesisLambdaExperimental.html @@ -6,7 +6,7 @@

    The Kinesis stream is stateful, and is accessible via kinesisStream.

    See

    https://github.com/guardian/cdk/blob/main/docs/stateful-resources.md

    This pattern is in early development. The API is likely to change in future releases.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _connections? _functionUrlInvocationGrants _invocationGrants @@ -88,7 +88,7 @@ metricAllInvocations metricAllThrottles metricAllUnreservedConcurrentExecutions -

    Constructors

    constructor

    Properties

    Protected Optional Internal_connections

    _connections?: Connections

    Actual connections object for this Lambda

    +

    Constructors

    constructor

    Properties

    Protected Optional Internal_connections

    _connections?: Connections

    Actual connections object for this Lambda

    May be unset, in which case this Lambda is not configured use in a VPC.

    Protected Internal_functionUrlInvocationGrants

    _functionUrlInvocationGrants: Record<string, Grant>

    Mapping of fucntion URL invocation principals to grants. Used to de-dupe grantInvokeUrl() calls.

    Protected Internal_invocationGrants

    _invocationGrants: Record<string, Grant>

    Mapping of invocation principals to grants. Used to de-dupe grantInvoke() calls.

    @@ -97,8 +97,8 @@ where the user commits to modifying the permisssions on the imported lambda outside CDK.

    Protected Internal_warnIfCurrentVersionCalled

    _warnIfCurrentVersionCalled: boolean

    Flag to delay adding a warning message until current version is invoked.

    -

    Optional Readonly Experimentalalias

    alias?: Alias

    Readonly Experimentalapp

    app: string

    Readonly Experimentalarchitecture

    architecture: Architecture

    The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).

    -

    Readonly ExperimentalbucketNamePath

    bucketNamePath: undefined | string

    Protected Readonly ExperimentalcanCreatePermissions

    canCreatePermissions = true

    Whether the addPermission() call adds any permissions

    +

    Optional Readonly Experimentalalias

    alias?: Alias

    Readonly Experimentalapp

    app: string

    Readonly Experimentalarchitecture

    architecture: Architecture

    The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).

    +

    Readonly ExperimentalbucketNamePath

    bucketNamePath: undefined | string

    Protected Readonly ExperimentalcanCreatePermissions

    canCreatePermissions = true

    Whether the addPermission() call adds any permissions

    True for new Lambdas, false for version $LATEST and imported Lambdas from different accounts.

    Optional Readonly ExperimentaldeadLetterQueue

    deadLetterQueue?: IQueue

    The DLQ (as queue) associated with this Lambda Function (this is an optional attribute).

    @@ -110,10 +110,10 @@ however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

    -

    Readonly ExperimentalfileName

    fileName: string

    Readonly ExperimentalfunctionArn

    functionArn: string

    ARN of this function

    +

    Readonly ExperimentalfileName

    fileName: string

    Readonly ExperimentalfunctionArn

    functionArn: string

    ARN of this function

    Readonly ExperimentalfunctionName

    functionName: string

    Name of this function

    Readonly ExperimentalgrantPrincipal

    grantPrincipal: IPrincipal

    The principal this Lambda Function is running as

    -

    Readonly ExperimentalkinesisStream

    kinesisStream: IStream

    Readonly Experimentalnode

    node: Node

    The tree node.

    +

    Readonly ExperimentalkinesisStream

    kinesisStream: IStream

    Readonly Experimentalnode

    node: Node

    The tree node.

    Readonly ExperimentalpermissionsNode

    permissionsNode: Node

    The construct node where permissions are attached.

    Protected Readonly ExperimentalphysicalName

    physicalName: string

    Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

    @@ -128,7 +128,7 @@

    Readonly Experimentalruntime

    runtime: Runtime

    The runtime configured for this lambda.

    Readonly Experimentalstack

    stack: Stack

    The stack in which this resource is defined.

    Optional Readonly Experimentaltimeout

    timeout?: Duration

    The timeout configured for this lambda.

    -

    Readonly ExperimentalwithoutArtifactUpload

    withoutArtifactUpload: boolean

    Readonly ExperimentalwithoutFilePrefix

    withoutFilePrefix: boolean

    Static Internal_VER_PROPS

    _VER_PROPS: {
        [key: string]: boolean;
    }

    Accessors

    connections

    • get connections(): Connections
    • Experimental

      Access the Connections object

      +

    Readonly ExperimentalwithoutArtifactUpload

    withoutArtifactUpload: boolean

    Readonly ExperimentalwithoutFilePrefix

    withoutFilePrefix: boolean

    Static Internal_VER_PROPS

    _VER_PROPS: {
        [key: string]: boolean;
    }

    Accessors

    connections

    • get connections(): Connections
    • Experimental

      Access the Connections object

      Will fail if not a VPC-enabled Lambda Function

      Returns Connections

    currentVersion

    • get currentVersion(): Version
    • Experimental

      Returns a lambda.Version which represents the current version of this Lambda function. A new version will be created every time the function's diff --git a/classes/experimental_patterns.GuSnsLambdaExperimental.html b/classes/experimental_patterns.GuSnsLambdaExperimental.html index 9b56e4fec1..9c63ad13b6 100644 --- a/classes/experimental_patterns.GuSnsLambdaExperimental.html +++ b/classes/experimental_patterns.GuSnsLambdaExperimental.html @@ -6,7 +6,7 @@

      The SNS topic is stateful, and is accessible via snsTopic.

      See

      https://github.com/guardian/cdk/blob/main/docs/stateful-resources.md

      This pattern is in early development. The API is likely to change in future releases.

      -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _connections? _functionUrlInvocationGrants _invocationGrants @@ -88,7 +88,7 @@ metricAllInvocations metricAllThrottles metricAllUnreservedConcurrentExecutions -

    Constructors

    constructor

    Properties

    Protected Optional Internal_connections

    _connections?: Connections

    Actual connections object for this Lambda

    +

    Constructors

    constructor

    Properties

    Protected Optional Internal_connections

    _connections?: Connections

    Actual connections object for this Lambda

    May be unset, in which case this Lambda is not configured use in a VPC.

    Protected Internal_functionUrlInvocationGrants

    _functionUrlInvocationGrants: Record<string, Grant>

    Mapping of fucntion URL invocation principals to grants. Used to de-dupe grantInvokeUrl() calls.

    Protected Internal_invocationGrants

    _invocationGrants: Record<string, Grant>

    Mapping of invocation principals to grants. Used to de-dupe grantInvoke() calls.

    @@ -97,8 +97,8 @@ where the user commits to modifying the permisssions on the imported lambda outside CDK.

    Protected Internal_warnIfCurrentVersionCalled

    _warnIfCurrentVersionCalled: boolean

    Flag to delay adding a warning message until current version is invoked.

    -

    Optional Readonly Experimentalalias

    alias?: Alias

    Readonly Experimentalapp

    app: string

    Readonly Experimentalarchitecture

    architecture: Architecture

    The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).

    -

    Readonly ExperimentalbucketNamePath

    bucketNamePath: undefined | string

    Protected Readonly ExperimentalcanCreatePermissions

    canCreatePermissions = true

    Whether the addPermission() call adds any permissions

    +

    Optional Readonly Experimentalalias

    alias?: Alias

    Readonly Experimentalapp

    app: string

    Readonly Experimentalarchitecture

    architecture: Architecture

    The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).

    +

    Readonly ExperimentalbucketNamePath

    bucketNamePath: undefined | string

    Protected Readonly ExperimentalcanCreatePermissions

    canCreatePermissions = true

    Whether the addPermission() call adds any permissions

    True for new Lambdas, false for version $LATEST and imported Lambdas from different accounts.

    Optional Readonly ExperimentaldeadLetterQueue

    deadLetterQueue?: IQueue

    The DLQ (as queue) associated with this Lambda Function (this is an optional attribute).

    @@ -110,7 +110,7 @@ however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

    -

    Readonly ExperimentalfileName

    fileName: string

    Readonly ExperimentalfunctionArn

    functionArn: string

    ARN of this function

    +

    Readonly ExperimentalfileName

    fileName: string

    Readonly ExperimentalfunctionArn

    functionArn: string

    ARN of this function

    Readonly ExperimentalfunctionName

    functionName: string

    Name of this function

    Readonly ExperimentalgrantPrincipal

    grantPrincipal: IPrincipal

    The principal this Lambda Function is running as

    Readonly Experimentalnode

    node: Node

    The tree node.

    @@ -126,9 +126,9 @@

    Optional Readonly Experimentalrole

    role?: IRole

    Execution role associated with this function

    Readonly Experimentalruntime

    runtime: Runtime

    The runtime configured for this lambda.

    -

    Readonly ExperimentalsnsTopic

    snsTopic: ITopic

    Readonly Experimentalstack

    stack: Stack

    The stack in which this resource is defined.

    +

    Readonly ExperimentalsnsTopic

    snsTopic: ITopic

    Readonly Experimentalstack

    stack: Stack

    The stack in which this resource is defined.

    Optional Readonly Experimentaltimeout

    timeout?: Duration

    The timeout configured for this lambda.

    -

    Readonly ExperimentalwithoutArtifactUpload

    withoutArtifactUpload: boolean

    Readonly ExperimentalwithoutFilePrefix

    withoutFilePrefix: boolean

    Static Internal_VER_PROPS

    _VER_PROPS: {
        [key: string]: boolean;
    }

    Accessors

    connections

    • get connections(): Connections
    • Experimental

      Access the Connections object

      +

    Readonly ExperimentalwithoutArtifactUpload

    withoutArtifactUpload: boolean

    Readonly ExperimentalwithoutFilePrefix

    withoutFilePrefix: boolean

    Static Internal_VER_PROPS

    _VER_PROPS: {
        [key: string]: boolean;
    }

    Accessors

    connections

    • get connections(): Connections
    • Experimental

      Access the Connections object

      Will fail if not a VPC-enabled Lambda Function

      Returns Connections

    currentVersion

    • get currentVersion(): Version
    • Experimental

      Returns a lambda.Version which represents the current version of this Lambda function. A new version will be created every time the function's diff --git a/classes/patterns.GuApiGatewayWithLambdaByPath.html b/classes/patterns.GuApiGatewayWithLambdaByPath.html index 3cf16f11ff..cee0f55c58 100644 --- a/classes/patterns.GuApiGatewayWithLambdaByPath.html +++ b/classes/patterns.GuApiGatewayWithLambdaByPath.html @@ -9,12 +9,12 @@

      For all API configuration options, see [[GuApiGatewayWithLambdaByPathProps]].

      For details on configuring the individual Lambda functions, see [[GuLambdaFunction]].

      -

    Hierarchy

    • Construct
      • GuApiGatewayWithLambdaByPath

    Constructors

    constructor +

    Hierarchy

    • Construct
      • GuApiGatewayWithLambdaByPath

    Constructors

    constructor

    Properties

    api node

    Methods

    toString isConstruct -

    Constructors

    constructor

    Properties

    Readonlyapi

    api: RestApi

    Readonlynode

    node: Node

    The tree node.

    +

    Constructors

    constructor

    Properties

    Readonlyapi

    api: RestApi

    Readonlynode

    node: Node

    The tree node.

    Methods

    toString

    • toString(): string

    • Returns a string representation of this construct.

      Returns string

    StaticisConstruct

    • isConstruct(x): x is Construct

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct diff --git a/classes/patterns.GuApiLambda.html b/classes/patterns.GuApiLambda.html index 35aeb4c2e2..34e2f4e318 100644 --- a/classes/patterns.GuApiLambda.html +++ b/classes/patterns.GuApiLambda.html @@ -9,7 +9,7 @@ 

      new GuApiLambda(stack, "my-lambda", {
        fileName: "my-app.zip",
        handler: "handler.ts",
        runtime: Runtime.NODEJS_14_X,
        monitoringConfiguration: {
          http5xxAlarm: { tolerated5xxPercentage: 5 },
          snsTopicName: "alerts-topic",
        },
        app: "my-app",
        api: {
          id: "my-api",
          description: "...",
        },
      });
      -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _connections? _functionUrlInvocationGrants _invocationGrants @@ -91,7 +91,7 @@ metricAllInvocations metricAllThrottles metricAllUnreservedConcurrentExecutions -

    Constructors

    constructor

    Properties

    Protected Optional Internal_connections

    _connections?: Connections

    Actual connections object for this Lambda

    +

    Constructors

    constructor

    Properties

    Protected Optional Internal_connections

    _connections?: Connections

    Actual connections object for this Lambda

    May be unset, in which case this Lambda is not configured use in a VPC.

    Protected Internal_functionUrlInvocationGrants

    _functionUrlInvocationGrants: Record<string, Grant>

    Mapping of fucntion URL invocation principals to grants. Used to de-dupe grantInvokeUrl() calls.

    Protected Internal_invocationGrants

    _invocationGrants: Record<string, Grant>

    Mapping of invocation principals to grants. Used to de-dupe grantInvoke() calls.

    @@ -100,8 +100,8 @@ where the user commits to modifying the permisssions on the imported lambda outside CDK.

    Protected Internal_warnIfCurrentVersionCalled

    _warnIfCurrentVersionCalled: boolean

    Flag to delay adding a warning message until current version is invoked.

    -

    Optional Readonlyalias

    alias?: Alias

    Readonlyapi

    api: LambdaRestApi

    Readonlyapp

    app: string

    Readonlyarchitecture

    architecture: Architecture

    The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).

    -

    ReadonlybucketNamePath

    bucketNamePath: undefined | string

    Protected ReadonlycanCreatePermissions

    canCreatePermissions = true

    Whether the addPermission() call adds any permissions

    +

    Optional Readonlyalias

    alias?: Alias

    Readonlyapi

    api: LambdaRestApi

    Readonlyapp

    app: string

    Readonlyarchitecture

    architecture: Architecture

    The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).

    +

    ReadonlybucketNamePath

    bucketNamePath: undefined | string

    Protected ReadonlycanCreatePermissions

    canCreatePermissions = true

    Whether the addPermission() call adds any permissions

    True for new Lambdas, false for version $LATEST and imported Lambdas from different accounts.

    Optional ReadonlydeadLetterQueue

    deadLetterQueue?: IQueue

    The DLQ (as queue) associated with this Lambda Function (this is an optional attribute).

    @@ -113,7 +113,7 @@ however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

    -

    ReadonlyfileName

    fileName: string

    ReadonlyfunctionArn

    functionArn: string

    ARN of this function

    +

    ReadonlyfileName

    fileName: string

    ReadonlyfunctionArn

    functionArn: string

    ARN of this function

    ReadonlyfunctionName

    functionName: string

    Name of this function

    ReadonlygrantPrincipal

    grantPrincipal: IPrincipal

    The principal this Lambda Function is running as

    Readonlynode

    node: Node

    The tree node.

    @@ -131,7 +131,7 @@

    Readonlyruntime

    runtime: Runtime

    The runtime configured for this lambda.

    Readonlystack

    stack: Stack

    The stack in which this resource is defined.

    Optional Readonlytimeout

    timeout?: Duration

    The timeout configured for this lambda.

    -

    ReadonlywithoutArtifactUpload

    withoutArtifactUpload: boolean

    ReadonlywithoutFilePrefix

    withoutFilePrefix: boolean

    Static Internal_VER_PROPS

    _VER_PROPS: {
        [key: string]: boolean;
    }

    Accessors

    connections

    • get connections(): Connections

    • Access the Connections object

      +

    ReadonlywithoutArtifactUpload

    withoutArtifactUpload: boolean

    ReadonlywithoutFilePrefix

    withoutFilePrefix: boolean

    Static Internal_VER_PROPS

    _VER_PROPS: {
        [key: string]: boolean;
    }

    Accessors

    connections

    • get connections(): Connections

    • Access the Connections object

      Will fail if not a VPC-enabled Lambda Function

      Returns Connections

    currentVersion

    • get currentVersion(): Version

    • Returns a lambda.Version which represents the current version of this Lambda function. A new version will be created every time the function's diff --git a/classes/patterns.GuEc2App.html b/classes/patterns.GuEc2App.html index 41422fd136..792c7f2fec 100644 --- a/classes/patterns.GuEc2App.html +++ b/classes/patterns.GuEc2App.html @@ -2,7 +2,7 @@ behind a load balancer. For convenience, you may wish to use [[GuPlayApp]] or [[GuNodeApp]], which extend this class.

      See props for further details.

      -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    autoScalingGroup certificate? listener @@ -12,8 +12,8 @@ vpc

    Methods

    toString isConstruct -

    Constructors

    constructor

    Properties

    ReadonlyautoScalingGroup

    autoScalingGroup: GuAutoScalingGroup

    Optional Readonlycertificate

    certificate?: GuCertificate

    Readonlylistener

    listener: GuHttpsApplicationListener

    ReadonlyloadBalancer

    loadBalancer: GuApplicationLoadBalancer

    Readonlynode

    node: Node

    The tree node.

    -

    ReadonlytargetGroup

    targetGroup: GuApplicationTargetGroup

    Readonlyvpc

    vpc: IVpc

    Methods

    toString

    • toString(): string

    • Returns a string representation of this construct.

      +

    Constructors

    constructor

    Properties

    ReadonlyautoScalingGroup

    autoScalingGroup: GuAutoScalingGroup

    Optional Readonlycertificate

    certificate?: GuCertificate

    Readonlylistener

    listener: GuHttpsApplicationListener

    ReadonlyloadBalancer

    loadBalancer: GuApplicationLoadBalancer

    Readonlynode

    node: Node

    The tree node.

    +

    ReadonlytargetGroup

    targetGroup: GuApplicationTargetGroup

    Readonlyvpc

    vpc: IVpc

    Methods

    toString

    • toString(): string

    • Returns a string representation of this construct.

      Returns string

    StaticisConstruct

    PUBLIC

    PUBLIC

    For when you want your application to be accessible to the world (0.0.0.0/0).

    +

    RESTRICTED

    RESTRICTED

    For when you want to restrict your application's access to a list of CIDR ranges.

    +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/constructs_dns.RecordType.html b/enums/constructs_dns.RecordType.html index 659e8b172f..ee2f2791c4 100644 --- a/enums/constructs_dns.RecordType.html +++ b/enums/constructs_dns.RecordType.html @@ -1,2 +1,2 @@ -RecordType | @guardian/cdk

    Enumeration RecordType

    Enumeration Members

    CNAME -

    Enumeration Members

    CNAME

    CNAME

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +RecordType | @guardian/cdk

    Enumeration RecordType

    Enumeration Members

    CNAME +

    Enumeration Members

    CNAME

    CNAME

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/constructs_ec2.SubnetType.html b/enums/constructs_ec2.SubnetType.html index 8572fe07b7..bd9fa33336 100644 --- a/enums/constructs_ec2.SubnetType.html +++ b/enums/constructs_ec2.SubnetType.html @@ -1,3 +1,3 @@ -SubnetType | @guardian/cdk

    Enumeration SubnetType

    Enumeration Members

    PRIVATE +SubnetType | @guardian/cdk

    Enumeration SubnetType

    Enumeration Members

    PRIVATE PUBLIC -

    Enumeration Members

    PRIVATE

    PRIVATE

    PUBLIC

    PUBLIC

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    PRIVATE

    PRIVATE

    PUBLIC

    PUBLIC

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/functions/constants.getDependency.html b/functions/constants.getDependency.html index b4b3862906..6a171e799a 100644 --- a/functions/constants.getDependency.html +++ b/functions/constants.getDependency.html @@ -1 +1 @@ -getDependency | @guardian/cdk

    Function getDependency

    Settings

    Member Visibility
    +getDependency | @guardian/cdk

    Function getDependency

    Settings

    Member Visibility
    diff --git a/functions/constants.getDevDependency.html b/functions/constants.getDevDependency.html index aeb16ebb28..cef2631717 100644 --- a/functions/constants.getDevDependency.html +++ b/functions/constants.getDevDependency.html @@ -1 +1 @@ -getDevDependency | @guardian/cdk

    Function getDevDependency

    Settings

    Member Visibility
    +getDevDependency | @guardian/cdk

    Function getDevDependency

    Settings

    Member Visibility
    diff --git a/functions/constructs_ec2.maybeApp.html b/functions/constructs_ec2.maybeApp.html index 832ff2f02b..0d5282a8e2 100644 --- a/functions/constructs_ec2.maybeApp.html +++ b/functions/constructs_ec2.maybeApp.html @@ -1 +1 @@ -maybeApp | @guardian/cdk

    Function maybeApp

    • maybeApp(props?): string

    • Parameters

      • Optionalprops: {
            app?: string;
        }
        • Optionalapp?: string

      Returns string

    Settings

    Member Visibility
    +maybeApp | @guardian/cdk

    Function maybeApp

    • maybeApp(props?): string

    • Parameters

      • Optionalprops: {
            app?: string;
        }
        • Optionalapp?: string

      Returns string

    Settings

    Member Visibility
    diff --git a/functions/utils_lambda.toAwsErrorHandlingProps.html b/functions/utils_lambda.toAwsErrorHandlingProps.html index ac83aa15ca..936d72150d 100644 --- a/functions/utils_lambda.toAwsErrorHandlingProps.html +++ b/functions/utils_lambda.toAwsErrorHandlingProps.html @@ -1 +1 @@ -toAwsErrorHandlingProps | @guardian/cdk

    Function toAwsErrorHandlingProps

    Settings

    Member Visibility
    +toAwsErrorHandlingProps | @guardian/cdk

    Function toAwsErrorHandlingProps

    Settings

    Member Visibility
    diff --git a/functions/utils_security_groups.transformToSecurityGroupAccessRule.html b/functions/utils_security_groups.transformToSecurityGroupAccessRule.html index b900150b31..aa777d001c 100644 --- a/functions/utils_security_groups.transformToSecurityGroupAccessRule.html +++ b/functions/utils_security_groups.transformToSecurityGroupAccessRule.html @@ -1 +1 @@ -transformToSecurityGroupAccessRule | @guardian/cdk

    Function transformToSecurityGroupAccessRule

    Settings

    Member Visibility
    +transformToSecurityGroupAccessRule | @guardian/cdk

    Function transformToSecurityGroupAccessRule

    Settings

    Member Visibility
    diff --git a/functions/utils_test.attachPolicyToTestRole.html b/functions/utils_test.attachPolicyToTestRole.html index b5ccbf7a41..afb506ef42 100644 --- a/functions/utils_test.attachPolicyToTestRole.html +++ b/functions/utils_test.attachPolicyToTestRole.html @@ -1 +1 @@ -attachPolicyToTestRole | @guardian/cdk

    Function attachPolicyToTestRole

    Settings

    Member Visibility
    +attachPolicyToTestRole | @guardian/cdk

    Function attachPolicyToTestRole

    Settings

    Member Visibility
    diff --git a/functions/utils_test.getTemplateAfterAspectInvocation.html b/functions/utils_test.getTemplateAfterAspectInvocation.html index e30d758704..f9c467ac7d 100644 --- a/functions/utils_test.getTemplateAfterAspectInvocation.html +++ b/functions/utils_test.getTemplateAfterAspectInvocation.html @@ -2,4 +2,4 @@ This means we must synth the stack to see the results of the Aspect.

    Parameters

    • stack: GuStack

      the stack to synthesise

    Returns Template

    See

    https://github.com/aws/aws-cdk/issues/29047

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/utils_test.simpleGuStackForTesting.html b/functions/utils_test.simpleGuStackForTesting.html index 3d1f3190c1..208fdecb8b 100644 --- a/functions/utils_test.simpleGuStackForTesting.html +++ b/functions/utils_test.simpleGuStackForTesting.html @@ -1 +1 @@ -simpleGuStackForTesting | @guardian/cdk

    Function simpleGuStackForTesting

    Settings

    Member Visibility
    +simpleGuStackForTesting | @guardian/cdk

    Function simpleGuStackForTesting

    Settings

    Member Visibility
    diff --git a/interfaces/constants.SsmParameterPath.html b/interfaces/constants.SsmParameterPath.html index b9c6b3b654..d171fbfa2f 100644 --- a/interfaces/constants.SsmParameterPath.html +++ b/interfaces/constants.SsmParameterPath.html @@ -1,5 +1,5 @@ -SsmParameterPath | @guardian/cdk

    Interface SsmParameterPath

    interface SsmParameterPath {
        description: string;
        namingPattern?: string;
        optional?: boolean;
        path: string;
    }

    Properties

    description +SsmParameterPath | @guardian/cdk

    Interface SsmParameterPath

    interface SsmParameterPath {
        description: string;
        namingPattern?: string;
        optional?: boolean;
        path: string;
    }

    Properties

    description namingPattern? optional? path -

    Properties

    description

    description: string

    OptionalnamingPattern

    namingPattern?: string

    Optionaloptional

    optional?: boolean

    path

    path: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    description

    description: string

    OptionalnamingPattern

    namingPattern?: string

    Optionaloptional

    optional?: boolean

    path

    path: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_autoscaling.GuAutoScalingGroupProps.html b/interfaces/constructs_autoscaling.GuAutoScalingGroupProps.html index 7b56a1b5cf..4ee50154f3 100644 --- a/interfaces/constructs_autoscaling.GuAutoScalingGroupProps.html +++ b/interfaces/constructs_autoscaling.GuAutoScalingGroupProps.html @@ -1,4 +1,4 @@ -GuAutoScalingGroupProps | @guardian/cdk

    Interface GuAutoScalingGroupProps

    interface GuAutoScalingGroupProps {
        additionalSecurityGroups?: ISecurityGroup[];
        allowAllOutbound?: boolean;
        app: string;
        associatePublicIpAddress?: boolean;
        autoScalingGroupName?: string;
        blockDevices?: BlockDevice[];
        capacityRebalance?: boolean;
        cooldown?: Duration;
        defaultInstanceWarmup?: Duration;
        enabledDetailedInstanceMonitoring?: boolean;
        groupMetrics?: GroupMetrics[];
        healthCheck?: HealthCheck;
        httpPutResponseHopLimit?: number;
        ignoreUnmodifiedSizeProperties?: boolean;
        imageId?: GuAmiParameter;
        imageRecipe?: string | AmigoProps;
        init?: CloudFormationInit;
        initOptions?: ApplyCloudFormationInitOptions;
        instanceMonitoring?: Monitoring;
        instanceType: InstanceType;
        keyName?: string;
        keyPair?: IKeyPair;
        launchTemplate?: ILaunchTemplate;
        maxHealthyPercentage?: number;
        maximumInstances?: number;
        maxInstanceLifetime?: Duration;
        minHealthyPercentage?: number;
        minimumInstances: number;
        mixedInstancesPolicy?: MixedInstancesPolicy;
        newInstancesProtectedFromScaleIn?: boolean;
        notifications?: NotificationConfiguration[];
        role?: IRole;
        signals?: Signals;
        spotPrice?: string;
        ssmSessionPermissions?: boolean;
        targetGroup?: ApplicationTargetGroup;
        terminationPolicies?: TerminationPolicy[];
        terminationPolicyCustomLambdaFunctionArn?: string;
        updatePolicy?: UpdatePolicy;
        userData: UserData;
        vpc: IVpc;
        vpcSubnets?: SubnetSelection;
        withoutImdsv2?: boolean;
    }

    Hierarchy (view full)

    • Omit<AutoScalingGroupProps,
          | "imageId"
          | "osType"
          | "machineImage"
          | "userData"
          | "minCapacity"
          | "maxCapacity"
          | "desiredCapacity"
          | "requireImdsv2"
          | "securityGroup">
    • AppIdentity
    • GuAsgCapacity
      • GuAutoScalingGroupProps

    Properties

    additionalSecurityGroups? +GuAutoScalingGroupProps | @guardian/cdk

    Interface GuAutoScalingGroupProps

    interface GuAutoScalingGroupProps {
        additionalSecurityGroups?: ISecurityGroup[];
        allowAllOutbound?: boolean;
        app: string;
        associatePublicIpAddress?: boolean;
        autoScalingGroupName?: string;
        blockDevices?: BlockDevice[];
        capacityRebalance?: boolean;
        cooldown?: Duration;
        defaultInstanceWarmup?: Duration;
        enabledDetailedInstanceMonitoring?: boolean;
        groupMetrics?: GroupMetrics[];
        healthCheck?: HealthCheck;
        httpPutResponseHopLimit?: number;
        ignoreUnmodifiedSizeProperties?: boolean;
        imageId?: GuAmiParameter;
        imageRecipe?: string | AmigoProps;
        init?: CloudFormationInit;
        initOptions?: ApplyCloudFormationInitOptions;
        instanceMonitoring?: Monitoring;
        instanceType: InstanceType;
        keyName?: string;
        keyPair?: IKeyPair;
        launchTemplate?: ILaunchTemplate;
        maxHealthyPercentage?: number;
        maximumInstances?: number;
        maxInstanceLifetime?: Duration;
        minHealthyPercentage?: number;
        minimumInstances: number;
        mixedInstancesPolicy?: MixedInstancesPolicy;
        newInstancesProtectedFromScaleIn?: boolean;
        notifications?: NotificationConfiguration[];
        role?: IRole;
        signals?: Signals;
        spotPrice?: string;
        ssmSessionPermissions?: boolean;
        targetGroup?: ApplicationTargetGroup;
        terminationPolicies?: TerminationPolicy[];
        terminationPolicyCustomLambdaFunctionArn?: string;
        updatePolicy?: UpdatePolicy;
        userData: UserData;
        vpc: IVpc;
        vpcSubnets?: SubnetSelection;
        withoutImdsv2?: boolean;
    }

    Hierarchy (view full)

    • Omit<AutoScalingGroupProps,
          | "imageId"
          | "osType"
          | "machineImage"
          | "userData"
          | "minCapacity"
          | "maxCapacity"
          | "desiredCapacity"
          | "requireImdsv2"
          | "securityGroup">
    • AppIdentity
    • GuAsgCapacity
      • GuAutoScalingGroupProps

    Properties

    additionalSecurityGroups? allowAllOutbound? app associatePublicIpAddress? @@ -41,11 +41,11 @@ vpc vpcSubnets? withoutImdsv2? -

    Properties

    OptionaladditionalSecurityGroups

    additionalSecurityGroups?: ISecurityGroup[]

    Optional ReadonlyallowAllOutbound

    allowAllOutbound?: boolean

    Whether the instances can initiate connections to anywhere by default

    +

    Properties

    OptionaladditionalSecurityGroups

    additionalSecurityGroups?: ISecurityGroup[]

    Optional ReadonlyallowAllOutbound

    allowAllOutbound?: boolean

    Whether the instances can initiate connections to anywhere by default

    Default

    true
    -

    app

    app: string

    Optional ReadonlyassociatePublicIpAddress

    associatePublicIpAddress?: boolean

    Whether instances in the Auto Scaling Group should have public +

    app

    app: string

    Optional ReadonlyassociatePublicIpAddress

    associatePublicIpAddress?: boolean

    Whether instances in the Auto Scaling Group should have public IP addresses associated with them.

    launchTemplate and mixedInstancesPolicy must not be specified when this property is specified

    Default

    - Use subnet setting.
@@ -87,7 +87,7 @@

    Default

    None
    -

    OptionalenabledDetailedInstanceMonitoring

    enabledDetailedInstanceMonitoring?: boolean

    Optional ReadonlygroupMetrics

    groupMetrics?: GroupMetrics[]

    Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. +

    OptionalenabledDetailedInstanceMonitoring

    enabledDetailedInstanceMonitoring?: boolean

    Optional ReadonlygroupMetrics

    groupMetrics?: GroupMetrics[]

    Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. To report all group metrics use GroupMetrics.all() Group metrics are reported in a granularity of 1 minute at no additional charge.

    Default

    - no group metrics will be reported
@@ -97,7 +97,7 @@

    Default

    - HealthCheck.ec2 with no grace period
    -

    OptionalhttpPutResponseHopLimit

    httpPutResponseHopLimit?: number

    Optional ReadonlyignoreUnmodifiedSizeProperties

    ignoreUnmodifiedSizeProperties?: boolean

    If the ASG has scheduled actions, don't reset unchanged group sizes

    +

    OptionalhttpPutResponseHopLimit

    httpPutResponseHopLimit?: number

    Optional ReadonlyignoreUnmodifiedSizeProperties

    ignoreUnmodifiedSizeProperties?: boolean

    If the ASG has scheduled actions, don't reset unchanged group sizes

    Only used if the ASG has scheduled actions (which may scale your ASG up or down regardless of cdk deployments). If true, the size of the group will only be reset if it has been changed in the CDK app. If false, the @@ -109,10 +109,10 @@

    OptionalimageId

    imageId?: GuAmiParameter

    Deprecated

    It shouldn't be necessary to specify a value here. GuCDK will create an AMI parameter by default. Riff-Raff can use this parameter to inject the latest AMI ID for your AMIgo recipe.

    -

    OptionalimageRecipe

    imageRecipe?: string | AmigoProps

    If you are using GuCDK to generate your riff-raff.yaml file, specify AMIgo props here. +

    OptionalimageRecipe

    imageRecipe?: string | AmigoProps

    If you are using GuCDK to generate your riff-raff.yaml file, specify AMIgo props here. If you are using a hardcoded riff-raff.yaml file (usually found in project root) then providing a value here has no effect.

    -

    Optional Readonlyinit

    init?: CloudFormationInit

    Apply the given CloudFormation Init configuration to the instances in the AutoScalingGroup at startup

    +

    Optional Readonlyinit

    init?: CloudFormationInit

    Apply the given CloudFormation Init configuration to the instances in the AutoScalingGroup at startup

    If you specify init, you must also specify signals to configure the number of instances to wait for and the timeout for waiting for the init process.

    @@ -137,7 +137,7 @@

    Default

    - Do not provide any instance type
    -

    Optional ReadonlykeyName

    keyName?: string

    Name of SSH keypair to grant access to instances

    +

    Optional ReadonlykeyName

    keyName?: string

    Name of SSH keypair to grant access to instances

    launchTemplate and mixedInstancesPolicy must not be specified when this property is specified

    You can either specify keyPair or keyName, not both.

    Default

    - No SSH access will be possible.
@@ -177,7 +177,7 @@
 
    Should only be set if you need to scale beyond the default limit (e.g. due to heavy traffic),
 or restrict scaling for a specific reason.
    
 
    Note: If minimumInstances is defined with a Mapping maximumInstances must also be defined as a Mapping.
    
-

    Optional ReadonlymaxInstanceLifetime

    maxInstanceLifetime?: Duration

    The maximum amount of time that an instance can be in service. The maximum duration applies +

    Optional ReadonlymaxInstanceLifetime

    maxInstanceLifetime?: Duration

    The maximum amount of time that an instance can be in service. The maximum duration applies to all current and future instances in the group. As an instance approaches its maximum duration, it is terminated and replaced, and cannot be used again.

    You must specify a value of at least 604,800 seconds (7 days). To clear a previously set value, @@ -200,7 +200,7 @@

    minimumInstances

    minimumInstances: number

    The number of EC2 instances running under normal circumstances, i.e. when there are no deployment or scaling events in progress.

    -

    Optional ReadonlymixedInstancesPolicy

    mixedInstancesPolicy?: MixedInstancesPolicy

    Mixed Instances Policy to use.

    +

    Optional ReadonlymixedInstancesPolicy

    mixedInstancesPolicy?: MixedInstancesPolicy

    Mixed Instances Policy to use.

    Launch configuration related settings and Launch Template must not be specified when a MixedInstancesPolicy is specified.

    Default

    - Do not provide any MixedInstancesPolicy
@@ -264,7 +264,7 @@

    Default

    false
    -

    OptionaltargetGroup

    targetGroup?: ApplicationTargetGroup

    Optional ReadonlyterminationPolicies

    terminationPolicies?: TerminationPolicy[]

    A policy or a list of policies that are used to select the instances to +

    OptionaltargetGroup

    targetGroup?: ApplicationTargetGroup

    Optional ReadonlyterminationPolicies

    terminationPolicies?: TerminationPolicy[]

    A policy or a list of policies that are used to select the instances to terminate. The policies are executed in the order that you list them.

    See

    https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html

    Default

      @@ -286,9 +286,9 @@

    Default

    • UpdatePolicy.rollingUpdate() if using init, UpdatePolicy.none() otherwise
    -

    userData

    userData: UserData

    Readonlyvpc

    vpc: IVpc

    VPC to launch these instances in.

    +

    userData

    userData: UserData

    Readonlyvpc

    vpc: IVpc

    VPC to launch these instances in.

    Optional ReadonlyvpcSubnets

    vpcSubnets?: SubnetSelection

    Where to place instances within the VPC

    Default

    - All Private subnets.
    -

    OptionalwithoutImdsv2

    withoutImdsv2?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalwithoutImdsv2

    withoutImdsv2?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_autoscaling.GuUserDataProps.html b/interfaces/constructs_autoscaling.GuUserDataProps.html index 1bce255151..6b2e4fd905 100644 --- a/interfaces/constructs_autoscaling.GuUserDataProps.html +++ b/interfaces/constructs_autoscaling.GuUserDataProps.html @@ -1,3 +1,3 @@ -GuUserDataProps | @guardian/cdk

    Interface GuUserDataProps

    interface GuUserDataProps {
        configuration?: GuPrivateS3ConfigurationProps;
        distributable: GuDistributableForEc2;
    }

    Properties

    configuration? +GuUserDataProps | @guardian/cdk

    Interface GuUserDataProps

    interface GuUserDataProps {
        configuration?: GuPrivateS3ConfigurationProps;
        distributable: GuDistributableForEc2;
    }

    Properties

    configuration? distributable -

    Properties

    Optionalconfiguration

    configuration?: GuPrivateS3ConfigurationProps

    distributable

    distributable: GuDistributableForEc2

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalconfiguration

    configuration?: GuPrivateS3ConfigurationProps

    distributable

    distributable: GuDistributableForEc2

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_cloudwatch.GuAlarmProps.html b/interfaces/constructs_cloudwatch.GuAlarmProps.html index 651cb45b81..7dc0398641 100644 --- a/interfaces/constructs_cloudwatch.GuAlarmProps.html +++ b/interfaces/constructs_cloudwatch.GuAlarmProps.html @@ -1,4 +1,4 @@ -GuAlarmProps | @guardian/cdk

    Interface GuAlarmProps

    interface GuAlarmProps {
        actionsEnabled?: boolean;
        alarmDescription?: string;
        alarmName?: string;
        app: string;
        comparisonOperator?: ComparisonOperator;
        datapointsToAlarm?: number;
        evaluateLowSampleCountPercentile?: string;
        evaluationPeriods: number;
        metric: IMetric;
        okAction?: boolean;
        snsTopicName: string;
        threshold: number;
        treatMissingData?: TreatMissingData;
    }

    Hierarchy (view full)

    Properties

    actionsEnabled? +GuAlarmProps | @guardian/cdk

    Interface GuAlarmProps

    interface GuAlarmProps {
        actionsEnabled?: boolean;
        alarmDescription?: string;
        alarmName?: string;
        app: string;
        comparisonOperator?: ComparisonOperator;
        datapointsToAlarm?: number;
        evaluateLowSampleCountPercentile?: string;
        evaluationPeriods: number;
        metric: IMetric;
        okAction?: boolean;
        snsTopicName: string;
        threshold: number;
        treatMissingData?: TreatMissingData;
    }

    Hierarchy (view full)

    Properties

    actionsEnabled? alarmDescription? alarmName? app @@ -23,7 +23,7 @@

    Default

    Automatically generated name
    -

    app

    app: string

    Optional ReadonlycomparisonOperator

    comparisonOperator?: ComparisonOperator

    Comparison to use to check if metric is breaching

    +

    app

    app: string

    Optional ReadonlycomparisonOperator

    comparisonOperator?: ComparisonOperator

    Comparison to use to check if metric is breaching

    Default

    GreaterThanOrEqualToThreshold
    @@ -41,7 +41,7 @@

    Readonlymetric

    metric: IMetric

    The metric to add the alarm on

    Metric objects can be obtained from most resources, or you can construct custom Metric objects by instantiating one.

    -

    OptionalokAction

    okAction?: boolean

    snsTopicName

    snsTopicName: string

    Readonlythreshold

    threshold: number

    The value against which the specified statistic is compared.

    +

    OptionalokAction

    okAction?: boolean

    snsTopicName

    snsTopicName: string

    Readonlythreshold

    threshold: number

    The value against which the specified statistic is compared.

    Optional ReadonlytreatMissingData

    treatMissingData?: TreatMissingData

    Sets how this alarm is to handle missing data points.

    Default

    TreatMissingData.Missing
    diff --git a/interfaces/constructs_cloudwatch.GuLambdaErrorPercentageMonitoringProps.html b/interfaces/constructs_cloudwatch.GuLambdaErrorPercentageMonitoringProps.html index 2c1d5b8c79..a37e62e020 100644 --- a/interfaces/constructs_cloudwatch.GuLambdaErrorPercentageMonitoringProps.html +++ b/interfaces/constructs_cloudwatch.GuLambdaErrorPercentageMonitoringProps.html @@ -1,4 +1,4 @@ -GuLambdaErrorPercentageMonitoringProps | @guardian/cdk

    Interface GuLambdaErrorPercentageMonitoringProps

    interface GuLambdaErrorPercentageMonitoringProps {
        actionsEnabled?: boolean;
        alarmDescription?: string;
        alarmName?: string;
        datapointsToAlarm?: number;
        evaluateLowSampleCountPercentile?: string;
        lengthOfEvaluationPeriod?: Duration;
        noMonitoring?: false;
        numberOfEvaluationPeriodsAboveThresholdBeforeAlarm?: number;
        okAction?: boolean;
        snsTopicName: string;
        toleratedErrorPercentage: number;
    }

    Hierarchy

    • Omit<GuAlarmProps,
          | "metric"
          | "threshold"
          | "comparisonOperator"
          | "evaluationPeriods"
          | "treatMissingData"
          | "app">
      • GuLambdaErrorPercentageMonitoringProps

    Properties

    actionsEnabled? +GuLambdaErrorPercentageMonitoringProps | @guardian/cdk

    Interface GuLambdaErrorPercentageMonitoringProps

    interface GuLambdaErrorPercentageMonitoringProps {
        actionsEnabled?: boolean;
        alarmDescription?: string;
        alarmName?: string;
        datapointsToAlarm?: number;
        evaluateLowSampleCountPercentile?: string;
        lengthOfEvaluationPeriod?: Duration;
        noMonitoring?: false;
        numberOfEvaluationPeriodsAboveThresholdBeforeAlarm?: number;
        okAction?: boolean;
        snsTopicName: string;
        toleratedErrorPercentage: number;
    }

    Hierarchy

    • Omit<GuAlarmProps,
          | "metric"
          | "threshold"
          | "comparisonOperator"
          | "evaluationPeriods"
          | "treatMissingData"
          | "app">
      • GuLambdaErrorPercentageMonitoringProps

    Properties

    actionsEnabled? alarmDescription? alarmName? datapointsToAlarm? @@ -31,4 +31,4 @@

    Default

    - Not configured.
    -

    OptionallengthOfEvaluationPeriod

    lengthOfEvaluationPeriod?: Duration

    OptionalnoMonitoring

    noMonitoring

    OptionalnumberOfEvaluationPeriodsAboveThresholdBeforeAlarm

    numberOfEvaluationPeriodsAboveThresholdBeforeAlarm?: number

    OptionalokAction

    okAction?: boolean

    snsTopicName

    snsTopicName: string

    toleratedErrorPercentage

    toleratedErrorPercentage: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionallengthOfEvaluationPeriod

    lengthOfEvaluationPeriod?: Duration

    OptionalnoMonitoring

    noMonitoring

    OptionalnumberOfEvaluationPeriodsAboveThresholdBeforeAlarm

    numberOfEvaluationPeriodsAboveThresholdBeforeAlarm?: number

    OptionalokAction

    okAction?: boolean

    snsTopicName

    snsTopicName: string

    toleratedErrorPercentage

    toleratedErrorPercentage: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_cloudwatch.GuLambdaThrottlingMonitoringProps.html b/interfaces/constructs_cloudwatch.GuLambdaThrottlingMonitoringProps.html index 392e8d86fe..2ef1f52db2 100644 --- a/interfaces/constructs_cloudwatch.GuLambdaThrottlingMonitoringProps.html +++ b/interfaces/constructs_cloudwatch.GuLambdaThrottlingMonitoringProps.html @@ -1,4 +1,4 @@ -GuLambdaThrottlingMonitoringProps | @guardian/cdk

    Interface GuLambdaThrottlingMonitoringProps

    interface GuLambdaThrottlingMonitoringProps {
        actionsEnabled?: boolean;
        alarmDescription?: string;
        alarmName?: string;
        datapointsToAlarm?: number;
        evaluateLowSampleCountPercentile?: string;
        noMonitoring?: false;
        numberOfMinutesAboveThresholdBeforeAlarm?: number;
        okAction?: boolean;
        snsTopicName: string;
        toleratedThrottlingCount?: number;
    }

    Hierarchy

    • Omit<GuAlarmProps,
          | "metric"
          | "threshold"
          | "comparisonOperator"
          | "evaluationPeriods"
          | "treatMissingData"
          | "app">
      • GuLambdaThrottlingMonitoringProps

    Properties

    actionsEnabled? +GuLambdaThrottlingMonitoringProps | @guardian/cdk

    Interface GuLambdaThrottlingMonitoringProps

    interface GuLambdaThrottlingMonitoringProps {
        actionsEnabled?: boolean;
        alarmDescription?: string;
        alarmName?: string;
        datapointsToAlarm?: number;
        evaluateLowSampleCountPercentile?: string;
        noMonitoring?: false;
        numberOfMinutesAboveThresholdBeforeAlarm?: number;
        okAction?: boolean;
        snsTopicName: string;
        toleratedThrottlingCount?: number;
    }

    Hierarchy

    • Omit<GuAlarmProps,
          | "metric"
          | "threshold"
          | "comparisonOperator"
          | "evaluationPeriods"
          | "treatMissingData"
          | "app">
      • GuLambdaThrottlingMonitoringProps

    Properties

    actionsEnabled? alarmDescription? alarmName? datapointsToAlarm? @@ -30,12 +30,12 @@

    Default

    - Not configured.
    -

    OptionalnoMonitoring

    noMonitoring

    OptionalnumberOfMinutesAboveThresholdBeforeAlarm

    numberOfMinutesAboveThresholdBeforeAlarm?: number

    Evaluation period in minutes for alarm.

    +

    OptionalnoMonitoring

    noMonitoring

    OptionalnumberOfMinutesAboveThresholdBeforeAlarm

    numberOfMinutesAboveThresholdBeforeAlarm?: number

    Evaluation period in minutes for alarm.

    Default Value

    1
    -

    OptionalokAction

    okAction?: boolean

    snsTopicName

    snsTopicName: string

    OptionaltoleratedThrottlingCount

    toleratedThrottlingCount?: number

    Sum of thottled invocations above which to alarm.

    +

    OptionalokAction

    okAction?: boolean

    snsTopicName

    snsTopicName: string

    OptionaltoleratedThrottlingCount

    toleratedThrottlingCount?: number

    Sum of thottled invocations above which to alarm.

    Default Value

    0
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_cloudwatch.Http4xxAlarmProps.html b/interfaces/constructs_cloudwatch.Http4xxAlarmProps.html index e7f2fa9119..2d8fdcf643 100644 --- a/interfaces/constructs_cloudwatch.Http4xxAlarmProps.html +++ b/interfaces/constructs_cloudwatch.Http4xxAlarmProps.html @@ -1,4 +1,4 @@ -Http4xxAlarmProps | @guardian/cdk

    Interface Http4xxAlarmProps

    interface Http4xxAlarmProps {
        actionsEnabled?: boolean;
        alarmDescription?: string;
        alarmName?: string;
        comparisonOperator?: ComparisonOperator;
        datapointsToAlarm?: number;
        evaluateLowSampleCountPercentile?: string;
        numberOfMinutesAboveThresholdBeforeAlarm?: number;
        okAction?: boolean;
        tolerated4xxPercentage: number;
    }

    Hierarchy

    • Omit<GuAlarmProps,
          | "snsTopicName"
          | "evaluationPeriods"
          | "metric"
          | "period"
          | "threshold"
          | "treatMissingData"
          | "app">
      • Http4xxAlarmProps

    Properties

    actionsEnabled? +Http4xxAlarmProps | @guardian/cdk

    Interface Http4xxAlarmProps

    interface Http4xxAlarmProps {
        actionsEnabled?: boolean;
        alarmDescription?: string;
        alarmName?: string;
        comparisonOperator?: ComparisonOperator;
        datapointsToAlarm?: number;
        evaluateLowSampleCountPercentile?: string;
        numberOfMinutesAboveThresholdBeforeAlarm?: number;
        okAction?: boolean;
        tolerated4xxPercentage: number;
    }

    Hierarchy

    • Omit<GuAlarmProps,
          | "snsTopicName"
          | "evaluationPeriods"
          | "metric"
          | "period"
          | "threshold"
          | "treatMissingData"
          | "app">
      • Http4xxAlarmProps

    Properties

    actionsEnabled? alarmDescription? alarmName? comparisonOperator? @@ -33,4 +33,4 @@

    Default

    - Not configured.
    -

    OptionalnumberOfMinutesAboveThresholdBeforeAlarm

    numberOfMinutesAboveThresholdBeforeAlarm?: number

    OptionalokAction

    okAction?: boolean

    tolerated4xxPercentage

    tolerated4xxPercentage: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalnumberOfMinutesAboveThresholdBeforeAlarm

    numberOfMinutesAboveThresholdBeforeAlarm?: number

    OptionalokAction

    okAction?: boolean

    tolerated4xxPercentage

    tolerated4xxPercentage: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_cloudwatch.Http5xxAlarmProps.html b/interfaces/constructs_cloudwatch.Http5xxAlarmProps.html index f25f64ebde..c69ab65db2 100644 --- a/interfaces/constructs_cloudwatch.Http5xxAlarmProps.html +++ b/interfaces/constructs_cloudwatch.Http5xxAlarmProps.html @@ -1,4 +1,4 @@ -Http5xxAlarmProps | @guardian/cdk

    Interface Http5xxAlarmProps

    interface Http5xxAlarmProps {
        actionsEnabled?: boolean;
        alarmDescription?: string;
        alarmName?: string;
        comparisonOperator?: ComparisonOperator;
        datapointsToAlarm?: number;
        evaluateLowSampleCountPercentile?: string;
        numberOfMinutesAboveThresholdBeforeAlarm?: number;
        okAction?: boolean;
        tolerated5xxPercentage: number;
    }

    Hierarchy

    • Omit<GuAlarmProps,
          | "snsTopicName"
          | "evaluationPeriods"
          | "metric"
          | "period"
          | "threshold"
          | "treatMissingData"
          | "app">
      • Http5xxAlarmProps

    Properties

    actionsEnabled? +Http5xxAlarmProps | @guardian/cdk

    Interface Http5xxAlarmProps

    interface Http5xxAlarmProps {
        actionsEnabled?: boolean;
        alarmDescription?: string;
        alarmName?: string;
        comparisonOperator?: ComparisonOperator;
        datapointsToAlarm?: number;
        evaluateLowSampleCountPercentile?: string;
        numberOfMinutesAboveThresholdBeforeAlarm?: number;
        okAction?: boolean;
        tolerated5xxPercentage: number;
    }

    Hierarchy

    • Omit<GuAlarmProps,
          | "snsTopicName"
          | "evaluationPeriods"
          | "metric"
          | "period"
          | "threshold"
          | "treatMissingData"
          | "app">
      • Http5xxAlarmProps

    Properties

    actionsEnabled? alarmDescription? alarmName? comparisonOperator? @@ -33,4 +33,4 @@

    Default

    - Not configured.
    -

    OptionalnumberOfMinutesAboveThresholdBeforeAlarm

    numberOfMinutesAboveThresholdBeforeAlarm?: number

    OptionalokAction

    okAction?: boolean

    tolerated5xxPercentage

    tolerated5xxPercentage: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalnumberOfMinutesAboveThresholdBeforeAlarm

    numberOfMinutesAboveThresholdBeforeAlarm?: number

    OptionalokAction

    okAction?: boolean

    tolerated5xxPercentage

    tolerated5xxPercentage: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_cloudwatch.NoMonitoring.html b/interfaces/constructs_cloudwatch.NoMonitoring.html index 5f66030c45..1e14d028ec 100644 --- a/interfaces/constructs_cloudwatch.NoMonitoring.html +++ b/interfaces/constructs_cloudwatch.NoMonitoring.html @@ -1,2 +1,2 @@ -NoMonitoring | @guardian/cdk

    Interface NoMonitoring

    interface NoMonitoring {
        noMonitoring: true;
    }

    Properties

    noMonitoring -

    Properties

    noMonitoring

    noMonitoring

    Settings

    Member Visibility

    On This Page

    Properties
    +NoMonitoring | @guardian/cdk

    Interface NoMonitoring

    interface NoMonitoring {
        noMonitoring: true;
    }

    Properties

    noMonitoring +

    Properties

    noMonitoring

    noMonitoring

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_core.AppIdentity.html b/interfaces/constructs_core.AppIdentity.html index 3c2ebf74a0..c4476f9a7b 100644 --- a/interfaces/constructs_core.AppIdentity.html +++ b/interfaces/constructs_core.AppIdentity.html @@ -1,2 +1,2 @@ -AppIdentity | @guardian/cdk

    Interface AppIdentity

    interface AppIdentity {
        app: string;
    }

    Hierarchy (view full)

    Properties

    app -

    Properties

    app

    app: string

    Settings

    Member Visibility

    On This Page

    Properties
    +AppIdentity | @guardian/cdk

    Interface AppIdentity

    interface AppIdentity {
        app: string;
    }

    Hierarchy (view full)

    Properties

    app +

    Properties

    app

    app: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_core.GuParameterProps.html b/interfaces/constructs_core.GuParameterProps.html index 8e83879892..cc9dc3842b 100644 --- a/interfaces/constructs_core.GuParameterProps.html +++ b/interfaces/constructs_core.GuParameterProps.html @@ -1,4 +1,4 @@ -GuParameterProps | @guardian/cdk

    Interface GuParameterProps

    interface GuParameterProps {
        allowedPattern?: string;
        allowedValues?: string[];
        constraintDescription?: string;
        default?: any;
        description?: string;
        fromSSM?: boolean;
        maxLength?: number;
        maxValue?: number;
        minLength?: number;
        minValue?: number;
        noEcho?: boolean;
        type?: string;
    }

    Hierarchy

    • CfnParameterProps
      • GuParameterProps

    Properties

    allowedPattern? +GuParameterProps | @guardian/cdk

    Interface GuParameterProps

    interface GuParameterProps {
        allowedPattern?: string;
        allowedValues?: string[];
        constraintDescription?: string;
        default?: any;
        description?: string;
        fromSSM?: boolean;
        maxLength?: number;
        maxValue?: number;
        minLength?: number;
        minValue?: number;
        noEcho?: boolean;
        type?: string;
    }

    Hierarchy

    • CfnParameterProps
      • GuParameterProps

    Properties

    allowedPattern? allowedValues? constraintDescription? default? @@ -35,7 +35,7 @@

    Default

    - No description for the parameter.
    -

    OptionalfromSSM

    fromSSM?: boolean

    Optional ReadonlymaxLength

    maxLength?: number

    An integer value that determines the largest number of characters you want to allow for String types.

    +

    OptionalfromSSM

    fromSSM?: boolean

    Optional ReadonlymaxLength

    maxLength?: number

    An integer value that determines the largest number of characters you want to allow for String types.

    Default

    - None.
    diff --git a/interfaces/constructs_core.GuStackProps.html b/interfaces/constructs_core.GuStackProps.html index cebb0f82ee..b60cfff774 100644 --- a/interfaces/constructs_core.GuStackProps.html +++ b/interfaces/constructs_core.GuStackProps.html @@ -1,4 +1,4 @@ -GuStackProps | @guardian/cdk

    Interface GuStackProps

    interface GuStackProps {
        analyticsReporting?: boolean;
        app?: string;
        cloudFormationStackName?: string;
        crossRegionReferences?: boolean;
        description?: string;
        env?: Environment;
        notificationArns?: string[];
        permissionsBoundary?: PermissionsBoundary;
        stack: string;
        stage: string;
        suppressTemplateIndentation?: boolean;
        synthesizer?: IStackSynthesizer;
        tags?: {
            [key: string]: string;
        };
        terminationProtection?: boolean;
        withoutMetadata?: boolean;
        withoutTags?: boolean;
    }

    Hierarchy

    • Omit<StackProps, "stackName">
      • GuStackProps

    Properties

    analyticsReporting? +GuStackProps | @guardian/cdk

    Interface GuStackProps

    interface GuStackProps {
        analyticsReporting?: boolean;
        app?: string;
        cloudFormationStackName?: string;
        crossRegionReferences?: boolean;
        description?: string;
        env?: Environment;
        notificationArns?: string[];
        permissionsBoundary?: PermissionsBoundary;
        stack: string;
        stage: string;
        suppressTemplateIndentation?: boolean;
        synthesizer?: IStackSynthesizer;
        tags?: {
            [key: string]: string;
        };
        terminationProtection?: boolean;
        withoutMetadata?: boolean;
        withoutTags?: boolean;
    }

    Hierarchy

    • Omit<StackProps, "stackName">
      • GuStackProps

    Properties

    analyticsReporting? app? cloudFormationStackName? crossRegionReferences? @@ -18,9 +18,9 @@

    Default

    analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key

    Optionalapp

    app?: string

    Optional name of the app. If defined, all resources will have an App tag.

    -

    OptionalcloudFormationStackName

    cloudFormationStackName?: string

    The AWS CloudFormation stack name (as shown in the AWS CloudFormation UI).

    +

    OptionalcloudFormationStackName

    cloudFormationStackName?: string

    The AWS CloudFormation stack name (as shown in the AWS CloudFormation UI).

    Default Value

    the GU_CFN_STACK_NAME environment variable

    -

    Optional ReadonlycrossRegionReferences

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    +

    Optional ReadonlycrossRegionReferences

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

    This feature is currently experimental

    @@ -66,9 +66,9 @@

    stack

    stack: string

    The Guardian stack being used (as defined in your riff-raff.yaml). This will be applied as a tag to all of your resources.

    -

    stage

    stage: string

    The stage being used (as defined in your riff-raff.yaml). +

    stage

    stage: string

    The stage being used (as defined in your riff-raff.yaml). This will be applied as a tag to all of your resources.

    -

    Optional ReadonlysuppressTemplateIndentation

    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated +

    Optional ReadonlysuppressTemplateIndentation

    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated CloudFormation templates.

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the @@ -99,6 +99,6 @@

    OptionalwithoutMetadata

    withoutMetadata?: boolean

    Set to disable CDK metadata. Only for internal use (for disabling for some snapshot tests). We rely on tracking data to prioritise future work so please do not override this.

    -

    OptionalwithoutTags

    withoutTags?: boolean

    Set this to true to stop the GuStack from tagging all of your AWS resources. +

    OptionalwithoutTags

    withoutTags?: boolean

    Set this to true to stop the GuStack from tagging all of your AWS resources. This should only be turned on as part of an initial migration from CloudFormation.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_core.GuStaticLogicalId.html b/interfaces/constructs_core.GuStaticLogicalId.html index 64d82d1757..a225aea8ac 100644 --- a/interfaces/constructs_core.GuStaticLogicalId.html +++ b/interfaces/constructs_core.GuStaticLogicalId.html @@ -1,5 +1,5 @@ -GuStaticLogicalId | @guardian/cdk

    Interface GuStaticLogicalId

    interface GuStaticLogicalId {
        logicalId: string;
        reason: string;
    }

    Properties

    logicalId +GuStaticLogicalId | @guardian/cdk

    Interface GuStaticLogicalId

    interface GuStaticLogicalId {
        logicalId: string;
        reason: string;
    }

    Properties

    logicalId reason

    Properties

    logicalId

    logicalId: string

    The logical ID to use in the synthesised template for this resource.

    -

    reason

    reason: string

    A short description to help developers understand why this resource's logical ID is being set.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    reason

    reason: string

    A short description to help developers understand why this resource's logical ID is being set.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_core.Identity.html b/interfaces/constructs_core.Identity.html index 9be9277512..732c97fbb8 100644 --- a/interfaces/constructs_core.Identity.html +++ b/interfaces/constructs_core.Identity.html @@ -1,4 +1,4 @@ -Identity | @guardian/cdk

    Interface Identity

    interface Identity {
        app: string;
        stack: string;
        stage: string;
    }

    Hierarchy (view full)

    Properties

    app +Identity | @guardian/cdk

    Interface Identity

    interface Identity {
        app: string;
        stack: string;
        stage: string;
    }

    Hierarchy (view full)

    Properties

    app stack stage -

    Properties

    app

    app: string

    stack

    stack: string

    stage

    stage: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    app

    app: string

    stack

    stack: string

    stage

    stage: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_core.StackStageIdentity.html b/interfaces/constructs_core.StackStageIdentity.html index f5ee5cf43c..af1a9879ee 100644 --- a/interfaces/constructs_core.StackStageIdentity.html +++ b/interfaces/constructs_core.StackStageIdentity.html @@ -1,3 +1,3 @@ -StackStageIdentity | @guardian/cdk

    Interface StackStageIdentity

    interface StackStageIdentity {
        stack: string;
        stage: string;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    stack +StackStageIdentity | @guardian/cdk

    Interface StackStageIdentity

    interface StackStageIdentity {
        stack: string;
        stage: string;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    stack stage -

    Properties

    stack

    stack: string

    stage

    stage: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    stack

    stack: string

    stage

    stage: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_dns.GuCnameProps.html b/interfaces/constructs_dns.GuCnameProps.html index 05a63dfdee..bc4ca6c1ab 100644 --- a/interfaces/constructs_dns.GuCnameProps.html +++ b/interfaces/constructs_dns.GuCnameProps.html @@ -1,14 +1,14 @@ -GuCnameProps | @guardian/cdk

    Interface GuCnameProps

    interface GuCnameProps {
        app: string;
        domainName: string;
        hostedZoneId?: string;
        resourceRecord: string;
        ttl: Duration;
    }

    Hierarchy (view full)

    Properties

    app +GuCnameProps | @guardian/cdk

    Interface GuCnameProps

    interface GuCnameProps {
        app: string;
        domainName: string;
        hostedZoneId?: string;
        resourceRecord: string;
        ttl: Duration;
    }

    Hierarchy (view full)

    Properties

    app domainName hostedZoneId? resourceRecord ttl -

    Properties

    app

    app: string

    domainName

    domainName: string

    The Fully Qualified Domain Name.

    +

    Properties

    app

    app: string

    domainName

    domainName: string

    The Fully Qualified Domain Name.

    Example

    "riff-raff.gutools.co.uk"
    -

    OptionalhostedZoneId

    hostedZoneId?: string

    Route53 Zone ID.

    +

    OptionalhostedZoneId

    hostedZoneId?: string

    Route53 Zone ID.

    To be provided only if the zone for domainName is managed by Route53.

    -

    resourceRecord

    resourceRecord: string

    The record your CNAME should point to, for example your Load Balancer DNS name

    -

    ttl

    ttl: Duration

    The time to live for the DNS record

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    resourceRecord

    resourceRecord: string

    The record your CNAME should point to, for example your Load Balancer DNS name

    +

    ttl

    ttl: Duration

    The time to live for the DNS record

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_dns.GuDnsRecordSetProps.html b/interfaces/constructs_dns.GuDnsRecordSetProps.html index 162239f330..bef3b9dfa4 100644 --- a/interfaces/constructs_dns.GuDnsRecordSetProps.html +++ b/interfaces/constructs_dns.GuDnsRecordSetProps.html @@ -1,5 +1,5 @@ -GuDnsRecordSetProps | @guardian/cdk

    Interface GuDnsRecordSetProps

    interface GuDnsRecordSetProps {
        name: string;
        recordType: CNAME;
        resourceRecords: string[];
        ttl: Duration;
    }

    Properties

    name +GuDnsRecordSetProps | @guardian/cdk

    Interface GuDnsRecordSetProps

    interface GuDnsRecordSetProps {
        name: string;
        recordType: CNAME;
        resourceRecords: string[];
        ttl: Duration;
    }

    Properties

    name recordType resourceRecords ttl -

    Properties

    name

    name: string

    recordType

    recordType: CNAME

    resourceRecords

    resourceRecords: string[]

    ttl

    ttl: Duration

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    name

    name: string

    recordType

    recordType: CNAME

    resourceRecords

    resourceRecords: string[]

    ttl

    ttl: Duration

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_dynamodb.GuDynamoTableProps.html b/interfaces/constructs_dynamodb.GuDynamoTableProps.html index 50aadf191f..b6e6dae1b4 100644 --- a/interfaces/constructs_dynamodb.GuDynamoTableProps.html +++ b/interfaces/constructs_dynamodb.GuDynamoTableProps.html @@ -1,4 +1,4 @@ -GuDynamoTableProps | @guardian/cdk

    Interface GuDynamoTableProps

    interface GuDynamoTableProps {
        billingMode?: BillingMode;
        contributorInsightsEnabled?: boolean;
        deletionProtection?: boolean;
        devXBackups: OptIn | OptOut;
        encryption?: TableEncryption;
        encryptionKey?: IKey;
        importSource?: ImportSourceSpecification;
        kinesisStream?: IStream;
        maxReadRequestUnits?: number;
        maxWriteRequestUnits?: number;
        partitionKey: Attribute;
        pointInTimeRecovery?: boolean;
        readCapacity?: number;
        removalPolicy?: RemovalPolicy;
        replicationRegions?: string[];
        replicationTimeout?: Duration;
        resourcePolicy?: PolicyDocument;
        sortKey?: Attribute;
        stream?: StreamViewType;
        tableClass?: TableClass;
        tableName?: string;
        timeToLiveAttribute?: string;
        waitForReplicationToFinish?: boolean;
        writeCapacity?: number;
    }

    Hierarchy

    • TableProps
      • GuDynamoTableProps

    Properties

    billingMode? +GuDynamoTableProps | @guardian/cdk

    Interface GuDynamoTableProps

    interface GuDynamoTableProps {
        billingMode?: BillingMode;
        contributorInsightsEnabled?: boolean;
        deletionProtection?: boolean;
        devXBackups: OptIn | OptOut;
        encryption?: TableEncryption;
        encryptionKey?: IKey;
        importSource?: ImportSourceSpecification;
        kinesisStream?: IStream;
        maxReadRequestUnits?: number;
        maxWriteRequestUnits?: number;
        partitionKey: Attribute;
        pointInTimeRecovery?: boolean;
        readCapacity?: number;
        removalPolicy?: RemovalPolicy;
        replicationRegions?: string[];
        replicationTimeout?: Duration;
        resourcePolicy?: PolicyDocument;
        sortKey?: Attribute;
        stream?: StreamViewType;
        tableClass?: TableClass;
        tableName?: string;
        timeToLiveAttribute?: string;
        waitForReplicationToFinish?: boolean;
        writeCapacity?: number;
    }

    Hierarchy

    • TableProps
      • GuDynamoTableProps

    Properties

    billingMode? contributorInsightsEnabled? deletionProtection? devXBackups @@ -35,7 +35,7 @@

    devXBackups

    devXBackups: OptIn | OptOut

    We recommend using DevX Backups to protect your DynamoDB table's backups. For more details on this feature, see the documentation.

    -

    Optional Readonlyencryption

    encryption?: TableEncryption

    Whether server-side encryption with an AWS managed customer master key is enabled.

    +

    Optional Readonlyencryption

    encryption?: TableEncryption

    Whether server-side encryption with an AWS managed customer master key is enabled.

    This property cannot be set if serverSideEncryption is set.

    NOTE: if you set this to CUSTOMER_MANAGED and encryptionKey is not diff --git a/interfaces/constructs_dynamodb.OptIn.html b/interfaces/constructs_dynamodb.OptIn.html index 9c91beae02..f73ad18231 100644 --- a/interfaces/constructs_dynamodb.OptIn.html +++ b/interfaces/constructs_dynamodb.OptIn.html @@ -1,2 +1,2 @@ -OptIn | @guardian/cdk

    Interface OptIn

    interface OptIn {
        enabled: true;
    }

    Properties

    enabled -

    Properties

    enabled

    enabled

    Settings

    Member Visibility

    On This Page

    Properties
    +OptIn | @guardian/cdk

    Interface OptIn

    interface OptIn {
        enabled: true;
    }

    Properties

    enabled +

    Properties

    enabled

    enabled

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_dynamodb.OptOut.html b/interfaces/constructs_dynamodb.OptOut.html index 7e37bc065d..bd6a8625bd 100644 --- a/interfaces/constructs_dynamodb.OptOut.html +++ b/interfaces/constructs_dynamodb.OptOut.html @@ -1,5 +1,5 @@ -OptOut | @guardian/cdk

    Interface OptOut

    interface OptOut {
        enabled: false;
        optOutReason: string;
    }

    Properties

    enabled +OptOut | @guardian/cdk

    Interface OptOut

    interface OptOut {
        enabled: false;
        optOutReason: string;
    }

    Properties

    enabled optOutReason -

    Properties

    enabled

    enabled

    optOutReason

    optOutReason: string

    We recommend using DevX Backups where possible. If it is not suitable for your use-case please document +

    Properties

    enabled

    enabled

    optOutReason

    optOutReason: string

    We recommend using DevX Backups where possible. If it is not suitable for your use-case please document this here so that we can understand why this is switched off when performing security audits.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_ec2.GuBaseSecurityGroupProps.html b/interfaces/constructs_ec2.GuBaseSecurityGroupProps.html index a791c610ec..6056ade32a 100644 --- a/interfaces/constructs_ec2.GuBaseSecurityGroupProps.html +++ b/interfaces/constructs_ec2.GuBaseSecurityGroupProps.html @@ -1,4 +1,4 @@ -GuBaseSecurityGroupProps | @guardian/cdk

    Interface GuBaseSecurityGroupProps

    interface GuBaseSecurityGroupProps {
        allowAllIpv6Outbound?: boolean;
        allowAllOutbound?: boolean;
        description?: string;
        disableInlineRules?: boolean;
        egresses?: SecurityGroupAccessRule[];
        ingresses?: SecurityGroupAccessRule[];
        securityGroupName?: string;
        vpc: IVpc;
    }

    Hierarchy (view full)

    Properties

    allowAllIpv6Outbound? +GuBaseSecurityGroupProps | @guardian/cdk

    Interface GuBaseSecurityGroupProps

    interface GuBaseSecurityGroupProps {
        allowAllIpv6Outbound?: boolean;
        allowAllOutbound?: boolean;
        description?: string;
        disableInlineRules?: boolean;
        egresses?: SecurityGroupAccessRule[];
        ingresses?: SecurityGroupAccessRule[];
        securityGroupName?: string;
        vpc: IVpc;
    }

    Hierarchy (view full)

    Properties

    allowAllIpv6Outbound? allowAllOutbound? description? disableInlineRules? @@ -36,7 +36,7 @@

    Default

    false
    -

    Optionalegresses

    egresses?: SecurityGroupAccessRule[]

    Optionalingresses

    ingresses?: SecurityGroupAccessRule[]

    Optional ReadonlysecurityGroupName

    securityGroupName?: string

    The name of the security group. For valid values, see the GroupName +

    Optionalegresses

    egresses?: SecurityGroupAccessRule[]

    Optionalingresses

    ingresses?: SecurityGroupAccessRule[]

    Optional ReadonlysecurityGroupName

    securityGroupName?: string

    The name of the security group. For valid values, see the GroupName parameter of the CreateSecurityGroup action in the Amazon EC2 API Reference.

    It is not recommended to use an explicit group name.

    diff --git a/interfaces/constructs_ec2.GuSecurityGroupProps.html b/interfaces/constructs_ec2.GuSecurityGroupProps.html index b4ffae869f..e1e1962bc3 100644 --- a/interfaces/constructs_ec2.GuSecurityGroupProps.html +++ b/interfaces/constructs_ec2.GuSecurityGroupProps.html @@ -1,4 +1,4 @@ -GuSecurityGroupProps | @guardian/cdk

    Interface GuSecurityGroupProps

    interface GuSecurityGroupProps {
        allowAllIpv6Outbound?: boolean;
        allowAllOutbound?: boolean;
        app: string;
        description?: string;
        disableInlineRules?: boolean;
        egresses?: SecurityGroupAccessRule[];
        ingresses?: SecurityGroupAccessRule[];
        securityGroupName?: string;
        vpc: IVpc;
    }

    Hierarchy (view full)

    Properties

    allowAllIpv6Outbound? +GuSecurityGroupProps | @guardian/cdk

    Interface GuSecurityGroupProps

    interface GuSecurityGroupProps {
        allowAllIpv6Outbound?: boolean;
        allowAllOutbound?: boolean;
        app: string;
        description?: string;
        disableInlineRules?: boolean;
        egresses?: SecurityGroupAccessRule[];
        ingresses?: SecurityGroupAccessRule[];
        securityGroupName?: string;
        vpc: IVpc;
    }

    Hierarchy (view full)

    Properties

    allowAllIpv6Outbound? allowAllOutbound? app description? @@ -23,7 +23,7 @@

    Default

    true
    -

    app

    app: string

    Optional Readonlydescription

    description?: string

    A description of the security group.

    +

    app

    app: string

    Optional Readonlydescription

    description?: string

    A description of the security group.

    Default

    The default name will be the construct's CDK path.
    @@ -37,7 +37,7 @@

    Default

    false
    -

    Optionalegresses

    egresses?: SecurityGroupAccessRule[]

    Optionalingresses

    ingresses?: SecurityGroupAccessRule[]

    Optional ReadonlysecurityGroupName

    securityGroupName?: string

    The name of the security group. For valid values, see the GroupName +

    Optionalegresses

    egresses?: SecurityGroupAccessRule[]

    Optionalingresses

    ingresses?: SecurityGroupAccessRule[]

    Optional ReadonlysecurityGroupName

    securityGroupName?: string

    The name of the security group. For valid values, see the GroupName parameter of the CreateSecurityGroup action in the Amazon EC2 API Reference.

    It is not recommended to use an explicit group name.

    diff --git a/interfaces/constructs_ec2.GuSubnetProps.html b/interfaces/constructs_ec2.GuSubnetProps.html index 08f0740756..2ccc1ccc76 100644 --- a/interfaces/constructs_ec2.GuSubnetProps.html +++ b/interfaces/constructs_ec2.GuSubnetProps.html @@ -1,3 +1,3 @@ -GuSubnetProps | @guardian/cdk

    Interface GuSubnetProps

    interface GuSubnetProps {
        app?: string;
        type?: SubnetType;
    }

    Properties

    app? +GuSubnetProps | @guardian/cdk

    Interface GuSubnetProps

    interface GuSubnetProps {
        app?: string;
        type?: SubnetType;
    }

    Properties

    app? type? -

    Properties

    Optionalapp

    app?: string

    Optionaltype

    type?: SubnetType

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalapp

    app?: string

    Optionaltype

    type?: SubnetType

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_ec2.SecurityGroupAccessRule.html b/interfaces/constructs_ec2.SecurityGroupAccessRule.html index 1729fd7b9e..45cef29f78 100644 --- a/interfaces/constructs_ec2.SecurityGroupAccessRule.html +++ b/interfaces/constructs_ec2.SecurityGroupAccessRule.html @@ -1,12 +1,12 @@ SecurityGroupAccessRule | @guardian/cdk

    Interface SecurityGroupAccessRule

    A way to describe an ingress or egress rule for a security group.

    See [[transformToSecurityGroupAccessRule]] for a handy helper function.

    -
    interface SecurityGroupAccessRule {
        description: string;
        port: number | Port;
        range: IPeer;
    }

    Properties

    description +
    interface SecurityGroupAccessRule {
        description: string;
        port: number | Port;
        range: IPeer;
    }

    Properties

    description port range

    Properties

    description

    description: string

    A short explanation for this rule.

    -

    port

    port: number | Port

    The port to open in a security group. +

    port

    port: number | Port

    The port to open in a security group. The default protocol is TCP. Use Port.udp(port) for the UDP protocol.

    -

    range

    range: IPeer

    The CIDR address for this rule. +

    range

    range: IPeer

    The CIDR address for this rule. Use Peer.anyIpv4() for global access.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_ecs.GuEcsTaskProps.html b/interfaces/constructs_ecs.GuEcsTaskProps.html index 9d42e4903b..0b7d6ef5dd 100644 --- a/interfaces/constructs_ecs.GuEcsTaskProps.html +++ b/interfaces/constructs_ecs.GuEcsTaskProps.html @@ -29,7 +29,7 @@ VERSION environment variable. Alternatively, you could hard code a value for the variable in CDK. See https://docs.aws.amazon.com/step-functions/latest/dg/connect-ecs.html for further detail and other override options - this construct currently only supports environment variables.

    -
    interface GuEcsTaskProps {
        app: string;
        assignPublicIp?: boolean;
        containerConfiguration: ContainerConfiguration;
        containerInsights?: boolean;
        cpu?: number;
        customTaskPolicies?: PolicyStatement[];
        enableDistributablePolicy?: boolean;
        environmentOverrides?: TaskEnvironmentVariable[];
        memory?: number;
        monitoringConfiguration: NoMonitoring | GuEcsTaskMonitoringProps;
        readonlyRootFilesystem?: boolean;
        securityGroups?: ISecurityGroup[];
        storage?: number;
        subnets: ISubnet[];
        taskCommand?: string;
        taskTimeoutInMinutes?: number;
        vpc: IVpc;
    }

    Hierarchy (view full)

    Properties

    app +
    interface GuEcsTaskProps {
        app: string;
        assignPublicIp?: boolean;
        containerConfiguration: ContainerConfiguration;
        containerInsights?: boolean;
        cpu?: number;
        customTaskPolicies?: PolicyStatement[];
        enableDistributablePolicy?: boolean;
        environmentOverrides?: TaskEnvironmentVariable[];
        memory?: number;
        monitoringConfiguration: NoMonitoring | GuEcsTaskMonitoringProps;
        readonlyRootFilesystem?: boolean;
        securityGroups?: ISecurityGroup[];
        storage?: number;
        subnets: ISubnet[];
        taskCommand?: string;
        taskTimeoutInMinutes?: number;
        vpc: IVpc;
    }

    Hierarchy (view full)

    Properties

    app assignPublicIp? containerConfiguration containerInsights? @@ -46,16 +46,16 @@ taskCommand? taskTimeoutInMinutes? vpc -

    Properties

    app

    app: string

    OptionalassignPublicIp

    assignPublicIp?: boolean

    containerConfiguration

    containerConfiguration: ContainerConfiguration

    OptionalcontainerInsights

    containerInsights?: boolean

    If true, CloudWatch Container Insights will be enabled for the cluster

    +

    Properties

    app

    app: string

    OptionalassignPublicIp

    assignPublicIp?: boolean

    containerConfiguration

    containerConfiguration: ContainerConfiguration

    OptionalcontainerInsights

    containerInsights?: boolean

    If true, CloudWatch Container Insights will be enabled for the cluster

    Default

    false
    -

    Optionalcpu

    cpu?: number

    OptionalcustomTaskPolicies

    customTaskPolicies?: PolicyStatement[]

    OptionalenableDistributablePolicy

    enableDistributablePolicy?: boolean

    Whether to give the task IAM role access to the account's dist bucket. +

    Optionalcpu

    cpu?: number

    OptionalcustomTaskPolicies

    customTaskPolicies?: PolicyStatement[]

    OptionalenableDistributablePolicy

    enableDistributablePolicy?: boolean

    Whether to give the task IAM role access to the account's dist bucket. This is enabled by default to avoid breaking changes, but consumers of this pattern that pull a container image that doesn't need extra dependencies from S3 shoud set this value to false.

    -

    OptionalenvironmentOverrides

    environmentOverrides?: TaskEnvironmentVariable[]

    Optionalmemory

    memory?: number

    monitoringConfiguration

    monitoringConfiguration: NoMonitoring | GuEcsTaskMonitoringProps

    OptionalreadonlyRootFilesystem

    readonlyRootFilesystem?: boolean

    When this parameter is true, the container is given read-only access to its root file system.

    +

    OptionalenvironmentOverrides

    environmentOverrides?: TaskEnvironmentVariable[]

    Optionalmemory

    memory?: number

    monitoringConfiguration

    monitoringConfiguration: NoMonitoring | GuEcsTaskMonitoringProps

    OptionalreadonlyRootFilesystem

    readonlyRootFilesystem?: boolean

    When this parameter is true, the container is given read-only access to its root file system.

    Default

    false
    -

    OptionalsecurityGroups

    securityGroups?: ISecurityGroup[]

    Optionalstorage

    storage?: number

    subnets

    subnets: ISubnet[]

    OptionaltaskCommand

    taskCommand?: string

    OptionaltaskTimeoutInMinutes

    taskTimeoutInMinutes?: number

    vpc

    vpc: IVpc

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalsecurityGroups

    securityGroups?: ISecurityGroup[]

    Optionalstorage

    storage?: number

    subnets

    subnets: ISubnet[]

    OptionaltaskCommand

    taskCommand?: string

    OptionaltaskTimeoutInMinutes

    taskTimeoutInMinutes?: number

    vpc

    vpc: IVpc

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_iam.GuAllowPolicyProps.html b/interfaces/constructs_iam.GuAllowPolicyProps.html index c8c5dfc3ab..7932704207 100644 --- a/interfaces/constructs_iam.GuAllowPolicyProps.html +++ b/interfaces/constructs_iam.GuAllowPolicyProps.html @@ -1,4 +1,4 @@ -GuAllowPolicyProps | @guardian/cdk

    Interface GuAllowPolicyProps

    interface GuAllowPolicyProps {
        actions: string[];
        document?: PolicyDocument;
        force?: boolean;
        groups?: IGroup[];
        policyName?: string;
        resources: string[];
        roles?: IRole[];
        users?: IUser[];
    }

    Hierarchy (view full)

    Properties

    actions +GuAllowPolicyProps | @guardian/cdk

    Interface GuAllowPolicyProps

    interface GuAllowPolicyProps {
        actions: string[];
        document?: PolicyDocument;
        force?: boolean;
        groups?: IGroup[];
        policyName?: string;
        resources: string[];
        roles?: IRole[];
        users?: IUser[];
    }

    Hierarchy (view full)

    Properties

    actions document? force? groups? @@ -6,7 +6,7 @@ resources roles? users? -

    Properties

    actions

    actions: string[]

    Optional Readonlydocument

    document?: PolicyDocument

    Initial PolicyDocument to use for this Policy. If omited, any +

    Properties

    actions

    actions: string[]

    Optional Readonlydocument

    document?: PolicyDocument

    Initial PolicyDocument to use for this Policy. If omited, any PolicyStatement provided in the statements property will be applied against the empty default PolicyDocument.

    Default

    - An empty policy.
@@ -35,7 +35,7 @@

    Default

    - Uses the logical ID of the policy resource, which is ensured
    to be unique within the stack.
    -

    resources

    resources: string[]

    Optional Readonlyroles

    roles?: IRole[]

    Roles to attach this policy to. +

    resources

    resources: string[]

    Optional Readonlyroles

    roles?: IRole[]

    Roles to attach this policy to. You can also use attachToRole(role) to attach this policy to a role.

    Default

    - No roles.
    diff --git a/interfaces/constructs_iam.GuAssumeRolePolicyProps.html b/interfaces/constructs_iam.GuAssumeRolePolicyProps.html index cd1cfad1bd..c060f51602 100644 --- a/interfaces/constructs_iam.GuAssumeRolePolicyProps.html +++ b/interfaces/constructs_iam.GuAssumeRolePolicyProps.html @@ -1,4 +1,4 @@ -GuAssumeRolePolicyProps | @guardian/cdk

    Interface GuAssumeRolePolicyProps

    interface GuAssumeRolePolicyProps {
        document?: PolicyDocument;
        force?: boolean;
        groups?: IGroup[];
        policyName?: string;
        resources: string[];
        roles?: IRole[];
        users?: IUser[];
    }

    Hierarchy (view full)

    Properties

    document? +GuAssumeRolePolicyProps | @guardian/cdk

    Interface GuAssumeRolePolicyProps

    interface GuAssumeRolePolicyProps {
        document?: PolicyDocument;
        force?: boolean;
        groups?: IGroup[];
        policyName?: string;
        resources: string[];
        roles?: IRole[];
        users?: IUser[];
    }

    Hierarchy (view full)

    Properties

    document? force? groups? policyName? @@ -34,7 +34,7 @@

    Default

    - Uses the logical ID of the policy resource, which is ensured
    to be unique within the stack.
    -

    resources

    resources: string[]

    Optional Readonlyroles

    roles?: IRole[]

    Roles to attach this policy to. +

    resources

    resources: string[]

    Optional Readonlyroles

    roles?: IRole[]

    Roles to attach this policy to. You can also use attachToRole(role) to attach this policy to a role.

    Default

    - No roles.
    diff --git a/interfaces/constructs_iam.GuFastlyLogsIamRoleProps.html b/interfaces/constructs_iam.GuFastlyLogsIamRoleProps.html index 74999de5b2..0753ac6a52 100644 --- a/interfaces/constructs_iam.GuFastlyLogsIamRoleProps.html +++ b/interfaces/constructs_iam.GuFastlyLogsIamRoleProps.html @@ -1,8 +1,8 @@ -GuFastlyLogsIamRoleProps | @guardian/cdk

    Interface GuFastlyLogsIamRoleProps

    interface GuFastlyLogsIamRoleProps {
        bucketName: string;
        path?: string;
    }

    Properties

    bucketName +GuFastlyLogsIamRoleProps | @guardian/cdk

    Interface GuFastlyLogsIamRoleProps

    interface GuFastlyLogsIamRoleProps {
        bucketName: string;
        path?: string;
    }

    Properties

    bucketName path?

    Properties

    bucketName

    bucketName: string

    S3 bucket name that Fastly will ship logs

    -

    Optionalpath

    path?: string

    Path within the S3 bucket where Fastly will ship logs.

    +

    Optionalpath

    path?: string

    Path within the S3 bucket where Fastly will ship logs.

    Default

    - '*'
    If path is not specified, access will be granted to the entire S3 bucket.
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_iam.GuGetS3ObjectPolicyProps.html b/interfaces/constructs_iam.GuGetS3ObjectPolicyProps.html index 70802ae10b..5310077af9 100644 --- a/interfaces/constructs_iam.GuGetS3ObjectPolicyProps.html +++ b/interfaces/constructs_iam.GuGetS3ObjectPolicyProps.html @@ -1,4 +1,4 @@ -GuGetS3ObjectPolicyProps | @guardian/cdk

    Interface GuGetS3ObjectPolicyProps

    interface GuGetS3ObjectPolicyProps {
        bucketName: string;
        document?: PolicyDocument;
        force?: boolean;
        groups?: IGroup[];
        paths?: string[];
        policyName?: string;
        roles?: IRole[];
        users?: IUser[];
    }

    Hierarchy (view full)

    Properties

    bucketName +GuGetS3ObjectPolicyProps | @guardian/cdk

    Interface GuGetS3ObjectPolicyProps

    interface GuGetS3ObjectPolicyProps {
        bucketName: string;
        document?: PolicyDocument;
        force?: boolean;
        groups?: IGroup[];
        paths?: string[];
        policyName?: string;
        roles?: IRole[];
        users?: IUser[];
    }

    Hierarchy (view full)

    Properties

    bucketName document? force? groups? @@ -6,7 +6,7 @@ policyName? roles? users? -

    Properties

    bucketName

    bucketName: string

    Optional Readonlydocument

    document?: PolicyDocument

    Initial PolicyDocument to use for this Policy. If omited, any +

    Properties

    bucketName

    bucketName: string

    Optional Readonlydocument

    document?: PolicyDocument

    Initial PolicyDocument to use for this Policy. If omited, any PolicyStatement provided in the statements property will be applied against the empty default PolicyDocument.

    Default

    - An empty policy.
@@ -29,7 +29,7 @@

    Default

    - No groups.
    -

    Optionalpaths

    paths?: string[]

    Optional ReadonlypolicyName

    policyName?: string

    The name of the policy. If you specify multiple policies for an entity, +

    Optionalpaths

    paths?: string[]

    Optional ReadonlypolicyName

    policyName?: string

    The name of the policy. If you specify multiple policies for an entity, specify unique names. For example, if you specify a list of policies for an IAM role, each policy must have a unique name.

    Default

    - Uses the logical ID of the policy resource, which is ensured
    to be unique within the stack.
diff --git a/interfaces/constructs_iam.GuGithubActionsRepositoryCondition.html b/interfaces/constructs_iam.GuGithubActionsRepositoryCondition.html
index 6b5facf777..0a00e1eb91 100644
--- a/interfaces/constructs_iam.GuGithubActionsRepositoryCondition.html
+++ b/interfaces/constructs_iam.GuGithubActionsRepositoryCondition.html
@@ -1,5 +1,5 @@
-GuGithubActionsRepositoryCondition | @guardian/cdk
    Interface GuGithubActionsRepositoryCondition
    interface GuGithubActionsRepositoryCondition { 
        githubOrganisation: string; 
        repositories?: string; 
    }
    Properties
    githubOrganisation
+GuGithubActionsRepositoryCondition | @guardian/cdk
    Interface GuGithubActionsRepositoryCondition
    interface GuGithubActionsRepositoryCondition { 
        githubOrganisation: string; 
        repositories?: string; 
    }
    Properties
    githubOrganisation
 repositories?
 
     Properties
    githubOrganisation
    githubOrganisation: string
    The GitHub organisation/user to constrain the IAM Role to.
    
-
    Optionalrepositories
    repositories?: string
    Repositories to constrain the IAM Role to.
    
-
    Settings
    Member Visibility
    On This Page
    Properties
    
+
    Optionalrepositories
    repositories?: string
    Repositories to constrain the IAM Role to.
    
+
    Settings
    Member Visibility
    On This Page
    Properties
    
diff --git a/interfaces/constructs_iam.GuGithubActionsRoleProps.html b/interfaces/constructs_iam.GuGithubActionsRoleProps.html
index 0183511e59..50c8d1e0bf 100644
--- a/interfaces/constructs_iam.GuGithubActionsRoleProps.html
+++ b/interfaces/constructs_iam.GuGithubActionsRoleProps.html
@@ -1,6 +1,6 @@
-GuGithubActionsRoleProps | @guardian/cdk
    Interface GuGithubActionsRoleProps
    interface GuGithubActionsRoleProps { 
        condition?: GuGithubActionsRepositoryCondition; 
        policies: GuPolicy[]; 
    }
    Properties
    condition?
+GuGithubActionsRoleProps | @guardian/cdk
    Interface GuGithubActionsRoleProps
    interface GuGithubActionsRoleProps { 
        condition?: GuGithubActionsRepositoryCondition; 
        policies: GuPolicy[]; 
    }
    Properties
    condition?
 policies
 
     Properties
    Optionalcondition
    condition?: GuGithubActionsRepositoryCondition
    Repositories where GitHub Actions can assumes this role.
 Defaults to [[ALL_GUARDIAN_REPOSITORIES]].
    
-
    policies
    policies: GuPolicy[]
    A list of IAM Policies for the GitHub Action.
    
-
    Settings
    Member Visibility
    On This Page
    Properties
    
+
    policies
    policies: GuPolicy[]
    A list of IAM Policies for the GitHub Action.
    
+
    Settings
    Member Visibility
    On This Page
    Properties
    
diff --git a/interfaces/constructs_iam.GuInstanceRoleProps.html b/interfaces/constructs_iam.GuInstanceRoleProps.html
index c712682c9f..13d1c8a0d9 100644
--- a/interfaces/constructs_iam.GuInstanceRoleProps.html
+++ b/interfaces/constructs_iam.GuInstanceRoleProps.html
@@ -1,7 +1,7 @@
-GuInstanceRoleProps | @guardian/cdk
    Interface GuInstanceRoleProps
    interface GuInstanceRoleProps { 
        additionalPolicies?: GuPolicy[]; 
        withoutLogShipping?: boolean; 
    }
    Properties
    additionalPolicies?
+GuInstanceRoleProps | @guardian/cdk
    Interface GuInstanceRoleProps
    interface GuInstanceRoleProps { 
        additionalPolicies?: GuPolicy[]; 
        withoutLogShipping?: boolean; 
    }
    Properties
    additionalPolicies?
 withoutLogShipping?
-
     Properties
    OptionaladditionalPolicies
    additionalPolicies?: GuPolicy[]
    OptionalwithoutLogShipping
    withoutLogShipping?: boolean
    By default, instances are given permissions to write to Kinesis. Set to
+
     Properties
    OptionaladditionalPolicies
    additionalPolicies?: GuPolicy[]
    OptionalwithoutLogShipping
    withoutLogShipping?: boolean
    By default, instances are given permissions to write to Kinesis. Set to
 'true' to prevent this. Note, disabling will prevent not just application
 logs being shipped but also anything else - for example, automatic log
 shipping of Cloud Init and other logs by the cdk-base role in your AMI.
    
-
    Settings
    Member Visibility
    On This Page
    Properties
    
+

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_iam.GuPutS3ObjectPolicyProps.html b/interfaces/constructs_iam.GuPutS3ObjectPolicyProps.html index f7399caff9..ffc98eae89 100644 --- a/interfaces/constructs_iam.GuPutS3ObjectPolicyProps.html +++ b/interfaces/constructs_iam.GuPutS3ObjectPolicyProps.html @@ -1,4 +1,4 @@ -GuPutS3ObjectPolicyProps | @guardian/cdk

    Interface GuPutS3ObjectPolicyProps

    interface GuPutS3ObjectPolicyProps {
        bucketName: string;
        document?: PolicyDocument;
        force?: boolean;
        groups?: IGroup[];
        paths?: string[];
        policyName?: string;
        roles?: IRole[];
        users?: IUser[];
    }

    Hierarchy (view full)

    Properties

    bucketName +GuPutS3ObjectPolicyProps | @guardian/cdk

    Interface GuPutS3ObjectPolicyProps

    interface GuPutS3ObjectPolicyProps {
        bucketName: string;
        document?: PolicyDocument;
        force?: boolean;
        groups?: IGroup[];
        paths?: string[];
        policyName?: string;
        roles?: IRole[];
        users?: IUser[];
    }

    Hierarchy (view full)

    Properties

    bucketName document? force? groups? @@ -6,7 +6,7 @@ policyName? roles? users? -

    Properties

    bucketName

    bucketName: string

    Optional Readonlydocument

    document?: PolicyDocument

    Initial PolicyDocument to use for this Policy. If omited, any +

    Properties

    bucketName

    bucketName: string

    Optional Readonlydocument

    document?: PolicyDocument

    Initial PolicyDocument to use for this Policy. If omited, any PolicyStatement provided in the statements property will be applied against the empty default PolicyDocument.

    Default

    - An empty policy.
@@ -29,7 +29,7 @@

    Default

    - No groups.
    -

    Optionalpaths

    paths?: string[]

    Optional ReadonlypolicyName

    policyName?: string

    The name of the policy. If you specify multiple policies for an entity, +

    Optionalpaths

    paths?: string[]

    Optional ReadonlypolicyName

    policyName?: string

    The name of the policy. If you specify multiple policies for an entity, specify unique names. For example, if you specify a list of policies for an IAM role, each policy must have a unique name.

    Default

    - Uses the logical ID of the policy resource, which is ensured
    to be unique within the stack.
diff --git a/interfaces/constructs_lambda.GuFunctionProps.html b/interfaces/constructs_lambda.GuFunctionProps.html
index c9b090a6c5..89f479d84f 100644
--- a/interfaces/constructs_lambda.GuFunctionProps.html
+++ b/interfaces/constructs_lambda.GuFunctionProps.html
@@ -1,4 +1,4 @@
-GuFunctionProps | @guardian/cdk
    Interface GuFunctionProps
    interface GuFunctionProps { 
        adotInstrumentation?: AdotInstrumentationConfig; 
        allowAllIpv6Outbound?: boolean; 
        allowAllOutbound?: boolean; 
        allowPublicSubnet?: boolean; 
        app: string; 
        applicationLogLevel?: string; 
        applicationLogLevelV2?: ApplicationLogLevel; 
        architecture?: Architecture; 
        bucketNamePath?: string; 
        codeSigningConfig?: ICodeSigningConfig; 
        currentVersionOptions?: VersionOptions; 
        deadLetterQueue?: IQueue; 
        deadLetterQueueEnabled?: boolean; 
        deadLetterTopic?: ITopic; 
        description?: string; 
        enableVersioning?: boolean; 
        environment?: { 
            [key: string]: string; 
        }; 
        environmentEncryption?: IKey; 
        ephemeralStorageSize?: Size; 
        errorPercentageMonitoring?: GuLambdaErrorPercentageMonitoringProps; 
        events?: IEventSource[]; 
        fileName: string; 
        filesystem?: FileSystem; 
        functionName?: string; 
        handler: string; 
        initialPolicy?: PolicyStatement[]; 
        insightsVersion?: LambdaInsightsVersion; 
        ipv6AllowedForDualStack?: boolean; 
        layers?: ILayerVersion[]; 
        logFormat?: string; 
        loggingFormat?: LoggingFormat; 
        logGroup?: ILogGroup; 
        logRetention?: RetentionDays; 
        logRetentionRetryOptions?: LogRetentionRetryOptions; 
        logRetentionRole?: IRole; 
        maxEventAge?: Duration; 
        memorySize?: number; 
        onFailure?: IDestination; 
        onSuccess?: IDestination; 
        paramsAndSecrets?: ParamsAndSecretsLayerVersion; 
        profiling?: boolean; 
        profilingGroup?: IProfilingGroup; 
        recursiveLoop?: RecursiveLoop; 
        reservedConcurrentExecutions?: number; 
        retryAttempts?: number; 
        role?: IRole; 
        runtime: Runtime; 
        runtimeManagementMode?: RuntimeManagementMode; 
        securityGroups?: ISecurityGroup[]; 
        snapStart?: SnapStartConf; 
        systemLogLevel?: string; 
        systemLogLevelV2?: SystemLogLevel; 
        throttlingMonitoring?: GuLambdaThrottlingMonitoringProps; 
        timeout?: Duration; 
        tracing?: Tracing; 
        vpc?: IVpc; 
        vpcSubnets?: SubnetSelection; 
        withoutArtifactUpload?: boolean; 
        withoutFilePrefix?: boolean; 
    }
    Hierarchy (view full)
    Properties
    adotInstrumentation?
+GuFunctionProps | @guardian/cdk
    Interface GuFunctionProps
    interface GuFunctionProps { 
        adotInstrumentation?: AdotInstrumentationConfig; 
        allowAllIpv6Outbound?: boolean; 
        allowAllOutbound?: boolean; 
        allowPublicSubnet?: boolean; 
        app: string; 
        applicationLogLevel?: string; 
        applicationLogLevelV2?: ApplicationLogLevel; 
        architecture?: Architecture; 
        bucketNamePath?: string; 
        codeSigningConfig?: ICodeSigningConfig; 
        currentVersionOptions?: VersionOptions; 
        deadLetterQueue?: IQueue; 
        deadLetterQueueEnabled?: boolean; 
        deadLetterTopic?: ITopic; 
        description?: string; 
        enableVersioning?: boolean; 
        environment?: { 
            [key: string]: string; 
        }; 
        environmentEncryption?: IKey; 
        ephemeralStorageSize?: Size; 
        errorPercentageMonitoring?: GuLambdaErrorPercentageMonitoringProps; 
        events?: IEventSource[]; 
        fileName: string; 
        filesystem?: FileSystem; 
        functionName?: string; 
        handler: string; 
        initialPolicy?: PolicyStatement[]; 
        insightsVersion?: LambdaInsightsVersion; 
        ipv6AllowedForDualStack?: boolean; 
        layers?: ILayerVersion[]; 
        logFormat?: string; 
        loggingFormat?: LoggingFormat; 
        logGroup?: ILogGroup; 
        logRetention?: RetentionDays; 
        logRetentionRetryOptions?: LogRetentionRetryOptions; 
        logRetentionRole?: IRole; 
        maxEventAge?: Duration; 
        memorySize?: number; 
        onFailure?: IDestination; 
        onSuccess?: IDestination; 
        paramsAndSecrets?: ParamsAndSecretsLayerVersion; 
        profiling?: boolean; 
        profilingGroup?: IProfilingGroup; 
        recursiveLoop?: RecursiveLoop; 
        reservedConcurrentExecutions?: number; 
        retryAttempts?: number; 
        role?: IRole; 
        runtime: Runtime; 
        runtimeManagementMode?: RuntimeManagementMode; 
        securityGroups?: ISecurityGroup[]; 
        snapStart?: SnapStartConf; 
        systemLogLevel?: string; 
        systemLogLevelV2?: SystemLogLevel; 
        throttlingMonitoring?: GuLambdaThrottlingMonitoringProps; 
        timeout?: Duration; 
        tracing?: Tracing; 
        vpc?: IVpc; 
        vpcSubnets?: SubnetSelection; 
        withoutArtifactUpload?: boolean; 
        withoutFilePrefix?: boolean; 
    }
    Hierarchy (view full)
    Properties
    adotInstrumentation?
 allowAllIpv6Outbound?
 allowAllOutbound?
 allowPublicSubnet?
@@ -85,7 +85,7 @@
 
    Default
    false
 
    
 
-
    app
    app: string
    Optional ReadonlyapplicationLogLevel
    applicationLogLevel?: string
    Sets the application log level for the function.
    
+
    app
    app: string
    Optional ReadonlyapplicationLogLevel
    applicationLogLevel?: string
    Sets the application log level for the function.
    
 
    Deprecated
    Use applicationLogLevelV2 as a property instead.
    
 
    Default
    "INFO"
 
    
@@ -103,7 +103,7 @@
 you are referencing a file that is shared across many apps and/or AWS
 accounts.
    
 
    Default Value
    [[GuDistributionBucketParameter]]
    
-
    Optional ReadonlycodeSigningConfig
    codeSigningConfig?: ICodeSigningConfig
    Code signing config associated with this function
    
+
    Optional ReadonlycodeSigningConfig
    codeSigningConfig?: ICodeSigningConfig
    Code signing config associated with this function
    
 
    Default
    - Not Sign the Code
 
    
 
@@ -136,7 +136,7 @@
 on versioning (e.g. SnapStart or Provisioned Concurrency).
    
 
    If you enable versioning you must ensure that your Lambda function is updated whenever a new build is deployed via
 CloudFormation. The simplest way to do this is to include the build number in the fileName prop.
    
-
    Optional Readonlyenvironment
    environment?: { 
        [key: string]: string; 
    }
    Key-value pairs that Lambda caches and makes available for your Lambda
+
    Optional Readonlyenvironment
    environment?: { 
        [key: string]: string; 
    }
    Key-value pairs that Lambda caches and makes available for your Lambda
 functions. Use environment variables to apply configuration changes, such
 as test and production environment configurations, without changing your
 Lambda function source code.
    
@@ -152,14 +152,14 @@

    OptionalerrorPercentageMonitoring

    errorPercentageMonitoring?: GuLambdaErrorPercentageMonitoringProps

    Alarm if error percentage exceeds a threshold.

    -

    Optional Readonlyevents

    events?: IEventSource[]

    Event sources for this function.

    +

    Optional Readonlyevents

    events?: IEventSource[]

    Event sources for this function.

    You can also add event sources using addEventSource.

    Default

    - No event sources.

    fileName

    fileName: string

    The filename for an executable package within the bucket [[GuDistributionBucketParameter]]. We'll look for fileName on the path "bucket/stack/stage/app/".

    -

    Optional Readonlyfilesystem

    filesystem?: FileSystem

    The filesystem configuration for the lambda function

    +

    Optional Readonlyfilesystem

    filesystem?: FileSystem

    The filesystem configuration for the lambda function

    Default

    - will not mount any filesystem
    @@ -347,7 +347,7 @@ concurrency limit (the reservedConcurrentExecutions prop) if you are concerned about throttling.

    See

    https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html

    -

    Optional Readonlytimeout

    timeout?: Duration

    The function execution time (in seconds) after which Lambda terminates +

    Optional Readonlytimeout

    timeout?: Duration

    The function execution time (in seconds) after which Lambda terminates the function. Because the execution time affects cost, set this value based on the function's expected execution time.

    Default

    Duration.seconds(3)
@@ -375,8 +375,8 @@
 managed elsewhere by DevX.
    
 
    This is used by RiffRaffYamlFileExperimental to skip generating
 an uploadLambda step.
    
-

    OptionalwithoutFilePrefix

    withoutFilePrefix?: boolean

    Set to true to use the filename without the stage/stack/app prefix.

    +

    OptionalwithoutFilePrefix

    withoutFilePrefix?: boolean

    Set to true to use the filename without the stage/stack/app prefix.

    Typically you should not override this but you may need to if, for example, you are referencing a file that is shared across many apps and/or AWS accounts.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    adotInstrumentationallowAllIpv6OutboundallowAllOutboundallowPublicSubnetappapplicationLogLevelapplicationLogLevelV2architecturebucketNamePathcodeSigningConfigcurrentVersionOptionsdeadLetterQueuedeadLetterQueueEnableddeadLetterTopicdescriptionenableVersioningenvironmentenvironmentEncryptionephemeralStorageSizeerrorPercentageMonitoringeventsfileNamefilesystemfunctionNamehandlerinitialPolicyinsightsVersionipv6AllowedForDualStacklayerslogFormatloggingFormatlogGrouplogRetentionlogRetentionRetryOptionslogRetentionRolemaxEventAgememorySizeonFailureonSuccessparamsAndSecretsprofilingprofilingGrouprecursiveLoopreservedConcurrentExecutionsretryAttemptsroleruntimeruntimeManagementModesecurityGroupssnapStartsystemLogLevelsystemLogLevelV2throttlingMonitoringtimeouttracingvpcvpcSubnetswithoutArtifactUploadwithoutFilePrefix
    +

    Settings

    Member Visibility

    On This Page

    Properties
    adotInstrumentationallowAllIpv6OutboundallowAllOutboundallowPublicSubnetappapplicationLogLevelapplicationLogLevelV2architecturebucketNamePathcodeSigningConfigcurrentVersionOptionsdeadLetterQueuedeadLetterQueueEnableddeadLetterTopicdescriptionenableVersioningenvironmentenvironmentEncryptionephemeralStorageSizeerrorPercentageMonitoringeventsfileNamefilesystemfunctionNamehandlerinitialPolicyinsightsVersionipv6AllowedForDualStacklayerslogFormatloggingFormatlogGrouplogRetentionlogRetentionRetryOptionslogRetentionRolemaxEventAgememorySizeonFailureonSuccessparamsAndSecretsprofilingprofilingGrouprecursiveLoopreservedConcurrentExecutionsretryAttemptsroleruntimeruntimeManagementModesecurityGroupssnapStartsystemLogLevelsystemLogLevelV2throttlingMonitoringtimeouttracingvpcvpcSubnetswithoutArtifactUploadwithoutFilePrefix
    diff --git a/interfaces/constructs_loadbalancing.GuApplicationListenerProps.html b/interfaces/constructs_loadbalancing.GuApplicationListenerProps.html index 39860aa051..791c508fb8 100644 --- a/interfaces/constructs_loadbalancing.GuApplicationListenerProps.html +++ b/interfaces/constructs_loadbalancing.GuApplicationListenerProps.html @@ -1,4 +1,4 @@ -GuApplicationListenerProps | @guardian/cdk

    Interface GuApplicationListenerProps

    interface GuApplicationListenerProps {
        app: string;
        certificates?: IListenerCertificate[];
        defaultAction?: ListenerAction;
        defaultTargetGroups?: IApplicationTargetGroup[];
        loadBalancer: IApplicationLoadBalancer;
        mutualAuthentication?: MutualAuthentication;
        open?: boolean;
        port?: number;
        protocol?: ApplicationProtocol;
        sslPolicy?: SslPolicy;
    }

    Hierarchy (view full)

    • ApplicationListenerProps
    • AppIdentity
      • GuApplicationListenerProps

    Properties

    app +GuApplicationListenerProps | @guardian/cdk

    Interface GuApplicationListenerProps

    interface GuApplicationListenerProps {
        app: string;
        certificates?: IListenerCertificate[];
        defaultAction?: ListenerAction;
        defaultTargetGroups?: IApplicationTargetGroup[];
        loadBalancer: IApplicationLoadBalancer;
        mutualAuthentication?: MutualAuthentication;
        open?: boolean;
        port?: number;
        protocol?: ApplicationProtocol;
        sslPolicy?: SslPolicy;
    }

    Hierarchy (view full)

    • ApplicationListenerProps
    • AppIdentity
      • GuApplicationListenerProps

    Properties

    app certificates? defaultAction? defaultTargetGroups? @@ -8,7 +8,7 @@ port? protocol? sslPolicy? -

    Properties

    app

    app: string

    Optional Readonlycertificates

    certificates?: IListenerCertificate[]

    Certificate list of ACM cert ARNs. You must provide exactly one certificate if the listener protocol is HTTPS or TLS.

    +

    Properties

    app

    app: string

    Optional Readonlycertificates

    certificates?: IListenerCertificate[]

    Certificate list of ACM cert ARNs. You must provide exactly one certificate if the listener protocol is HTTPS or TLS.

    Default

    - No certificates.
    diff --git a/interfaces/constructs_loadbalancing.GuApplicationTargetGroupProps.html b/interfaces/constructs_loadbalancing.GuApplicationTargetGroupProps.html index d30aaee7b0..81514dabd0 100644 --- a/interfaces/constructs_loadbalancing.GuApplicationTargetGroupProps.html +++ b/interfaces/constructs_loadbalancing.GuApplicationTargetGroupProps.html @@ -1,4 +1,4 @@ -GuApplicationTargetGroupProps | @guardian/cdk

    Interface GuApplicationTargetGroupProps

    interface GuApplicationTargetGroupProps {
        app: string;
        deregistrationDelay?: Duration;
        enableAnomalyMitigation?: boolean;
        healthCheck?: HealthCheck;
        loadBalancingAlgorithmType?: TargetGroupLoadBalancingAlgorithmType;
        port?: number;
        protocol?: ApplicationProtocol;
        protocolVersion?: ApplicationProtocolVersion;
        slowStart?: Duration;
        stickinessCookieDuration?: Duration;
        stickinessCookieName?: string;
        targetGroupName?: string;
        targets?: IApplicationLoadBalancerTarget[];
        targetType?: TargetType;
        vpc?: IVpc;
    }

    Hierarchy (view full)

    • ApplicationTargetGroupProps
    • AppIdentity
      • GuApplicationTargetGroupProps

    Properties

    app +GuApplicationTargetGroupProps | @guardian/cdk

    Interface GuApplicationTargetGroupProps

    interface GuApplicationTargetGroupProps {
        app: string;
        deregistrationDelay?: Duration;
        enableAnomalyMitigation?: boolean;
        healthCheck?: HealthCheck;
        loadBalancingAlgorithmType?: TargetGroupLoadBalancingAlgorithmType;
        port?: number;
        protocol?: ApplicationProtocol;
        protocolVersion?: ApplicationProtocolVersion;
        slowStart?: Duration;
        stickinessCookieDuration?: Duration;
        stickinessCookieName?: string;
        targetGroupName?: string;
        targets?: IApplicationLoadBalancerTarget[];
        targetType?: TargetType;
        vpc?: IVpc;
    }

    Hierarchy (view full)

    • ApplicationTargetGroupProps
    • AppIdentity
      • GuApplicationTargetGroupProps

    Properties

    app deregistrationDelay? enableAnomalyMitigation? healthCheck? @@ -13,7 +13,7 @@ targets? targetType? vpc? -

    Properties

    app

    app: string

    Optional ReadonlyderegistrationDelay

    deregistrationDelay?: Duration

    The amount of time for Elastic Load Balancing to wait before deregistering a target.

    +

    Properties

    app

    app: string

    Optional ReadonlyderegistrationDelay

    deregistrationDelay?: Duration

    The amount of time for Elastic Load Balancing to wait before deregistering a target.

    The range is 0-3600 seconds.

    Default

    300
    diff --git a/interfaces/constructs_loadbalancing.GuHttpsApplicationListenerProps.html b/interfaces/constructs_loadbalancing.GuHttpsApplicationListenerProps.html index 619aa322f1..46425d34c4 100644 --- a/interfaces/constructs_loadbalancing.GuHttpsApplicationListenerProps.html +++ b/interfaces/constructs_loadbalancing.GuHttpsApplicationListenerProps.html @@ -1,4 +1,4 @@ -GuHttpsApplicationListenerProps | @guardian/cdk

    Interface GuHttpsApplicationListenerProps

    interface GuHttpsApplicationListenerProps {
        app: string;
        certificate?: GuCertificate;
        defaultTargetGroups?: IApplicationTargetGroup[];
        loadBalancer: IApplicationLoadBalancer;
        mutualAuthentication?: MutualAuthentication;
        open?: boolean;
        port?: number;
        protocol?: ApplicationProtocol;
        sslPolicy?: SslPolicy;
        targetGroup: GuApplicationTargetGroup;
    }

    Hierarchy (view full)

    Properties

    app +GuHttpsApplicationListenerProps | @guardian/cdk

    Interface GuHttpsApplicationListenerProps

    interface GuHttpsApplicationListenerProps {
        app: string;
        certificate?: GuCertificate;
        defaultTargetGroups?: IApplicationTargetGroup[];
        loadBalancer: IApplicationLoadBalancer;
        mutualAuthentication?: MutualAuthentication;
        open?: boolean;
        port?: number;
        protocol?: ApplicationProtocol;
        sslPolicy?: SslPolicy;
        targetGroup: GuApplicationTargetGroup;
    }

    Hierarchy (view full)

    Properties

    app certificate? defaultTargetGroups? loadBalancer @@ -8,7 +8,7 @@ protocol? sslPolicy? targetGroup -

    Properties

    app

    app: string

    Optionalcertificate

    certificate?: GuCertificate

    Optional ReadonlydefaultTargetGroups

    defaultTargetGroups?: IApplicationTargetGroup[]

    Default target groups to load balance to

    +

    Properties

    app

    app: string

    Optionalcertificate

    certificate?: GuCertificate

    Optional ReadonlydefaultTargetGroups

    defaultTargetGroups?: IApplicationTargetGroup[]

    Default target groups to load balance to

    All target groups will be load balanced to with equal weight and without stickiness. For a more complex configuration than that, use either defaultAction or addAction().

    @@ -44,4 +44,4 @@

    Default

    - The current predefined security policy.
    -

    targetGroup

    targetGroup: GuApplicationTargetGroup

    Settings

    Member Visibility

    On This Page

    Properties
    +

    targetGroup

    targetGroup: GuApplicationTargetGroup

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_rds.GuDatabaseInstanceProps.html b/interfaces/constructs_rds.GuDatabaseInstanceProps.html index dbcc5a6fed..1560b2b086 100644 --- a/interfaces/constructs_rds.GuDatabaseInstanceProps.html +++ b/interfaces/constructs_rds.GuDatabaseInstanceProps.html @@ -1,4 +1,4 @@ -GuDatabaseInstanceProps | @guardian/cdk

    Interface GuDatabaseInstanceProps

    interface GuDatabaseInstanceProps {
        allocatedStorage?: number;
        allowMajorVersionUpgrade?: boolean;
        app: string;
        autoMinorVersionUpgrade?: boolean;
        availabilityZone?: string;
        caCertificate?: CaCertificate;
        characterSetName?: string;
        cloudwatchLogsExports?: string[];
        cloudwatchLogsRetention?: RetentionDays;
        cloudwatchLogsRetentionRole?: IRole;
        copyTagsToSnapshot?: boolean;
        credentials?: Credentials;
        databaseName?: string;
        deleteAutomatedBackups?: boolean;
        deletionProtection?: boolean;
        devXBackups: OptIn | OptOut;
        domain?: string;
        domainRole?: IRole;
        enablePerformanceInsights?: boolean;
        engine: IInstanceEngine;
        iamAuthentication?: boolean;
        instanceIdentifier?: string;
        instanceType: string;
        iops?: number;
        licenseModel?: LicenseModel;
        maxAllocatedStorage?: number;
        monitoringInterval?: Duration;
        monitoringRole?: IRole;
        multiAz?: boolean;
        networkType?: NetworkType;
        optionGroup?: IOptionGroup;
        parameterGroup?: IParameterGroup;
        parameters?: {
            [key: string]: string;
        };
        performanceInsightEncryptionKey?: IKey;
        performanceInsightRetention?: PerformanceInsightRetention;
        port?: number;
        preferredMaintenanceWindow?: string;
        processorFeatures?: ProcessorFeatures;
        publiclyAccessible?: boolean;
        removalPolicy?: RemovalPolicy;
        s3ExportBuckets?: IBucket[];
        s3ExportRole?: IRole;
        s3ImportBuckets?: IBucket[];
        s3ImportRole?: IRole;
        securityGroups?: ISecurityGroup[];
        storageEncrypted?: boolean;
        storageEncryptionKey?: IKey;
        storageThroughput?: number;
        storageType?: StorageType;
        subnetGroup?: ISubnetGroup;
        timezone?: string;
        vpc: IVpc;
        vpcSubnets?: SubnetSelection;
    }

    Hierarchy (view full)

    • Omit<DatabaseInstanceProps, "instanceType" | "backupRetention" | "preferredBackupWindow">
    • AppIdentity
      • GuDatabaseInstanceProps

    Properties

    allocatedStorage? +GuDatabaseInstanceProps | @guardian/cdk

    Interface GuDatabaseInstanceProps

    interface GuDatabaseInstanceProps {
        allocatedStorage?: number;
        allowMajorVersionUpgrade?: boolean;
        app: string;
        autoMinorVersionUpgrade?: boolean;
        availabilityZone?: string;
        caCertificate?: CaCertificate;
        characterSetName?: string;
        cloudwatchLogsExports?: string[];
        cloudwatchLogsRetention?: RetentionDays;
        cloudwatchLogsRetentionRole?: IRole;
        copyTagsToSnapshot?: boolean;
        credentials?: Credentials;
        databaseName?: string;
        deleteAutomatedBackups?: boolean;
        deletionProtection?: boolean;
        devXBackups: OptIn | OptOut;
        domain?: string;
        domainRole?: IRole;
        enablePerformanceInsights?: boolean;
        engine: IInstanceEngine;
        iamAuthentication?: boolean;
        instanceIdentifier?: string;
        instanceType: string;
        iops?: number;
        licenseModel?: LicenseModel;
        maxAllocatedStorage?: number;
        monitoringInterval?: Duration;
        monitoringRole?: IRole;
        multiAz?: boolean;
        networkType?: NetworkType;
        optionGroup?: IOptionGroup;
        parameterGroup?: IParameterGroup;
        parameters?: {
            [key: string]: string;
        };
        performanceInsightEncryptionKey?: IKey;
        performanceInsightRetention?: PerformanceInsightRetention;
        port?: number;
        preferredMaintenanceWindow?: string;
        processorFeatures?: ProcessorFeatures;
        publiclyAccessible?: boolean;
        removalPolicy?: RemovalPolicy;
        s3ExportBuckets?: IBucket[];
        s3ExportRole?: IRole;
        s3ImportBuckets?: IBucket[];
        s3ImportRole?: IRole;
        securityGroups?: ISecurityGroup[];
        storageEncrypted?: boolean;
        storageEncryptionKey?: IKey;
        storageThroughput?: number;
        storageType?: StorageType;
        subnetGroup?: ISubnetGroup;
        timezone?: string;
        vpc: IVpc;
        vpcSubnets?: SubnetSelection;
    }

    Hierarchy (view full)

    • Omit<DatabaseInstanceProps, "instanceType" | "backupRetention" | "preferredBackupWindow">
    • AppIdentity
      • GuDatabaseInstanceProps

    Properties

    allocatedStorage? allowMajorVersionUpgrade? app autoMinorVersionUpgrade? @@ -59,7 +59,7 @@

    Default

    false
    -

    app

    app: string

    Optional ReadonlyautoMinorVersionUpgrade

    autoMinorVersionUpgrade?: boolean

    Indicates that minor engine upgrades are applied automatically to the +

    app

    app: string

    Optional ReadonlyautoMinorVersionUpgrade

    autoMinorVersionUpgrade?: boolean

    Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

    Default

    true
    @@ -125,7 +125,7 @@

    devXBackups

    devXBackups: OptIn | OptOut

    We recommend using DevX Backups to protect your RDS instance's backups. For more details on this feature, see the documentation.

    -

    Optional Readonlydomain

    domain?: string

    The Active Directory directory ID to create the DB instance in.

    +

    Optional Readonlydomain

    domain?: string

    The Active Directory directory ID to create the DB instance in.

    Default

    - Do not join domain
    @@ -149,7 +149,7 @@

    Default

    - a CloudFormation generated name
    -

    instanceType

    instanceType: string

    Optional Readonlyiops

    iops?: number

    The number of I/O operations per second (IOPS) that the database provisions. +

    instanceType

    instanceType: string

    Optional Readonlyiops

    iops?: number

    The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000.

    Default

    - no provisioned iops if storage type is not specified. For GP3: 3,000 IOPS if allocated
    storage is less than 400 GiB for MariaDB, MySQL, and PostgreSQL, less than 200 GiB for Oracle and
    less than 20 GiB for SQL Server. 12,000 IOPS otherwise (except for SQL Server where the default is
    always 3,000 IOPS).
    diff --git a/interfaces/constructs_rds.OptIn.html b/interfaces/constructs_rds.OptIn.html index 006ff9b9b3..1f6852b6de 100644 --- a/interfaces/constructs_rds.OptIn.html +++ b/interfaces/constructs_rds.OptIn.html @@ -1,2 +1,2 @@ -OptIn | @guardian/cdk

    Interface OptIn

    interface OptIn {
        enabled: true;
    }

    Properties

    enabled -

    Properties

    enabled

    enabled

    Settings

    Member Visibility

    On This Page

    Properties
    +OptIn | @guardian/cdk

    Interface OptIn

    interface OptIn {
        enabled: true;
    }

    Properties

    enabled +

    Properties

    enabled

    enabled

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/constructs_rds.OptOut.html b/interfaces/constructs_rds.OptOut.html index 24e5e923a5..ef567aa8bb 100644 --- a/interfaces/constructs_rds.OptOut.html +++ b/interfaces/constructs_rds.OptOut.html @@ -1,4 +1,4 @@ -OptOut | @guardian/cdk

    Interface OptOut

    interface OptOut {
        backupRetention?: Duration;
        enabled: false;
        optOutReason: string;
        preferredBackupWindow?: string;
    }

    Hierarchy

    • Pick<DatabaseInstanceProps, "backupRetention" | "preferredBackupWindow">
      • OptOut

    Properties

    backupRetention? +OptOut | @guardian/cdk

    Interface OptOut

    interface OptOut {
        backupRetention?: Duration;
        enabled: false;
        optOutReason: string;
        preferredBackupWindow?: string;
    }

    Hierarchy

    • Pick<DatabaseInstanceProps, "backupRetention" | "preferredBackupWindow">
      • OptOut

    Properties

    backupRetention? enabled optOutReason preferredBackupWindow? @@ -9,9 +9,9 @@

    Default

    - Duration.days(1) for source instances, disabled for read replicas
    -

    enabled

    enabled

    optOutReason

    optOutReason: string

    We recommend using DevX Backups where possible. If it is not suitable for your use-case please document +

    enabled

    enabled

    optOutReason

    optOutReason: string

    We recommend using DevX Backups where possible. If it is not suitable for your use-case please document this here so that we can understand why this is switched off when performing security audits.

    -

    Optional ReadonlypreferredBackupWindow

    preferredBackupWindow?: string

    The daily time range during which automated backups are performed.

    +

    Optional ReadonlypreferredBackupWindow

    preferredBackupWindow?: string

    The daily time range during which automated backups are performed.

    Constraints:

    domainName

    domainName: string

    Optional ReadonlyfeedbackForwarding

    feedbackForwarding?: boolean

    Whether to receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email.

    You're required to have a method of tracking bounces and complaints. If you haven't set diff --git a/interfaces/experimental_patterns.ExistingKinesisStream.html b/interfaces/experimental_patterns.ExistingKinesisStream.html index 233c978b85..acf9712f25 100644 --- a/interfaces/experimental_patterns.ExistingKinesisStream.html +++ b/interfaces/experimental_patterns.ExistingKinesisStream.html @@ -1,5 +1,5 @@ ExistingKinesisStream | @guardian/cdk

    Interface ExistingKinesisStream

    Used to provide information about an existing Kinesis stream to the [[GuKinesisLambda]] pattern.

    Specify an externalKinesisStreamName to link the lambda to a Kinesis stream owned by a different stack (or created outside of version control).

    -
    interface ExistingKinesisStream {
        externalKinesisStreamName: string;
    }

    Properties

    externalKinesisStreamName -

    Properties

    externalKinesisStreamName

    externalKinesisStreamName: string

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface ExistingKinesisStream {
        externalKinesisStreamName: string;
    }

    Properties

    externalKinesisStreamName +

    Properties

    externalKinesisStreamName

    externalKinesisStreamName: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/experimental_patterns.ExistingSnsTopic.html b/interfaces/experimental_patterns.ExistingSnsTopic.html index 672f5fed10..9c3a28cc2d 100644 --- a/interfaces/experimental_patterns.ExistingSnsTopic.html +++ b/interfaces/experimental_patterns.ExistingSnsTopic.html @@ -1,5 +1,5 @@ ExistingSnsTopic | @guardian/cdk

    Interface ExistingSnsTopic

    Used to provide information about an existing SNS topic to the [[GuSnsLambda]] pattern.

    Specify an externalTopicName to link the lambda to an SNS topic owned by a different stack (or created outside of version control).

    -
    interface ExistingSnsTopic {
        externalTopicName: string;
    }

    Properties

    externalTopicName -

    Properties

    externalTopicName

    externalTopicName: string

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface ExistingSnsTopic {
        externalTopicName: string;
    }

    Properties

    externalTopicName +

    Properties

    externalTopicName

    externalTopicName: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/experimental_patterns.GuKinesisLambdaProps.html b/interfaces/experimental_patterns.GuKinesisLambdaProps.html index 13e316e215..be65755a87 100644 --- a/interfaces/experimental_patterns.GuKinesisLambdaProps.html +++ b/interfaces/experimental_patterns.GuKinesisLambdaProps.html @@ -20,7 +20,7 @@ 
     monitoringConfiguration: { noMonitoring: true } as NoMonitoring
    -
    interface GuKinesisLambdaProps {
        adotInstrumentation?: AdotInstrumentationConfig;
        allowAllIpv6Outbound?: boolean;
        allowAllOutbound?: boolean;
        allowPublicSubnet?: boolean;
        app: string;
        applicationLogLevel?: string;
        applicationLogLevelV2?: ApplicationLogLevel;
        architecture?: Architecture;
        bucketNamePath?: string;
        codeSigningConfig?: ICodeSigningConfig;
        currentVersionOptions?: VersionOptions;
        deadLetterQueue?: IQueue;
        deadLetterQueueEnabled?: boolean;
        deadLetterTopic?: ITopic;
        description?: string;
        enableVersioning?: boolean;
        environment?: {
            [key: string]: string;
        };
        environmentEncryption?: IKey;
        ephemeralStorageSize?: Size;
        errorHandlingConfiguration: StreamErrorHandlingProps;
        events?: IEventSource[];
        existingKinesisStream?: ExistingKinesisStream;
        fileName: string;
        filesystem?: FileSystem;
        functionName?: string;
        handler: string;
        initialPolicy?: PolicyStatement[];
        insightsVersion?: LambdaInsightsVersion;
        ipv6AllowedForDualStack?: boolean;
        kinesisStreamProps?: StreamProps;
        layers?: ILayerVersion[];
        logFormat?: string;
        loggingFormat?: LoggingFormat;
        logGroup?: ILogGroup;
        logRetention?: RetentionDays;
        logRetentionRetryOptions?: LogRetentionRetryOptions;
        logRetentionRole?: IRole;
        maxEventAge?: Duration;
        memorySize?: number;
        monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring;
        onFailure?: IDestination;
        onSuccess?: IDestination;
        paramsAndSecrets?: ParamsAndSecretsLayerVersion;
        processingProps?: StreamProcessingProps;
        profiling?: boolean;
        profilingGroup?: IProfilingGroup;
        recursiveLoop?: RecursiveLoop;
        reservedConcurrentExecutions?: number;
        retryAttempts?: number;
        role?: IRole;
        runtime: Runtime;
        runtimeManagementMode?: RuntimeManagementMode;
        securityGroups?: ISecurityGroup[];
        snapStart?: SnapStartConf;
        systemLogLevel?: string;
        systemLogLevelV2?: SystemLogLevel;
        throttlingMonitoring?: GuLambdaThrottlingMonitoringProps;
        timeout?: Duration;
        tracing?: Tracing;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection;
        withoutArtifactUpload?: boolean;
        withoutFilePrefix?: boolean;
    }

    Hierarchy

    Properties

    adotInstrumentation? +
    interface GuKinesisLambdaProps {
        adotInstrumentation?: AdotInstrumentationConfig;
        allowAllIpv6Outbound?: boolean;
        allowAllOutbound?: boolean;
        allowPublicSubnet?: boolean;
        app: string;
        applicationLogLevel?: string;
        applicationLogLevelV2?: ApplicationLogLevel;
        architecture?: Architecture;
        bucketNamePath?: string;
        codeSigningConfig?: ICodeSigningConfig;
        currentVersionOptions?: VersionOptions;
        deadLetterQueue?: IQueue;
        deadLetterQueueEnabled?: boolean;
        deadLetterTopic?: ITopic;
        description?: string;
        enableVersioning?: boolean;
        environment?: {
            [key: string]: string;
        };
        environmentEncryption?: IKey;
        ephemeralStorageSize?: Size;
        errorHandlingConfiguration: StreamErrorHandlingProps;
        events?: IEventSource[];
        existingKinesisStream?: ExistingKinesisStream;
        fileName: string;
        filesystem?: FileSystem;
        functionName?: string;
        handler: string;
        initialPolicy?: PolicyStatement[];
        insightsVersion?: LambdaInsightsVersion;
        ipv6AllowedForDualStack?: boolean;
        kinesisStreamProps?: StreamProps;
        layers?: ILayerVersion[];
        logFormat?: string;
        loggingFormat?: LoggingFormat;
        logGroup?: ILogGroup;
        logRetention?: RetentionDays;
        logRetentionRetryOptions?: LogRetentionRetryOptions;
        logRetentionRole?: IRole;
        maxEventAge?: Duration;
        memorySize?: number;
        monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring;
        onFailure?: IDestination;
        onSuccess?: IDestination;
        paramsAndSecrets?: ParamsAndSecretsLayerVersion;
        processingProps?: StreamProcessingProps;
        profiling?: boolean;
        profilingGroup?: IProfilingGroup;
        recursiveLoop?: RecursiveLoop;
        reservedConcurrentExecutions?: number;
        retryAttempts?: number;
        role?: IRole;
        runtime: Runtime;
        runtimeManagementMode?: RuntimeManagementMode;
        securityGroups?: ISecurityGroup[];
        snapStart?: SnapStartConf;
        systemLogLevel?: string;
        systemLogLevelV2?: SystemLogLevel;
        throttlingMonitoring?: GuLambdaThrottlingMonitoringProps;
        timeout?: Duration;
        tracing?: Tracing;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection;
        withoutArtifactUpload?: boolean;
        withoutFilePrefix?: boolean;
    }

    Hierarchy

    Properties

    adotInstrumentation? allowAllIpv6Outbound? allowAllOutbound? allowPublicSubnet? @@ -111,7 +111,7 @@

    Default

    false
    -

    app

    app: string

    Optional ReadonlyapplicationLogLevel

    applicationLogLevel?: string

    Sets the application log level for the function.

    +

    app

    app: string

    Optional ReadonlyapplicationLogLevel

    applicationLogLevel?: string

    Sets the application log level for the function.

    Deprecated

    Use applicationLogLevelV2 as a property instead.

    Default

    "INFO"
    @@ -129,7 +129,7 @@ you are referencing a file that is shared across many apps and/or AWS accounts.

    Default Value

    [[GuDistributionBucketParameter]]

    -

    Optional ReadonlycodeSigningConfig

    codeSigningConfig?: ICodeSigningConfig

    Code signing config associated with this function

    +

    Optional ReadonlycodeSigningConfig

    codeSigningConfig?: ICodeSigningConfig

    Code signing config associated with this function

    Default

    - Not Sign the Code
    @@ -162,7 +162,7 @@ on versioning (e.g. SnapStart or Provisioned Concurrency).

    If you enable versioning you must ensure that your Lambda function is updated whenever a new build is deployed via CloudFormation. The simplest way to do this is to include the build number in the fileName prop.

    -

    Optional Readonlyenvironment

    environment?: {
        [key: string]: string;
    }

    Key-value pairs that Lambda caches and makes available for your Lambda +

    Optional Readonlyenvironment

    environment?: {
        [key: string]: string;
    }

    Key-value pairs that Lambda caches and makes available for your Lambda functions. Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Lambda function source code.

    @@ -177,14 +177,14 @@

    Default

    512 MiB
    -

    errorHandlingConfiguration

    errorHandlingConfiguration: StreamErrorHandlingProps

    Optional Readonlyevents

    events?: IEventSource[]

    Event sources for this function.

    +

    errorHandlingConfiguration

    errorHandlingConfiguration: StreamErrorHandlingProps

    Optional Readonlyevents

    events?: IEventSource[]

    Event sources for this function.

    You can also add event sources using addEventSource.

    Default

    - No event sources.
    -

    OptionalexistingKinesisStream

    existingKinesisStream?: ExistingKinesisStream

    fileName

    fileName: string

    The filename for an executable package within the bucket [[GuDistributionBucketParameter]]. +

    OptionalexistingKinesisStream

    existingKinesisStream?: ExistingKinesisStream

    fileName

    fileName: string

    The filename for an executable package within the bucket [[GuDistributionBucketParameter]]. We'll look for fileName on the path "bucket/stack/stage/app/".

    -

    Optional Readonlyfilesystem

    filesystem?: FileSystem

    The filesystem configuration for the lambda function

    +

    Optional Readonlyfilesystem

    filesystem?: FileSystem

    The filesystem configuration for the lambda function

    Default

    - will not mount any filesystem
    @@ -222,7 +222,7 @@

    Default

    false
    -

    OptionalkinesisStreamProps

    kinesisStreamProps?: StreamProps

    Optional Readonlylayers

    layers?: ILayerVersion[]

    A list of layers to add to the function's execution environment. You can configure your Lambda function to pull in +

    OptionalkinesisStreamProps

    kinesisStreamProps?: StreamProps

    Optional Readonlylayers

    layers?: ILayerVersion[]

    A list of layers to add to the function's execution environment. You can configure your Lambda function to pull in additional code during initialization in the form of layers. Layers are packages of libraries or other dependencies that can be used by multiple functions.

    Default

    - No layers.
@@ -287,7 +287,7 @@

    Default

    128
    -

    monitoringConfiguration

    monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring

    Optional ReadonlyonFailure

    onFailure?: IDestination

    The destination for failed invocations.

    +

    monitoringConfiguration

    monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring

    Optional ReadonlyonFailure

    onFailure?: IDestination

    The destination for failed invocations.

    Default

    - no destination
    @@ -303,7 +303,7 @@

    Default

    - No Parameters and Secrets Extension
    -

    OptionalprocessingProps

    processingProps?: StreamProcessingProps

    Optional Readonlyprofiling

    profiling?: boolean

    Enable profiling.

    +

    OptionalprocessingProps

    processingProps?: StreamProcessingProps

    Optional Readonlyprofiling

    profiling?: boolean

    Enable profiling.

    See

    https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html

    Default

    - No profiling.
    @@ -372,7 +372,7 @@ concurrency limit (the reservedConcurrentExecutions prop) if you are concerned about throttling.

    See

    https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html

    -

    Optional Readonlytimeout

    timeout?: Duration

    The function execution time (in seconds) after which Lambda terminates +

    Optional Readonlytimeout

    timeout?: Duration

    The function execution time (in seconds) after which Lambda terminates the function. Because the execution time affects cost, set this value based on the function's expected execution time.

    Default

    Duration.seconds(3)
@@ -400,8 +400,8 @@
 managed elsewhere by DevX.
    
 
    This is used by RiffRaffYamlFileExperimental to skip generating
 an uploadLambda step.
    
-

    OptionalwithoutFilePrefix

    withoutFilePrefix?: boolean

    Set to true to use the filename without the stage/stack/app prefix.

    +

    OptionalwithoutFilePrefix

    withoutFilePrefix?: boolean

    Set to true to use the filename without the stage/stack/app prefix.

    Typically you should not override this but you may need to if, for example, you are referencing a file that is shared across many apps and/or AWS accounts.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    adotInstrumentationallowAllIpv6OutboundallowAllOutboundallowPublicSubnetappapplicationLogLevelapplicationLogLevelV2architecturebucketNamePathcodeSigningConfigcurrentVersionOptionsdeadLetterQueuedeadLetterQueueEnableddeadLetterTopicdescriptionenableVersioningenvironmentenvironmentEncryptionephemeralStorageSizeerrorHandlingConfigurationeventsexistingKinesisStreamfileNamefilesystemfunctionNamehandlerinitialPolicyinsightsVersionipv6AllowedForDualStackkinesisStreamPropslayerslogFormatloggingFormatlogGrouplogRetentionlogRetentionRetryOptionslogRetentionRolemaxEventAgememorySizemonitoringConfigurationonFailureonSuccessparamsAndSecretsprocessingPropsprofilingprofilingGrouprecursiveLoopreservedConcurrentExecutionsretryAttemptsroleruntimeruntimeManagementModesecurityGroupssnapStartsystemLogLevelsystemLogLevelV2throttlingMonitoringtimeouttracingvpcvpcSubnetswithoutArtifactUploadwithoutFilePrefix
    +

    Settings

    Member Visibility

    On This Page

    Properties
    adotInstrumentationallowAllIpv6OutboundallowAllOutboundallowPublicSubnetappapplicationLogLevelapplicationLogLevelV2architecturebucketNamePathcodeSigningConfigcurrentVersionOptionsdeadLetterQueuedeadLetterQueueEnableddeadLetterTopicdescriptionenableVersioningenvironmentenvironmentEncryptionephemeralStorageSizeerrorHandlingConfigurationeventsexistingKinesisStreamfileNamefilesystemfunctionNamehandlerinitialPolicyinsightsVersionipv6AllowedForDualStackkinesisStreamPropslayerslogFormatloggingFormatlogGrouplogRetentionlogRetentionRetryOptionslogRetentionRolemaxEventAgememorySizemonitoringConfigurationonFailureonSuccessparamsAndSecretsprocessingPropsprofilingprofilingGrouprecursiveLoopreservedConcurrentExecutionsretryAttemptsroleruntimeruntimeManagementModesecurityGroupssnapStartsystemLogLevelsystemLogLevelV2throttlingMonitoringtimeouttracingvpcvpcSubnetswithoutArtifactUploadwithoutFilePrefix
    diff --git a/interfaces/experimental_patterns.GuSnsLambdaProps.html b/interfaces/experimental_patterns.GuSnsLambdaProps.html index 63b9c79f4b..20870c1261 100644 --- a/interfaces/experimental_patterns.GuSnsLambdaProps.html +++ b/interfaces/experimental_patterns.GuSnsLambdaProps.html @@ -14,7 +14,7 @@ 
     monitoringConfiguration: { noMonitoring: true } as NoMonitoring
    -
    interface GuSnsLambdaProps {
        adotInstrumentation?: AdotInstrumentationConfig;
        allowAllIpv6Outbound?: boolean;
        allowAllOutbound?: boolean;
        allowPublicSubnet?: boolean;
        app: string;
        applicationLogLevel?: string;
        applicationLogLevelV2?: ApplicationLogLevel;
        architecture?: Architecture;
        bucketNamePath?: string;
        codeSigningConfig?: ICodeSigningConfig;
        currentVersionOptions?: VersionOptions;
        deadLetterQueue?: IQueue;
        deadLetterQueueEnabled?: boolean;
        deadLetterTopic?: ITopic;
        description?: string;
        enableVersioning?: boolean;
        environment?: {
            [key: string]: string;
        };
        environmentEncryption?: IKey;
        ephemeralStorageSize?: Size;
        events?: IEventSource[];
        existingSnsTopic?: ExistingSnsTopic;
        fileName: string;
        filesystem?: FileSystem;
        functionName?: string;
        handler: string;
        initialPolicy?: PolicyStatement[];
        insightsVersion?: LambdaInsightsVersion;
        ipv6AllowedForDualStack?: boolean;
        layers?: ILayerVersion[];
        logFormat?: string;
        loggingFormat?: LoggingFormat;
        logGroup?: ILogGroup;
        logRetention?: RetentionDays;
        logRetentionRetryOptions?: LogRetentionRetryOptions;
        logRetentionRole?: IRole;
        maxEventAge?: Duration;
        memorySize?: number;
        monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring;
        onFailure?: IDestination;
        onSuccess?: IDestination;
        paramsAndSecrets?: ParamsAndSecretsLayerVersion;
        profiling?: boolean;
        profilingGroup?: IProfilingGroup;
        recursiveLoop?: RecursiveLoop;
        reservedConcurrentExecutions?: number;
        retryAttempts?: number;
        role?: IRole;
        runtime: Runtime;
        runtimeManagementMode?: RuntimeManagementMode;
        securityGroups?: ISecurityGroup[];
        snapStart?: SnapStartConf;
        systemLogLevel?: string;
        systemLogLevelV2?: SystemLogLevel;
        throttlingMonitoring?: GuLambdaThrottlingMonitoringProps;
        timeout?: Duration;
        tracing?: Tracing;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection;
        withoutArtifactUpload?: boolean;
        withoutFilePrefix?: boolean;
    }

    Hierarchy

    Properties

    adotInstrumentation? +
    interface GuSnsLambdaProps {
        adotInstrumentation?: AdotInstrumentationConfig;
        allowAllIpv6Outbound?: boolean;
        allowAllOutbound?: boolean;
        allowPublicSubnet?: boolean;
        app: string;
        applicationLogLevel?: string;
        applicationLogLevelV2?: ApplicationLogLevel;
        architecture?: Architecture;
        bucketNamePath?: string;
        codeSigningConfig?: ICodeSigningConfig;
        currentVersionOptions?: VersionOptions;
        deadLetterQueue?: IQueue;
        deadLetterQueueEnabled?: boolean;
        deadLetterTopic?: ITopic;
        description?: string;
        enableVersioning?: boolean;
        environment?: {
            [key: string]: string;
        };
        environmentEncryption?: IKey;
        ephemeralStorageSize?: Size;
        events?: IEventSource[];
        existingSnsTopic?: ExistingSnsTopic;
        fileName: string;
        filesystem?: FileSystem;
        functionName?: string;
        handler: string;
        initialPolicy?: PolicyStatement[];
        insightsVersion?: LambdaInsightsVersion;
        ipv6AllowedForDualStack?: boolean;
        layers?: ILayerVersion[];
        logFormat?: string;
        loggingFormat?: LoggingFormat;
        logGroup?: ILogGroup;
        logRetention?: RetentionDays;
        logRetentionRetryOptions?: LogRetentionRetryOptions;
        logRetentionRole?: IRole;
        maxEventAge?: Duration;
        memorySize?: number;
        monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring;
        onFailure?: IDestination;
        onSuccess?: IDestination;
        paramsAndSecrets?: ParamsAndSecretsLayerVersion;
        profiling?: boolean;
        profilingGroup?: IProfilingGroup;
        recursiveLoop?: RecursiveLoop;
        reservedConcurrentExecutions?: number;
        retryAttempts?: number;
        role?: IRole;
        runtime: Runtime;
        runtimeManagementMode?: RuntimeManagementMode;
        securityGroups?: ISecurityGroup[];
        snapStart?: SnapStartConf;
        systemLogLevel?: string;
        systemLogLevelV2?: SystemLogLevel;
        throttlingMonitoring?: GuLambdaThrottlingMonitoringProps;
        timeout?: Duration;
        tracing?: Tracing;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection;
        withoutArtifactUpload?: boolean;
        withoutFilePrefix?: boolean;
    }

    Hierarchy

    Properties

    adotInstrumentation? allowAllIpv6Outbound? allowAllOutbound? allowPublicSubnet? @@ -102,7 +102,7 @@

    Default

    false
    -

    app

    app: string

    Optional ReadonlyapplicationLogLevel

    applicationLogLevel?: string

    Sets the application log level for the function.

    +

    app

    app: string

    Optional ReadonlyapplicationLogLevel

    applicationLogLevel?: string

    Sets the application log level for the function.

    Deprecated

    Use applicationLogLevelV2 as a property instead.

    Default

    "INFO"
    @@ -120,7 +120,7 @@ you are referencing a file that is shared across many apps and/or AWS accounts.

    Default Value

    [[GuDistributionBucketParameter]]

    -

    Optional ReadonlycodeSigningConfig

    codeSigningConfig?: ICodeSigningConfig

    Code signing config associated with this function

    +

    Optional ReadonlycodeSigningConfig

    codeSigningConfig?: ICodeSigningConfig

    Code signing config associated with this function

    Default

    - Not Sign the Code
    @@ -153,7 +153,7 @@ on versioning (e.g. SnapStart or Provisioned Concurrency).

    If you enable versioning you must ensure that your Lambda function is updated whenever a new build is deployed via CloudFormation. The simplest way to do this is to include the build number in the fileName prop.

    -

    Optional Readonlyenvironment

    environment?: {
        [key: string]: string;
    }

    Key-value pairs that Lambda caches and makes available for your Lambda +

    Optional Readonlyenvironment

    environment?: {
        [key: string]: string;
    }

    Key-value pairs that Lambda caches and makes available for your Lambda functions. Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Lambda function source code.

    @@ -173,9 +173,9 @@

    Default

    - No event sources.
    -

    OptionalexistingSnsTopic

    existingSnsTopic?: ExistingSnsTopic

    fileName

    fileName: string

    The filename for an executable package within the bucket [[GuDistributionBucketParameter]]. +

    OptionalexistingSnsTopic

    existingSnsTopic?: ExistingSnsTopic

    fileName

    fileName: string

    The filename for an executable package within the bucket [[GuDistributionBucketParameter]]. We'll look for fileName on the path "bucket/stack/stage/app/".

    -

    Optional Readonlyfilesystem

    filesystem?: FileSystem

    The filesystem configuration for the lambda function

    +

    Optional Readonlyfilesystem

    filesystem?: FileSystem

    The filesystem configuration for the lambda function

    Default

    - will not mount any filesystem
    @@ -278,7 +278,7 @@

    Default

    128
    -

    monitoringConfiguration

    monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring

    Optional ReadonlyonFailure

    onFailure?: IDestination

    The destination for failed invocations.

    +

    monitoringConfiguration

    monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring

    Optional ReadonlyonFailure

    onFailure?: IDestination

    The destination for failed invocations.

    Default

    - no destination
    @@ -363,7 +363,7 @@ concurrency limit (the reservedConcurrentExecutions prop) if you are concerned about throttling.

    See

    https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html

    -

    Optional Readonlytimeout

    timeout?: Duration

    The function execution time (in seconds) after which Lambda terminates +

    Optional Readonlytimeout

    timeout?: Duration

    The function execution time (in seconds) after which Lambda terminates the function. Because the execution time affects cost, set this value based on the function's expected execution time.

    Default

    Duration.seconds(3)
@@ -391,8 +391,8 @@
 managed elsewhere by DevX.
    
 
    This is used by RiffRaffYamlFileExperimental to skip generating
 an uploadLambda step.
    
-

    OptionalwithoutFilePrefix

    withoutFilePrefix?: boolean

    Set to true to use the filename without the stage/stack/app prefix.

    +

    OptionalwithoutFilePrefix

    withoutFilePrefix?: boolean

    Set to true to use the filename without the stage/stack/app prefix.

    Typically you should not override this but you may need to if, for example, you are referencing a file that is shared across many apps and/or AWS accounts.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    adotInstrumentationallowAllIpv6OutboundallowAllOutboundallowPublicSubnetappapplicationLogLevelapplicationLogLevelV2architecturebucketNamePathcodeSigningConfigcurrentVersionOptionsdeadLetterQueuedeadLetterQueueEnableddeadLetterTopicdescriptionenableVersioningenvironmentenvironmentEncryptionephemeralStorageSizeeventsexistingSnsTopicfileNamefilesystemfunctionNamehandlerinitialPolicyinsightsVersionipv6AllowedForDualStacklayerslogFormatloggingFormatlogGrouplogRetentionlogRetentionRetryOptionslogRetentionRolemaxEventAgememorySizemonitoringConfigurationonFailureonSuccessparamsAndSecretsprofilingprofilingGrouprecursiveLoopreservedConcurrentExecutionsretryAttemptsroleruntimeruntimeManagementModesecurityGroupssnapStartsystemLogLevelsystemLogLevelV2throttlingMonitoringtimeouttracingvpcvpcSubnetswithoutArtifactUploadwithoutFilePrefix
    +

    Settings

    Member Visibility

    On This Page

    Properties
    adotInstrumentationallowAllIpv6OutboundallowAllOutboundallowPublicSubnetappapplicationLogLevelapplicationLogLevelV2architecturebucketNamePathcodeSigningConfigcurrentVersionOptionsdeadLetterQueuedeadLetterQueueEnableddeadLetterTopicdescriptionenableVersioningenvironmentenvironmentEncryptionephemeralStorageSizeeventsexistingSnsTopicfileNamefilesystemfunctionNamehandlerinitialPolicyinsightsVersionipv6AllowedForDualStacklayerslogFormatloggingFormatlogGrouplogRetentionlogRetentionRetryOptionslogRetentionRolemaxEventAgememorySizemonitoringConfigurationonFailureonSuccessparamsAndSecretsprofilingprofilingGrouprecursiveLoopreservedConcurrentExecutionsretryAttemptsroleruntimeruntimeManagementModesecurityGroupssnapStartsystemLogLevelsystemLogLevelV2throttlingMonitoringtimeouttracingvpcvpcSubnetswithoutArtifactUploadwithoutFilePrefix
    diff --git a/interfaces/patterns.AccessLoggingProps.html b/interfaces/patterns.AccessLoggingProps.html index 908884f666..e32fa53845 100644 --- a/interfaces/patterns.AccessLoggingProps.html +++ b/interfaces/patterns.AccessLoggingProps.html @@ -1,11 +1,11 @@ -AccessLoggingProps | @guardian/cdk

    Interface AccessLoggingProps

    interface AccessLoggingProps {
        enabled: boolean;
        prefix?: string;
    }

    Properties

    enabled +AccessLoggingProps | @guardian/cdk

    Interface AccessLoggingProps

    interface AccessLoggingProps {
        enabled: boolean;
        prefix?: string;
    }

    Properties

    enabled prefix?

    Properties

    enabled

    enabled: boolean

    Enable (load balancer) access logs.

    Note, you will need to specify a region in your stack declaration to use this. Seehttps://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-elasticloadbalancingv2.ApplicationLoadBalancer.html#logwbraccesswbrlogsbucket-prefix

    -

    Optionalprefix

    prefix?: string

    S3 prefix for the logs.

    +

    Optionalprefix

    prefix?: string

    S3 prefix for the logs.

    Default Value

    no prefix
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/patterns.Alarms.html b/interfaces/patterns.Alarms.html index d660a1bc97..6c5a244831 100644 --- a/interfaces/patterns.Alarms.html +++ b/interfaces/patterns.Alarms.html @@ -1,11 +1,11 @@ -Alarms | @guardian/cdk

    Interface Alarms

    interface Alarms {
        http4xxAlarm?: false | Http4xxAlarmProps;
        http5xxAlarm: false | Http5xxAlarmProps;
        noMonitoring?: false;
        snsTopicName: string;
        unhealthyInstancesAlarm: boolean;
    }

    Properties

    http4xxAlarm? +Alarms | @guardian/cdk

    Interface Alarms

    interface Alarms {
        http4xxAlarm?: false | Http4xxAlarmProps;
        http5xxAlarm: false | Http5xxAlarmProps;
        noMonitoring?: false;
        snsTopicName: string;
        unhealthyInstancesAlarm: boolean;
    }

    Properties

    http4xxAlarm? http5xxAlarm noMonitoring? snsTopicName unhealthyInstancesAlarm

    Properties

    Optionalhttp4xxAlarm

    http4xxAlarm?: false | Http4xxAlarmProps

    Enable the 4xx alarm with settings.

    -

    http5xxAlarm

    http5xxAlarm: false | Http5xxAlarmProps

    Enable the 5xx alarm with settings.

    -

    OptionalnoMonitoring

    noMonitoring

    Internal flag - users of this library should ignore this setting.

    -

    snsTopicName

    snsTopicName: string

    Name of the target (SNS Topic) for alarm notifications.

    -

    unhealthyInstancesAlarm

    unhealthyInstancesAlarm: boolean

    Enable the unhealthy instances alarm.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    http5xxAlarm

    http5xxAlarm: false | Http5xxAlarmProps

    Enable the 5xx alarm with settings.

    +

    OptionalnoMonitoring

    noMonitoring

    Internal flag - users of this library should ignore this setting.

    +

    snsTopicName

    snsTopicName: string

    Name of the target (SNS Topic) for alarm notifications.

    +

    unhealthyInstancesAlarm

    unhealthyInstancesAlarm: boolean

    Enable the unhealthy instances alarm.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/patterns.ApiGatewayAlarms.html b/interfaces/patterns.ApiGatewayAlarms.html index ce6502181d..e22686319c 100644 --- a/interfaces/patterns.ApiGatewayAlarms.html +++ b/interfaces/patterns.ApiGatewayAlarms.html @@ -1,8 +1,8 @@ ApiGatewayAlarms | @guardian/cdk

    Interface ApiGatewayAlarms

    Alarm props.

    -
    interface ApiGatewayAlarms {
        http5xxAlarm: Http5xxAlarmProps;
        noMonitoring?: false;
        snsTopicName: string;
    }

    Properties

    http5xxAlarm +
    interface ApiGatewayAlarms {
        http5xxAlarm: Http5xxAlarmProps;
        noMonitoring?: false;
        snsTopicName: string;
    }

    Properties

    http5xxAlarm noMonitoring? snsTopicName

    Properties

    http5xxAlarm

    http5xxAlarm: Http5xxAlarmProps

    Configuration the 5xx alarm.

    -

    OptionalnoMonitoring

    noMonitoring

    Internal flag - users of this library should ignore this setting.

    -

    snsTopicName

    snsTopicName: string

    (SNS) Topic name where alarm notifications will be sent.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalnoMonitoring

    noMonitoring

    Internal flag - users of this library should ignore this setting.

    +

    snsTopicName

    snsTopicName: string

    (SNS) Topic name where alarm notifications will be sent.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/patterns.ApiTarget.html b/interfaces/patterns.ApiTarget.html index 630cae6983..1c9b5843bd 100644 --- a/interfaces/patterns.ApiTarget.html +++ b/interfaces/patterns.ApiTarget.html @@ -1,10 +1,10 @@ ApiTarget | @guardian/cdk

    Interface ApiTarget

    API target props.

    -
    interface ApiTarget {
        apiKeyRequired?: true;
        httpMethod: HttpMethod;
        lambda: GuLambdaFunction;
        path: string;
    }

    Properties

    apiKeyRequired? +
    interface ApiTarget {
        apiKeyRequired?: true;
        httpMethod: HttpMethod;
        lambda: GuLambdaFunction;
        path: string;
    }

    Properties

    apiKeyRequired? httpMethod lambda path

    Properties

    OptionalapiKeyRequired

    apiKeyRequired

    Whether an apiKey is required for this method.

    -

    httpMethod

    httpMethod: HttpMethod

    The [[HttpMethod]] for the target (e.g. GET, POST, PUT).

    -

    lambda

    lambda: GuLambdaFunction

    The Lambda function responsible for handling the request.

    -

    path

    path: string

    The path for the request (e.g. /test).

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    httpMethod

    httpMethod: HttpMethod

    The [[HttpMethod]] for the target (e.g. GET, POST, PUT).

    +

    lambda

    lambda: GuLambdaFunction

    The Lambda function responsible for handling the request.

    +

    path

    path: string

    The path for the request (e.g. /test).

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/patterns.ApplicationLoggingProps.html b/interfaces/patterns.ApplicationLoggingProps.html index d535880c87..557db5d384 100644 --- a/interfaces/patterns.ApplicationLoggingProps.html +++ b/interfaces/patterns.ApplicationLoggingProps.html @@ -8,7 +8,7 @@

    Unless you have explicitly opted-out, appropriate IAM permissions for logging to Kinesis will be configured automatically via the [[GuEc2App]] pattern.

    -
    interface ApplicationLoggingProps {
        enabled: boolean;
        systemdUnitName?: string;
    }

    Properties

    enabled +
    interface ApplicationLoggingProps {
        enabled: boolean;
        systemdUnitName?: string;
    }

    Properties

    enabled systemdUnitName?

    Properties

    enabled

    enabled: boolean

    Enables forwarding of application logs to the Guardian ELK stack.

    Note, to work, you will need to also do the following non-CDK things:

    @@ -22,7 +22,7 @@ logging to Kinesis will be configured automatically via the [[GuEc2App]] pattern.

    See

    https://github.com/guardian/amigo/tree/main/roles/cdk-base

    -

    OptionalsystemdUnitName

    systemdUnitName?: string

    This needs to match the name of your SystemD unit.

    +

    OptionalsystemdUnitName

    systemdUnitName?: string

    This needs to match the name of your SystemD unit.

    If your systemd unit is not <app>.service set this value.

    Default Value

    <app>.service

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/patterns.GuApiGatewayWithLambdaByPathProps.html b/interfaces/patterns.GuApiGatewayWithLambdaByPathProps.html index 4248f49b9a..58baba4761 100644 --- a/interfaces/patterns.GuApiGatewayWithLambdaByPathProps.html +++ b/interfaces/patterns.GuApiGatewayWithLambdaByPathProps.html @@ -1,4 +1,4 @@ -GuApiGatewayWithLambdaByPathProps | @guardian/cdk

    Interface GuApiGatewayWithLambdaByPathProps

    interface GuApiGatewayWithLambdaByPathProps {
        apiKeySourceType?: ApiKeySourceType;
        app: string;
        binaryMediaTypes?: string[];
        cloneFrom?: IRestApi;
        cloudWatchRole?: boolean;
        cloudWatchRoleRemovalPolicy?: RemovalPolicy;
        defaultCorsPreflightOptions?: CorsOptions;
        defaultIntegration?: Integration;
        defaultMethodOptions?: MethodOptions;
        deploy?: boolean;
        deployOptions?: StageOptions;
        description?: string;
        disableExecuteApiEndpoint?: boolean;
        domainName?: DomainNameOptions;
        endpointConfiguration?: EndpointConfiguration;
        endpointExportName?: string;
        endpointTypes?: EndpointType[];
        failOnWarnings?: boolean;
        minCompressionSize?: Size;
        minimumCompressionSize?: number;
        monitoringConfiguration: NoMonitoring | ApiGatewayAlarms;
        parameters?: {
            [key: string]: string;
        };
        policy?: PolicyDocument;
        restApiName?: string;
        retainDeployments?: boolean;
        targets: ApiTarget[];
    }

    Hierarchy (view full)

    • RestApiProps
    • AppIdentity
      • GuApiGatewayWithLambdaByPathProps

    Properties

    apiKeySourceType? +GuApiGatewayWithLambdaByPathProps | @guardian/cdk

    Interface GuApiGatewayWithLambdaByPathProps

    interface GuApiGatewayWithLambdaByPathProps {
        apiKeySourceType?: ApiKeySourceType;
        app: string;
        binaryMediaTypes?: string[];
        cloneFrom?: IRestApi;
        cloudWatchRole?: boolean;
        cloudWatchRoleRemovalPolicy?: RemovalPolicy;
        defaultCorsPreflightOptions?: CorsOptions;
        defaultIntegration?: Integration;
        defaultMethodOptions?: MethodOptions;
        deploy?: boolean;
        deployOptions?: StageOptions;
        description?: string;
        disableExecuteApiEndpoint?: boolean;
        domainName?: DomainNameOptions;
        endpointConfiguration?: EndpointConfiguration;
        endpointExportName?: string;
        endpointTypes?: EndpointType[];
        failOnWarnings?: boolean;
        minCompressionSize?: Size;
        minimumCompressionSize?: number;
        monitoringConfiguration: NoMonitoring | ApiGatewayAlarms;
        parameters?: {
            [key: string]: string;
        };
        policy?: PolicyDocument;
        restApiName?: string;
        retainDeployments?: boolean;
        targets: ApiTarget[];
    }

    Hierarchy (view full)

    • RestApiProps
    • AppIdentity
      • GuApiGatewayWithLambdaByPathProps

    Properties

    apiKeySourceType? app binaryMediaTypes? cloneFrom? @@ -29,7 +29,7 @@

    Default

    - Metering is disabled.
    -

    app

    app: string

    Optional ReadonlybinaryMediaTypes

    binaryMediaTypes?: string[]

    The list of binary media mime-types that are supported by the RestApi +

    app

    app: string

    Optional ReadonlybinaryMediaTypes

    binaryMediaTypes?: string[]

    The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream"

    Default

    - RestApi supports only UTF-8-encoded text payloads.
    @@ -147,7 +147,7 @@ 
     monitoringConfiguration: { noMonitoring: true }
    -

    Optional Readonlyparameters

    parameters?: {
        [key: string]: string;
    }

    Custom header parameters for the request.

    +

    Optional Readonlyparameters

    parameters?: {
        [key: string]: string;
    }

    Custom header parameters for the request.

    See

    https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html

    Default

    - No parameters.
    @@ -167,4 +167,4 @@

    targets

    targets: ApiTarget[]

    A list of [[ApiTarget]]s to configure for the API Gateway instance.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/patterns.GuApiLambdaProps.html b/interfaces/patterns.GuApiLambdaProps.html index 36e665a1c7..9f72141e7f 100644 --- a/interfaces/patterns.GuApiLambdaProps.html +++ b/interfaces/patterns.GuApiLambdaProps.html @@ -1,4 +1,4 @@ -GuApiLambdaProps | @guardian/cdk

    Interface GuApiLambdaProps

    interface GuApiLambdaProps {
        adotInstrumentation?: AdotInstrumentationConfig;
        allowAllIpv6Outbound?: boolean;
        allowAllOutbound?: boolean;
        allowPublicSubnet?: boolean;
        api: ApiProps;
        app: string;
        applicationLogLevel?: string;
        applicationLogLevelV2?: ApplicationLogLevel;
        architecture?: Architecture;
        bucketNamePath?: string;
        codeSigningConfig?: ICodeSigningConfig;
        currentVersionOptions?: VersionOptions;
        deadLetterQueue?: IQueue;
        deadLetterQueueEnabled?: boolean;
        deadLetterTopic?: ITopic;
        description?: string;
        enableVersioning?: boolean;
        environment?: {
            [key: string]: string;
        };
        environmentEncryption?: IKey;
        ephemeralStorageSize?: Size;
        events?: IEventSource[];
        fileName: string;
        filesystem?: FileSystem;
        functionName?: string;
        handler: string;
        initialPolicy?: PolicyStatement[];
        insightsVersion?: LambdaInsightsVersion;
        ipv6AllowedForDualStack?: boolean;
        layers?: ILayerVersion[];
        logFormat?: string;
        loggingFormat?: LoggingFormat;
        logGroup?: ILogGroup;
        logRetention?: RetentionDays;
        logRetentionRetryOptions?: LogRetentionRetryOptions;
        logRetentionRole?: IRole;
        maxEventAge?: Duration;
        memorySize?: number;
        monitoringConfiguration: NoMonitoring | ApiGatewayAlarms;
        onFailure?: IDestination;
        onSuccess?: IDestination;
        paramsAndSecrets?: ParamsAndSecretsLayerVersion;
        profiling?: boolean;
        profilingGroup?: IProfilingGroup;
        recursiveLoop?: RecursiveLoop;
        reservedConcurrentExecutions?: number;
        retryAttempts?: number;
        role?: IRole;
        runtime: Runtime;
        runtimeManagementMode?: RuntimeManagementMode;
        securityGroups?: ISecurityGroup[];
        snapStart?: SnapStartConf;
        systemLogLevel?: string;
        systemLogLevelV2?: SystemLogLevel;
        throttlingMonitoring?: GuLambdaThrottlingMonitoringProps;
        timeout?: Duration;
        tracing?: Tracing;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection;
        withoutArtifactUpload?: boolean;
        withoutFilePrefix?: boolean;
    }

    Hierarchy

    Properties

    adotInstrumentation? +GuApiLambdaProps | @guardian/cdk

    Interface GuApiLambdaProps

    interface GuApiLambdaProps {
        adotInstrumentation?: AdotInstrumentationConfig;
        allowAllIpv6Outbound?: boolean;
        allowAllOutbound?: boolean;
        allowPublicSubnet?: boolean;
        api: ApiProps;
        app: string;
        applicationLogLevel?: string;
        applicationLogLevelV2?: ApplicationLogLevel;
        architecture?: Architecture;
        bucketNamePath?: string;
        codeSigningConfig?: ICodeSigningConfig;
        currentVersionOptions?: VersionOptions;
        deadLetterQueue?: IQueue;
        deadLetterQueueEnabled?: boolean;
        deadLetterTopic?: ITopic;
        description?: string;
        enableVersioning?: boolean;
        environment?: {
            [key: string]: string;
        };
        environmentEncryption?: IKey;
        ephemeralStorageSize?: Size;
        events?: IEventSource[];
        fileName: string;
        filesystem?: FileSystem;
        functionName?: string;
        handler: string;
        initialPolicy?: PolicyStatement[];
        insightsVersion?: LambdaInsightsVersion;
        ipv6AllowedForDualStack?: boolean;
        layers?: ILayerVersion[];
        logFormat?: string;
        loggingFormat?: LoggingFormat;
        logGroup?: ILogGroup;
        logRetention?: RetentionDays;
        logRetentionRetryOptions?: LogRetentionRetryOptions;
        logRetentionRole?: IRole;
        maxEventAge?: Duration;
        memorySize?: number;
        monitoringConfiguration: NoMonitoring | ApiGatewayAlarms;
        onFailure?: IDestination;
        onSuccess?: IDestination;
        paramsAndSecrets?: ParamsAndSecretsLayerVersion;
        profiling?: boolean;
        profilingGroup?: IProfilingGroup;
        recursiveLoop?: RecursiveLoop;
        reservedConcurrentExecutions?: number;
        retryAttempts?: number;
        role?: IRole;
        runtime: Runtime;
        runtimeManagementMode?: RuntimeManagementMode;
        securityGroups?: ISecurityGroup[];
        snapStart?: SnapStartConf;
        systemLogLevel?: string;
        systemLogLevelV2?: SystemLogLevel;
        throttlingMonitoring?: GuLambdaThrottlingMonitoringProps;
        timeout?: Duration;
        tracing?: Tracing;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection;
        withoutArtifactUpload?: boolean;
        withoutFilePrefix?: boolean;
    }

    Hierarchy

    Properties

    adotInstrumentation? allowAllIpv6Outbound? allowAllOutbound? allowPublicSubnet? @@ -87,7 +87,7 @@

    api

    api: ApiProps

    [[LambdaRestApiProps]] to configure for the lambda.

    -

    app

    app: string

    Optional ReadonlyapplicationLogLevel

    applicationLogLevel?: string

    Sets the application log level for the function.

    +

    app

    app: string

    Optional ReadonlyapplicationLogLevel

    applicationLogLevel?: string

    Sets the application log level for the function.

    Deprecated

    Use applicationLogLevelV2 as a property instead.

    Default

    "INFO"
    @@ -105,7 +105,7 @@ you are referencing a file that is shared across many apps and/or AWS accounts.

    Default Value

    [[GuDistributionBucketParameter]]

    -

    Optional ReadonlycodeSigningConfig

    codeSigningConfig?: ICodeSigningConfig

    Code signing config associated with this function

    +

    Optional ReadonlycodeSigningConfig

    codeSigningConfig?: ICodeSigningConfig

    Code signing config associated with this function

    Default

    - Not Sign the Code
    @@ -138,7 +138,7 @@ on versioning (e.g. SnapStart or Provisioned Concurrency).

    If you enable versioning you must ensure that your Lambda function is updated whenever a new build is deployed via CloudFormation. The simplest way to do this is to include the build number in the fileName prop.

    -

    Optional Readonlyenvironment

    environment?: {
        [key: string]: string;
    }

    Key-value pairs that Lambda caches and makes available for your Lambda +

    Optional Readonlyenvironment

    environment?: {
        [key: string]: string;
    }

    Key-value pairs that Lambda caches and makes available for your Lambda functions. Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Lambda function source code.

    @@ -160,7 +160,7 @@

    fileName

    fileName: string

    The filename for an executable package within the bucket [[GuDistributionBucketParameter]]. We'll look for fileName on the path "bucket/stack/stage/app/".

    -

    Optional Readonlyfilesystem

    filesystem?: FileSystem

    The filesystem configuration for the lambda function

    +

    Optional Readonlyfilesystem

    filesystem?: FileSystem

    The filesystem configuration for the lambda function

    Default

    - will not mount any filesystem
    @@ -268,7 +268,7 @@ 
     monitoringConfiguration: { noMonitoring: true }
    -

    Optional ReadonlyonFailure

    onFailure?: IDestination

    The destination for failed invocations.

    +

    Optional ReadonlyonFailure

    onFailure?: IDestination

    The destination for failed invocations.

    Default

    - no destination
    @@ -353,7 +353,7 @@ concurrency limit (the reservedConcurrentExecutions prop) if you are concerned about throttling.

    See

    https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html

    -

    Optional Readonlytimeout

    timeout?: Duration

    The function execution time (in seconds) after which Lambda terminates +

    Optional Readonlytimeout

    timeout?: Duration

    The function execution time (in seconds) after which Lambda terminates the function. Because the execution time affects cost, set this value based on the function's expected execution time.

    Default

    Duration.seconds(3)
@@ -381,8 +381,8 @@
 managed elsewhere by DevX.
    
 
    This is used by RiffRaffYamlFileExperimental to skip generating
 an uploadLambda step.
    
-

    OptionalwithoutFilePrefix

    withoutFilePrefix?: boolean

    Set to true to use the filename without the stage/stack/app prefix.

    +

    OptionalwithoutFilePrefix

    withoutFilePrefix?: boolean

    Set to true to use the filename without the stage/stack/app prefix.

    Typically you should not override this but you may need to if, for example, you are referencing a file that is shared across many apps and/or AWS accounts.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    adotInstrumentationallowAllIpv6OutboundallowAllOutboundallowPublicSubnetapiappapplicationLogLevelapplicationLogLevelV2architecturebucketNamePathcodeSigningConfigcurrentVersionOptionsdeadLetterQueuedeadLetterQueueEnableddeadLetterTopicdescriptionenableVersioningenvironmentenvironmentEncryptionephemeralStorageSizeeventsfileNamefilesystemfunctionNamehandlerinitialPolicyinsightsVersionipv6AllowedForDualStacklayerslogFormatloggingFormatlogGrouplogRetentionlogRetentionRetryOptionslogRetentionRolemaxEventAgememorySizemonitoringConfigurationonFailureonSuccessparamsAndSecretsprofilingprofilingGrouprecursiveLoopreservedConcurrentExecutionsretryAttemptsroleruntimeruntimeManagementModesecurityGroupssnapStartsystemLogLevelsystemLogLevelV2throttlingMonitoringtimeouttracingvpcvpcSubnetswithoutArtifactUploadwithoutFilePrefix
    +

    Settings

    Member Visibility

    On This Page

    Properties
    adotInstrumentationallowAllIpv6OutboundallowAllOutboundallowPublicSubnetapiappapplicationLogLevelapplicationLogLevelV2architecturebucketNamePathcodeSigningConfigcurrentVersionOptionsdeadLetterQueuedeadLetterQueueEnableddeadLetterTopicdescriptionenableVersioningenvironmentenvironmentEncryptionephemeralStorageSizeeventsfileNamefilesystemfunctionNamehandlerinitialPolicyinsightsVersionipv6AllowedForDualStacklayerslogFormatloggingFormatlogGrouplogRetentionlogRetentionRetryOptionslogRetentionRolemaxEventAgememorySizemonitoringConfigurationonFailureonSuccessparamsAndSecretsprofilingprofilingGrouprecursiveLoopreservedConcurrentExecutionsretryAttemptsroleruntimeruntimeManagementModesecurityGroupssnapStartsystemLogLevelsystemLogLevelV2throttlingMonitoringtimeouttracingvpcvpcSubnetswithoutArtifactUploadwithoutFilePrefix
    diff --git a/interfaces/patterns.GuEc2AppProps.html b/interfaces/patterns.GuEc2AppProps.html index 758a6877ca..cacfcdf0ea 100644 --- a/interfaces/patterns.GuEc2AppProps.html +++ b/interfaces/patterns.GuEc2AppProps.html @@ -1,4 +1,4 @@ -GuEc2AppProps | @guardian/cdk

    Interface GuEc2AppProps

    interface GuEc2AppProps {
        access: AppAccess;
        accessLogging?: AccessLoggingProps;
        app: string;
        applicationLogging?: ApplicationLoggingProps;
        applicationPort: number;
        blockDevices?: BlockDevice[];
        certificateProps?: GuDomainName;
        defaultInstanceWarmup?: Duration;
        enabledDetailedInstanceMonitoring?: boolean;
        googleAuth?: {
            allowedGroups?: string[];
            cognitoAuthStage?: string;
            credentialsSecretsManagerPath?: string;
            domain: string;
            enabled: true;
            sessionTimeoutInMinutes?: number;
        };
        healthcheck?: HealthCheck;
        imageRecipe?: string | AmigoProps;
        instanceMetadataHopLimit?: number;
        instanceType: InstanceType;
        monitoringConfiguration: NoMonitoring | Alarms;
        privateSubnets?: ISubnet[];
        publicSubnets?: ISubnet[];
        roleConfiguration?: GuInstanceRoleProps;
        scaling: GuAsgCapacity;
        updatePolicy?: UpdatePolicy;
        userData: UserData | GuUserDataProps;
        vpc?: IVpc;
        withoutImdsv2?: boolean;
    }

    Hierarchy (view full)

    Properties

    access +GuEc2AppProps | @guardian/cdk

    Interface GuEc2AppProps

    interface GuEc2AppProps {
        access: AppAccess;
        accessLogging?: AccessLoggingProps;
        app: string;
        applicationLogging?: ApplicationLoggingProps;
        applicationPort: number;
        blockDevices?: BlockDevice[];
        certificateProps?: GuDomainName;
        defaultInstanceWarmup?: Duration;
        enabledDetailedInstanceMonitoring?: boolean;
        googleAuth?: {
            allowedGroups?: string[];
            cognitoAuthStage?: string;
            credentialsSecretsManagerPath?: string;
            domain: string;
            enabled: true;
            sessionTimeoutInMinutes?: number;
        };
        healthcheck?: HealthCheck;
        imageRecipe?: string | AmigoProps;
        instanceMetadataHopLimit?: number;
        instanceType: InstanceType;
        monitoringConfiguration: NoMonitoring | Alarms;
        privateSubnets?: ISubnet[];
        publicSubnets?: ISubnet[];
        roleConfiguration?: GuInstanceRoleProps;
        scaling: GuAsgCapacity;
        updatePolicy?: UpdatePolicy;
        userData: UserData | GuUserDataProps;
        vpc?: IVpc;
        withoutImdsv2?: boolean;
    }

    Hierarchy (view full)

    Properties

    access accessLogging? app applicationLogging? @@ -25,19 +25,19 @@

    Note, this merely provides defence in depth; you should, for example, limit access to the VPN and then treat that as sufficient. Instead, use Google Auth for human access, or a suitable machine auth mechanism.

    -

    OptionalaccessLogging

    accessLogging?: AccessLoggingProps

    Enable and configures access logs.

    -

    app

    app: string

    OptionalapplicationLogging

    applicationLogging?: ApplicationLoggingProps

    Enable and configures application logs.

    -

    applicationPort

    applicationPort: number

    The port your application runs on.

    -

    OptionalblockDevices

    blockDevices?: BlockDevice[]

    Add block devices (additional storage).

    -

    OptionalcertificateProps

    certificateProps?: GuDomainName

    Specify certificate for the load balancer.

    -

    OptionaldefaultInstanceWarmup

    defaultInstanceWarmup?: Duration

    You can specify how long after an instance reaches the InService state it waits before contributing +

    OptionalaccessLogging

    accessLogging?: AccessLoggingProps

    Enable and configures access logs.

    +

    app

    app: string

    OptionalapplicationLogging

    applicationLogging?: ApplicationLoggingProps

    Enable and configures application logs.

    +

    applicationPort

    applicationPort: number

    The port your application runs on.

    +

    OptionalblockDevices

    blockDevices?: BlockDevice[]

    Add block devices (additional storage).

    +

    OptionalcertificateProps

    certificateProps?: GuDomainName

    Specify certificate for the load balancer.

    +

    OptionaldefaultInstanceWarmup

    defaultInstanceWarmup?: Duration

    You can specify how long after an instance reaches the InService state it waits before contributing usage data to the aggregated metrics. This specified time is called the default instance warmup. This keeps dynamic scaling from being affected by metrics for individual instances that aren't yet handling application traffic and that might be experiencing temporarily high usage of compute resources.

    See

    https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html

    -

    OptionalenabledDetailedInstanceMonitoring

    enabledDetailedInstanceMonitoring?: boolean

    This setting configures the launch template to enable or disable detailed monitoring on instances.

    +

    OptionalenabledDetailedInstanceMonitoring

    enabledDetailedInstanceMonitoring?: boolean

    This setting configures the launch template to enable or disable detailed monitoring on instances.

    See

    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-monitoring.html

    -

    OptionalgoogleAuth

    googleAuth?: {
        allowedGroups?: string[];
        cognitoAuthStage?: string;
        credentialsSecretsManagerPath?: string;
        domain: string;
        enabled: true;
        sessionTimeoutInMinutes?: number;
    }

    Configure Google Auth.

    +

    OptionalgoogleAuth

    googleAuth?: {
        allowedGroups?: string[];
        cognitoAuthStage?: string;
        credentialsSecretsManagerPath?: string;
        domain: string;
        enabled: true;
        sessionTimeoutInMinutes?: number;
    }

    Configure Google Auth.

    Type declaration

    • OptionalallowedGroups?: string[]

      Groups used for membership checks.

      If specified, cannot be empty. Users must be a member of at least one group to gain access.

      @@ -79,28 +79,28 @@

      Default Value

      15
      -

    Optionalhealthcheck

    healthcheck?: HealthCheck

    Specify custom healthcheck

    -

    OptionalimageRecipe

    imageRecipe?: string | AmigoProps

    Configure AMIgo image recipe. This is only necessary if you are using GuCDK to generate your riff-raff.yaml file.

    -

    OptionalinstanceMetadataHopLimit

    instanceMetadataHopLimit?: number

    Set http put response hop limit for the launch template. +

    Optionalhealthcheck

    healthcheck?: HealthCheck

    Specify custom healthcheck

    +

    OptionalimageRecipe

    imageRecipe?: string | AmigoProps

    Configure AMIgo image recipe. This is only necessary if you are using GuCDK to generate your riff-raff.yaml file.

    +

    OptionalinstanceMetadataHopLimit

    instanceMetadataHopLimit?: number

    Set http put response hop limit for the launch template. It can be necessary to raise this value from the default of 1 for example when sharing the instance profile with a docker container running on the instance.

    -

    instanceType

    instanceType: InstanceType

    EC2 instance type. Note, ensure your code is built for the same +

    instanceType

    instanceType: InstanceType

    EC2 instance type. Note, ensure your code is built for the same architecture family (arm64 - 'Graviton' instances - or x64).

    -

    monitoringConfiguration

    monitoringConfiguration: NoMonitoring | Alarms

    Enable and configure alarms.

    -

    OptionalprivateSubnets

    privateSubnets?: ISubnet[]

    Specify private subnets if using a non-default VPC or (generally +

    monitoringConfiguration

    monitoringConfiguration: NoMonitoring | Alarms

    Enable and configure alarms.

    +

    OptionalprivateSubnets

    privateSubnets?: ISubnet[]

    Specify private subnets if using a non-default VPC or (generally discouraged) to limit to a subset of the available subnets.

    -

    OptionalpublicSubnets

    publicSubnets?: ISubnet[]

    Specify private subnets if using a non-default VPC or (generally +

    OptionalpublicSubnets

    publicSubnets?: ISubnet[]

    Specify private subnets if using a non-default VPC or (generally discouraged) to limit to a subset of the available subnets.

    -

    OptionalroleConfiguration

    roleConfiguration?: GuInstanceRoleProps

    Configure IAM roles for autoscaling group EC2 instances.

    -

    scaling

    scaling: GuAsgCapacity

    Autoscaling group min and max sizes.

    -

    OptionalupdatePolicy

    updatePolicy?: UpdatePolicy

    Specify an update policy for the ASG created by this pattern.

    +

    OptionalroleConfiguration

    roleConfiguration?: GuInstanceRoleProps

    Configure IAM roles for autoscaling group EC2 instances.

    +

    scaling

    scaling: GuAsgCapacity

    Autoscaling group min and max sizes.

    +

    OptionalupdatePolicy

    updatePolicy?: UpdatePolicy

    Specify an update policy for the ASG created by this pattern.

    See

    https://docs.aws.amazon.com/cdk/api/latest/docs/aws-autoscaling-readme.html#update-policy

    Default Value

    UpdatePolicy.none() - Cloudformation does not attempt to rotate instances in the ASG
    and must rely on riffraff to do so.
    -

    userData

    userData: UserData | GuUserDataProps

    User data for the autoscaling group.

    -

    Optionalvpc

    vpc?: IVpc

    Specify the VPC to use.

    +

    userData

    userData: UserData | GuUserDataProps

    User data for the autoscaling group.

    +

    Optionalvpc

    vpc?: IVpc

    Specify the VPC to use.

    See

    https://github.com/guardian/aws-account-setup

    -

    OptionalwithoutImdsv2

    withoutImdsv2?: boolean

    Disable imdsv2. Most of the time you should not set this.

    +

    OptionalwithoutImdsv2

    withoutImdsv2?: boolean

    Disable imdsv2. Most of the time you should not set this.

    See

    https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/patterns.GuScheduledEcsTaskProps.html b/interfaces/patterns.GuScheduledEcsTaskProps.html index 2828fb4e3c..4d82716375 100644 --- a/interfaces/patterns.GuScheduledEcsTaskProps.html +++ b/interfaces/patterns.GuScheduledEcsTaskProps.html @@ -29,7 +29,7 @@ VERSION environment variable. Alternatively, you could hard code a value for the variable in CDK. See https://docs.aws.amazon.com/step-functions/latest/dg/connect-ecs.html for further detail and other override options - this construct currently only supports environment variables.

    -
    interface GuScheduledEcsTaskProps {
        app: string;
        assignPublicIp?: boolean;
        containerConfiguration: ContainerConfiguration;
        containerInsights?: boolean;
        cpu?: number;
        customTaskPolicies?: PolicyStatement[];
        enableDistributablePolicy?: boolean;
        environmentOverrides?: TaskEnvironmentVariable[];
        memory?: number;
        monitoringConfiguration: NoMonitoring | GuEcsTaskMonitoringProps;
        readonlyRootFilesystem?: boolean;
        schedule: Schedule;
        securityGroups?: ISecurityGroup[];
        storage?: number;
        subnets: ISubnet[];
        taskCommand?: string;
        taskTimeoutInMinutes?: number;
        vpc: IVpc;
    }

    Hierarchy (view full)

    Properties

    app +
    interface GuScheduledEcsTaskProps {
        app: string;
        assignPublicIp?: boolean;
        containerConfiguration: ContainerConfiguration;
        containerInsights?: boolean;
        cpu?: number;
        customTaskPolicies?: PolicyStatement[];
        enableDistributablePolicy?: boolean;
        environmentOverrides?: TaskEnvironmentVariable[];
        memory?: number;
        monitoringConfiguration: NoMonitoring | GuEcsTaskMonitoringProps;
        readonlyRootFilesystem?: boolean;
        schedule: Schedule;
        securityGroups?: ISecurityGroup[];
        storage?: number;
        subnets: ISubnet[];
        taskCommand?: string;
        taskTimeoutInMinutes?: number;
        vpc: IVpc;
    }

    Hierarchy (view full)

    Properties

    app assignPublicIp? containerConfiguration containerInsights? @@ -47,22 +47,22 @@ taskCommand? taskTimeoutInMinutes? vpc -

    Properties

    app

    app: string

    OptionalassignPublicIp

    assignPublicIp?: boolean

    containerConfiguration

    containerConfiguration: ContainerConfiguration

    OptionalcontainerInsights

    containerInsights?: boolean

    If true, CloudWatch Container Insights will be enabled for the cluster

    +

    Properties

    app

    app: string

    OptionalassignPublicIp

    assignPublicIp?: boolean

    containerConfiguration

    containerConfiguration: ContainerConfiguration

    OptionalcontainerInsights

    containerInsights?: boolean

    If true, CloudWatch Container Insights will be enabled for the cluster

    Default

    false
    -

    Optionalcpu

    cpu?: number

    OptionalcustomTaskPolicies

    customTaskPolicies?: PolicyStatement[]

    OptionalenableDistributablePolicy

    enableDistributablePolicy?: boolean

    Whether to give the task IAM role access to the account's dist bucket. +

    Optionalcpu

    cpu?: number

    OptionalcustomTaskPolicies

    customTaskPolicies?: PolicyStatement[]

    OptionalenableDistributablePolicy

    enableDistributablePolicy?: boolean

    Whether to give the task IAM role access to the account's dist bucket. This is enabled by default to avoid breaking changes, but consumers of this pattern that pull a container image that doesn't need extra dependencies from S3 shoud set this value to false.

    -

    OptionalenvironmentOverrides

    environmentOverrides?: TaskEnvironmentVariable[]

    Optionalmemory

    memory?: number

    monitoringConfiguration

    monitoringConfiguration: NoMonitoring | GuEcsTaskMonitoringProps

    OptionalreadonlyRootFilesystem

    readonlyRootFilesystem?: boolean

    When this parameter is true, the container is given read-only access to its root file system.

    +

    OptionalenvironmentOverrides

    environmentOverrides?: TaskEnvironmentVariable[]

    Optionalmemory

    memory?: number

    monitoringConfiguration

    monitoringConfiguration: NoMonitoring | GuEcsTaskMonitoringProps

    OptionalreadonlyRootFilesystem

    readonlyRootFilesystem?: boolean

    When this parameter is true, the container is given read-only access to its root file system.

    Default

    false
    -

    schedule

    schedule: Schedule

    Schedule for the task.

    +

    schedule

    schedule: Schedule

    Schedule for the task.

    E.g.:

    • Schedule.expression("cron(0 8 ? * MON-FRI *)")
    • Schedule.rate(Duration.minutes(5))
    -

    OptionalsecurityGroups

    securityGroups?: ISecurityGroup[]

    Optionalstorage

    storage?: number

    subnets

    subnets: ISubnet[]

    OptionaltaskCommand

    taskCommand?: string

    OptionaltaskTimeoutInMinutes

    taskTimeoutInMinutes?: number

    vpc

    vpc: IVpc

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalsecurityGroups

    securityGroups?: ISecurityGroup[]

    Optionalstorage

    storage?: number

    subnets

    subnets: ISubnet[]

    OptionaltaskCommand

    taskCommand?: string

    OptionaltaskTimeoutInMinutes

    taskTimeoutInMinutes?: number

    vpc

    vpc: IVpc

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/patterns.GuScheduledLambdaProps.html b/interfaces/patterns.GuScheduledLambdaProps.html index 51eeebe676..29134c7eb7 100644 --- a/interfaces/patterns.GuScheduledLambdaProps.html +++ b/interfaces/patterns.GuScheduledLambdaProps.html @@ -1,4 +1,4 @@ -GuScheduledLambdaProps | @guardian/cdk

    Interface GuScheduledLambdaProps

    interface GuScheduledLambdaProps {
        adotInstrumentation?: AdotInstrumentationConfig;
        allowAllIpv6Outbound?: boolean;
        allowAllOutbound?: boolean;
        allowPublicSubnet?: boolean;
        app: string;
        applicationLogLevel?: string;
        applicationLogLevelV2?: ApplicationLogLevel;
        architecture?: Architecture;
        bucketNamePath?: string;
        codeSigningConfig?: ICodeSigningConfig;
        currentVersionOptions?: VersionOptions;
        deadLetterQueue?: IQueue;
        deadLetterQueueEnabled?: boolean;
        deadLetterTopic?: ITopic;
        description?: string;
        enableVersioning?: boolean;
        environment?: {
            [key: string]: string;
        };
        environmentEncryption?: IKey;
        ephemeralStorageSize?: Size;
        events?: IEventSource[];
        fileName: string;
        filesystem?: FileSystem;
        functionName?: string;
        handler: string;
        initialPolicy?: PolicyStatement[];
        insightsVersion?: LambdaInsightsVersion;
        ipv6AllowedForDualStack?: boolean;
        layers?: ILayerVersion[];
        logFormat?: string;
        loggingFormat?: LoggingFormat;
        logGroup?: ILogGroup;
        logRetention?: RetentionDays;
        logRetentionRetryOptions?: LogRetentionRetryOptions;
        logRetentionRole?: IRole;
        maxEventAge?: Duration;
        memorySize?: number;
        monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring;
        onFailure?: IDestination;
        onSuccess?: IDestination;
        paramsAndSecrets?: ParamsAndSecretsLayerVersion;
        profiling?: boolean;
        profilingGroup?: IProfilingGroup;
        recursiveLoop?: RecursiveLoop;
        reservedConcurrentExecutions?: number;
        retryAttempts?: number;
        role?: IRole;
        rules: {
            description?: string;
            input?: RuleTargetInput;
            schedule: Schedule;
        }[];
        runtime: Runtime;
        runtimeManagementMode?: RuntimeManagementMode;
        securityGroups?: ISecurityGroup[];
        snapStart?: SnapStartConf;
        systemLogLevel?: string;
        systemLogLevelV2?: SystemLogLevel;
        throttlingMonitoring?: GuLambdaThrottlingMonitoringProps;
        timeout?: Duration;
        tracing?: Tracing;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection;
        withoutArtifactUpload?: boolean;
        withoutFilePrefix?: boolean;
    }

    Hierarchy

    Properties

    adotInstrumentation? +GuScheduledLambdaProps | @guardian/cdk

    Interface GuScheduledLambdaProps

    interface GuScheduledLambdaProps {
        adotInstrumentation?: AdotInstrumentationConfig;
        allowAllIpv6Outbound?: boolean;
        allowAllOutbound?: boolean;
        allowPublicSubnet?: boolean;
        app: string;
        applicationLogLevel?: string;
        applicationLogLevelV2?: ApplicationLogLevel;
        architecture?: Architecture;
        bucketNamePath?: string;
        codeSigningConfig?: ICodeSigningConfig;
        currentVersionOptions?: VersionOptions;
        deadLetterQueue?: IQueue;
        deadLetterQueueEnabled?: boolean;
        deadLetterTopic?: ITopic;
        description?: string;
        enableVersioning?: boolean;
        environment?: {
            [key: string]: string;
        };
        environmentEncryption?: IKey;
        ephemeralStorageSize?: Size;
        events?: IEventSource[];
        fileName: string;
        filesystem?: FileSystem;
        functionName?: string;
        handler: string;
        initialPolicy?: PolicyStatement[];
        insightsVersion?: LambdaInsightsVersion;
        ipv6AllowedForDualStack?: boolean;
        layers?: ILayerVersion[];
        logFormat?: string;
        loggingFormat?: LoggingFormat;
        logGroup?: ILogGroup;
        logRetention?: RetentionDays;
        logRetentionRetryOptions?: LogRetentionRetryOptions;
        logRetentionRole?: IRole;
        maxEventAge?: Duration;
        memorySize?: number;
        monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring;
        onFailure?: IDestination;
        onSuccess?: IDestination;
        paramsAndSecrets?: ParamsAndSecretsLayerVersion;
        profiling?: boolean;
        profilingGroup?: IProfilingGroup;
        recursiveLoop?: RecursiveLoop;
        reservedConcurrentExecutions?: number;
        retryAttempts?: number;
        role?: IRole;
        rules: {
            description?: string;
            input?: RuleTargetInput;
            schedule: Schedule;
        }[];
        runtime: Runtime;
        runtimeManagementMode?: RuntimeManagementMode;
        securityGroups?: ISecurityGroup[];
        snapStart?: SnapStartConf;
        systemLogLevel?: string;
        systemLogLevelV2?: SystemLogLevel;
        throttlingMonitoring?: GuLambdaThrottlingMonitoringProps;
        timeout?: Duration;
        tracing?: Tracing;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection;
        withoutArtifactUpload?: boolean;
        withoutFilePrefix?: boolean;
    }

    Hierarchy

    Properties

    adotInstrumentation? allowAllIpv6Outbound? allowAllOutbound? allowPublicSubnet? @@ -86,7 +86,7 @@

    Default

    false
    -

    app

    app: string

    Optional ReadonlyapplicationLogLevel

    applicationLogLevel?: string

    Sets the application log level for the function.

    +

    app

    app: string

    Optional ReadonlyapplicationLogLevel

    applicationLogLevel?: string

    Sets the application log level for the function.

    Deprecated

    Use applicationLogLevelV2 as a property instead.

    Default

    "INFO"
    @@ -104,7 +104,7 @@ you are referencing a file that is shared across many apps and/or AWS accounts.

    Default Value

    [[GuDistributionBucketParameter]]

    -

    Optional ReadonlycodeSigningConfig

    codeSigningConfig?: ICodeSigningConfig

    Code signing config associated with this function

    +

    Optional ReadonlycodeSigningConfig

    codeSigningConfig?: ICodeSigningConfig

    Code signing config associated with this function

    Default

    - Not Sign the Code
    @@ -137,7 +137,7 @@ on versioning (e.g. SnapStart or Provisioned Concurrency).

    If you enable versioning you must ensure that your Lambda function is updated whenever a new build is deployed via CloudFormation. The simplest way to do this is to include the build number in the fileName prop.

    -

    Optional Readonlyenvironment

    environment?: {
        [key: string]: string;
    }

    Key-value pairs that Lambda caches and makes available for your Lambda +

    Optional Readonlyenvironment

    environment?: {
        [key: string]: string;
    }

    Key-value pairs that Lambda caches and makes available for your Lambda functions. Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Lambda function source code.

    @@ -159,7 +159,7 @@

    fileName

    fileName: string

    The filename for an executable package within the bucket [[GuDistributionBucketParameter]]. We'll look for fileName on the path "bucket/stack/stage/app/".

    -

    Optional Readonlyfilesystem

    filesystem?: FileSystem

    The filesystem configuration for the lambda function

    +

    Optional Readonlyfilesystem

    filesystem?: FileSystem

    The filesystem configuration for the lambda function

    Default

    - will not mount any filesystem
    @@ -264,7 +264,7 @@

    monitoringConfiguration

    monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring

    Monitoring configuration for the lambda.

    Opting-out via the NoMonitoring type is supported but discouraged.

    -

    Optional ReadonlyonFailure

    onFailure?: IDestination

    The destination for failed invocations.

    +

    Optional ReadonlyonFailure

    onFailure?: IDestination

    The destination for failed invocations.

    Default

    - no destination
    @@ -326,7 +326,7 @@
  • Schedule.expression("cron(0 8 ? * MON-FRI *)")
  • Schedule.rate(Duration.minutes(5))
    • -

    Readonlyruntime

    runtime: Runtime

    The runtime environment for the Lambda function that you are uploading. +

    Readonlyruntime

    runtime: Runtime

    The runtime environment for the Lambda function that you are uploading. For valid values, see the Runtime property in the AWS Lambda Developer Guide.

    Use Runtime.FROM_IMAGE when defining a function from a Docker image.

    @@ -357,7 +357,7 @@ concurrency limit (the reservedConcurrentExecutions prop) if you are concerned about throttling.

    See

    https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html

    -

    Optional Readonlytimeout

    timeout?: Duration

    The function execution time (in seconds) after which Lambda terminates +

    Optional Readonlytimeout

    timeout?: Duration

    The function execution time (in seconds) after which Lambda terminates the function. Because the execution time affects cost, set this value based on the function's expected execution time.

    Default

    Duration.seconds(3)
@@ -385,8 +385,8 @@
 managed elsewhere by DevX.
    
 
    This is used by RiffRaffYamlFileExperimental to skip generating
 an uploadLambda step.
    
-

    OptionalwithoutFilePrefix

    withoutFilePrefix?: boolean

    Set to true to use the filename without the stage/stack/app prefix.

    +

    OptionalwithoutFilePrefix

    withoutFilePrefix?: boolean

    Set to true to use the filename without the stage/stack/app prefix.

    Typically you should not override this but you may need to if, for example, you are referencing a file that is shared across many apps and/or AWS accounts.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    adotInstrumentationallowAllIpv6OutboundallowAllOutboundallowPublicSubnetappapplicationLogLevelapplicationLogLevelV2architecturebucketNamePathcodeSigningConfigcurrentVersionOptionsdeadLetterQueuedeadLetterQueueEnableddeadLetterTopicdescriptionenableVersioningenvironmentenvironmentEncryptionephemeralStorageSizeeventsfileNamefilesystemfunctionNamehandlerinitialPolicyinsightsVersionipv6AllowedForDualStacklayerslogFormatloggingFormatlogGrouplogRetentionlogRetentionRetryOptionslogRetentionRolemaxEventAgememorySizemonitoringConfigurationonFailureonSuccessparamsAndSecretsprofilingprofilingGrouprecursiveLoopreservedConcurrentExecutionsretryAttemptsrolerulesruntimeruntimeManagementModesecurityGroupssnapStartsystemLogLevelsystemLogLevelV2throttlingMonitoringtimeouttracingvpcvpcSubnetswithoutArtifactUploadwithoutFilePrefix
    +

    Settings

    Member Visibility

    On This Page

    Properties
    adotInstrumentationallowAllIpv6OutboundallowAllOutboundallowPublicSubnetappapplicationLogLevelapplicationLogLevelV2architecturebucketNamePathcodeSigningConfigcurrentVersionOptionsdeadLetterQueuedeadLetterQueueEnableddeadLetterTopicdescriptionenableVersioningenvironmentenvironmentEncryptionephemeralStorageSizeeventsfileNamefilesystemfunctionNamehandlerinitialPolicyinsightsVersionipv6AllowedForDualStacklayerslogFormatloggingFormatlogGrouplogRetentionlogRetentionRetryOptionslogRetentionRolemaxEventAgememorySizemonitoringConfigurationonFailureonSuccessparamsAndSecretsprofilingprofilingGrouprecursiveLoopreservedConcurrentExecutionsretryAttemptsrolerulesruntimeruntimeManagementModesecurityGroupssnapStartsystemLogLevelsystemLogLevelV2throttlingMonitoringtimeouttracingvpcvpcSubnetswithoutArtifactUploadwithoutFilePrefix
    diff --git a/interfaces/types.Access.html b/interfaces/types.Access.html index 0a00b13b54..8f841ba9ba 100644 --- a/interfaces/types.Access.html +++ b/interfaces/types.Access.html @@ -1,2 +1,2 @@ -Access | @guardian/cdk

    Interface Access

    interface Access {
        scope: AccessScope;
    }

    Hierarchy (view full)

    Properties

    scope -

    Properties

    scope

    scope: AccessScope

    Settings

    Member Visibility

    On This Page

    Properties
    +Access | @guardian/cdk

    Interface Access

    interface Access {
        scope: AccessScope;
    }

    Hierarchy (view full)

    Properties

    scope +

    Properties

    scope

    scope: AccessScope

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/types.GuAsgCapacity.html b/interfaces/types.GuAsgCapacity.html index ec35751052..cb9e18a270 100644 --- a/interfaces/types.GuAsgCapacity.html +++ b/interfaces/types.GuAsgCapacity.html @@ -1,4 +1,4 @@ -GuAsgCapacity | @guardian/cdk

    Interface GuAsgCapacity

    interface GuAsgCapacity {
        maximumInstances?: number;
        minimumInstances: number;
    }

    Hierarchy (view full)

    Properties

    maximumInstances? +GuAsgCapacity | @guardian/cdk

    Interface GuAsgCapacity

    interface GuAsgCapacity {
        maximumInstances?: number;
        minimumInstances: number;
    }

    Hierarchy (view full)

    Properties

    maximumInstances? minimumInstances

    Properties

    OptionalmaximumInstances

    maximumInstances?: number

    The maximum number of EC2 instances. If omitted, this will be set to minimumInstances * 2. @@ -6,6 +6,6 @@

    Should only be set if you need to scale beyond the default limit (e.g. due to heavy traffic), or restrict scaling for a specific reason.

    Note: If minimumInstances is defined with a Mapping maximumInstances must also be defined as a Mapping.

    -

    minimumInstances

    minimumInstances: number

    The number of EC2 instances running under normal circumstances, +

    minimumInstances

    minimumInstances: number

    The number of EC2 instances running under normal circumstances, i.e. when there are no deployment or scaling events in progress.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/types.GuDistributable.html b/interfaces/types.GuDistributable.html index bf35894d48..7ce6d796c9 100644 --- a/interfaces/types.GuDistributable.html +++ b/interfaces/types.GuDistributable.html @@ -1,4 +1,4 @@ -GuDistributable | @guardian/cdk

    Interface GuDistributable

    interface GuDistributable {
        fileName: string;
    }

    Hierarchy (view full)

    Properties

    fileName +GuDistributable | @guardian/cdk

    Interface GuDistributable

    interface GuDistributable {
        fileName: string;
    }

    Hierarchy (view full)

    Properties

    fileName

    Properties

    fileName

    fileName: string

    The filename for an executable package within the bucket [[GuDistributionBucketParameter]]. We'll look for fileName on the path "bucket/stack/stage/app/".

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/types.GuDistributableForEc2.html b/interfaces/types.GuDistributableForEc2.html index 154f168f92..48ac7741f7 100644 --- a/interfaces/types.GuDistributableForEc2.html +++ b/interfaces/types.GuDistributableForEc2.html @@ -1,7 +1,7 @@ -GuDistributableForEc2 | @guardian/cdk

    Interface GuDistributableForEc2

    interface GuDistributableForEc2 {
        executionStatement: string;
        fileName: string;
    }

    Hierarchy (view full)

    Properties

    executionStatement +GuDistributableForEc2 | @guardian/cdk

    Interface GuDistributableForEc2

    interface GuDistributableForEc2 {
        executionStatement: string;
        fileName: string;
    }

    Hierarchy (view full)

    Properties

    executionStatement fileName

    Properties

    executionStatement

    executionStatement: string

    The command to run fileName. For example dpkg -i application.deb or service foo start.

    -

    fileName

    fileName: string

    The filename for an executable package within the bucket [[GuDistributionBucketParameter]]. +

    fileName

    fileName: string

    The filename for an executable package within the bucket [[GuDistributionBucketParameter]]. We'll look for fileName on the path "bucket/stack/stage/app/".

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/types.GuDomainName.html b/interfaces/types.GuDomainName.html index 0dd3fb74d9..fe5bc4c377 100644 --- a/interfaces/types.GuDomainName.html +++ b/interfaces/types.GuDomainName.html @@ -1,9 +1,9 @@ -GuDomainName | @guardian/cdk

    Interface GuDomainName

    interface GuDomainName {
        domainName: string;
        hostedZoneId?: string;
    }

    Hierarchy (view full)

    Properties

    domainName +GuDomainName | @guardian/cdk

    Interface GuDomainName

    interface GuDomainName {
        domainName: string;
        hostedZoneId?: string;
    }

    Hierarchy (view full)

    Properties

    domainName hostedZoneId?

    Properties

    domainName

    domainName: string

    The Fully Qualified Domain Name.

    Example

    "riff-raff.gutools.co.uk"
    -

    OptionalhostedZoneId

    hostedZoneId?: string

    Route53 Zone ID.

    +

    OptionalhostedZoneId

    hostedZoneId?: string

    Route53 Zone ID.

    To be provided only if the zone for domainName is managed by Route53.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/types.InternalAccess.html b/interfaces/types.InternalAccess.html index 6f46dfc382..a78366505a 100644 --- a/interfaces/types.InternalAccess.html +++ b/interfaces/types.InternalAccess.html @@ -5,6 +5,6 @@ 
    {
      scope: AccessScope.INTERNAL,
      cidrRanges: [Peer.ipv4("10.0.0.0/8")]
    }
    -
    interface InternalAccess {
        cidrRanges: IPeer[];
        scope: INTERNAL;
    }

    Hierarchy (view full)

    Properties

    cidrRanges +
    interface InternalAccess {
        cidrRanges: IPeer[];
        scope: INTERNAL;
    }

    Hierarchy (view full)

    Properties

    cidrRanges scope -

    Properties

    cidrRanges

    cidrRanges: IPeer[]

    scope

    scope: INTERNAL

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    cidrRanges

    cidrRanges: IPeer[]

    scope

    scope: INTERNAL

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/types.PublicAccess.html b/interfaces/types.PublicAccess.html index 28c1d599f3..6fe37d5d74 100644 --- a/interfaces/types.PublicAccess.html +++ b/interfaces/types.PublicAccess.html @@ -5,5 +5,5 @@ 
    { scope: AccessScope.PUBLIC }
    -
    interface PublicAccess {
        scope: PUBLIC;
    }

    Hierarchy (view full)

    Properties

    scope -

    Properties

    scope

    scope: PUBLIC

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface PublicAccess {
        scope: PUBLIC;
    }

    Hierarchy (view full)

    Properties

    scope +

    Properties

    scope

    scope: PUBLIC

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/types.RestrictedAccess.html b/interfaces/types.RestrictedAccess.html index c760cdf5b0..166141854b 100644 --- a/interfaces/types.RestrictedAccess.html +++ b/interfaces/types.RestrictedAccess.html @@ -4,6 +4,6 @@ 
    {
      scope: AccessScope.RESTRICTED,
      cidrRanges: [Peer.ipv4("192.168.1.1/32"), Peer.ipv4("8.8.8.8/32")]
    }
    -
    interface RestrictedAccess {
        cidrRanges: IPeer[];
        scope: RESTRICTED;
    }

    Hierarchy (view full)

    Properties

    cidrRanges +
    interface RestrictedAccess {
        cidrRanges: IPeer[];
        scope: RESTRICTED;
    }

    Hierarchy (view full)

    Properties

    cidrRanges scope -

    Properties

    cidrRanges

    cidrRanges: IPeer[]

    scope

    scope: RESTRICTED

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    cidrRanges

    cidrRanges: IPeer[]

    scope

    scope: RESTRICTED

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/utils_ec2.GuPrivateS3ConfigurationProps.html b/interfaces/utils_ec2.GuPrivateS3ConfigurationProps.html index 0044932632..ee124ef747 100644 --- a/interfaces/utils_ec2.GuPrivateS3ConfigurationProps.html +++ b/interfaces/utils_ec2.GuPrivateS3ConfigurationProps.html @@ -1,6 +1,6 @@ GuPrivateS3ConfigurationProps | @guardian/cdk

    Interface GuPrivateS3ConfigurationProps

    Information about an ec2 app's private configuration. files are paths from the root of the bucket. TODO change this once we have defined best practice for configuration.

    -
    interface GuPrivateS3ConfigurationProps {
        bucket: GuPrivateConfigBucketParameter;
        files: string[];
    }

    Properties

    bucket +
    interface GuPrivateS3ConfigurationProps {
        bucket: GuPrivateConfigBucketParameter;
        files: string[];
    }

    Properties

    bucket files -

    Properties

    bucket

    bucket: GuPrivateConfigBucketParameter

    files

    files: string[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    bucket

    bucket: GuPrivateConfigBucketParameter

    files

    files: string[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/utils_lambda.StreamErrorHandlingProps.html b/interfaces/utils_lambda.StreamErrorHandlingProps.html index 6eed18c381..4257214062 100644 --- a/interfaces/utils_lambda.StreamErrorHandlingProps.html +++ b/interfaces/utils_lambda.StreamErrorHandlingProps.html @@ -8,8 +8,8 @@

    Records which could not be processed successfully can (optionally) be sent to a dead letter queue via deadLetterQueueForSkippedRecords.

    -
    interface StreamErrorHandlingProps {
        bisectBatchOnError: boolean;
        blockProcessingAndRetryIndefinitely?: false;
        deadLetterQueueForSkippedRecords?: IEventSourceDlq;
        retryBehaviour: StreamRetry;
    }

    Properties

    bisectBatchOnError +
    interface StreamErrorHandlingProps {
        bisectBatchOnError: boolean;
        blockProcessingAndRetryIndefinitely?: false;
        deadLetterQueueForSkippedRecords?: IEventSourceDlq;
        retryBehaviour: StreamRetry;
    }

    Properties

    bisectBatchOnError blockProcessingAndRetryIndefinitely? deadLetterQueueForSkippedRecords? retryBehaviour -

    Properties

    bisectBatchOnError

    bisectBatchOnError: boolean

    OptionalblockProcessingAndRetryIndefinitely

    blockProcessingAndRetryIndefinitely

    OptionaldeadLetterQueueForSkippedRecords

    deadLetterQueueForSkippedRecords?: IEventSourceDlq

    retryBehaviour

    retryBehaviour: StreamRetry

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    bisectBatchOnError

    bisectBatchOnError: boolean

    OptionalblockProcessingAndRetryIndefinitely

    blockProcessingAndRetryIndefinitely

    OptionaldeadLetterQueueForSkippedRecords

    deadLetterQueueForSkippedRecords?: IEventSourceDlq

    retryBehaviour

    retryBehaviour: StreamRetry

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/modules/constants.html b/modules/constants.html index 766a33e10d..ec508f5b37 100644 --- a/modules/constants.html +++ b/modules/constants.html @@ -1,4 +1,4 @@ -constants | @guardian/cdk

    Module constants

    Index

    Enumerations

    AccessScope +constants | @guardian/cdk

    Module constants

    Index

    Enumerations

    AccessScope

    Interfaces

    SsmParameterPath

    Variables

    ALL_SSM_PARAMETER_PATHS ContextKeys diff --git a/modules/constructs_acm.html b/modules/constructs_acm.html index 905d09729c..bbb168ac0d 100644 --- a/modules/constructs_acm.html +++ b/modules/constructs_acm.html @@ -1,3 +1,3 @@ -constructs/acm | @guardian/cdk

    Module constructs/acm

    Index

    Classes

    GuCertificate +constructs/acm | @guardian/cdk

    Module constructs/acm

    Index

    Classes

    GuCertificate

    Type Aliases

    GuCertificatePropsWithApp

    Settings

    Member Visibility
    diff --git a/modules/constructs_autoscaling.html b/modules/constructs_autoscaling.html index a1437ebfb4..038d58cd3a 100644 --- a/modules/constructs_autoscaling.html +++ b/modules/constructs_autoscaling.html @@ -1,4 +1,4 @@ -constructs/autoscaling | @guardian/cdk

    Module constructs/autoscaling

    Index

    Classes

    GuAutoScalingGroup +constructs/autoscaling | @guardian/cdk

    Module constructs/autoscaling

    Index

    Classes

    GuAutoScalingGroup GuUserData

    Interfaces

    GuAutoScalingGroupProps GuUserDataProps diff --git a/modules/constructs_cloudwatch.html b/modules/constructs_cloudwatch.html index 0e8050686b..22f64cb3c2 100644 --- a/modules/constructs_cloudwatch.html +++ b/modules/constructs_cloudwatch.html @@ -1,4 +1,4 @@ -constructs/cloudwatch | @guardian/cdk

    Module constructs/cloudwatch

    Index

    Classes

    GuAlarm +constructs/cloudwatch | @guardian/cdk

    Module constructs/cloudwatch

    Index

    Classes

    GuAlarm GuAlb4xxPercentageAlarm GuAlb5xxPercentageAlarm GuLambdaErrorPercentageAlarm diff --git a/modules/constructs_core.html b/modules/constructs_core.html index 736413f4dd..93d219f534 100644 --- a/modules/constructs_core.html +++ b/modules/constructs_core.html @@ -1,4 +1,4 @@ -constructs/core | @guardian/cdk

    Module constructs/core

    Index

    Classes

    GuAccessLoggingBucketParameter +constructs/core | @guardian/cdk

    Module constructs/core

    Index

    Classes

    GuAccessLoggingBucketParameter GuAmiParameter GuAnghammaradTopicParameter GuArnParameter diff --git a/modules/constructs_dns.html b/modules/constructs_dns.html index 6b89746524..5d5c9c5c5c 100644 --- a/modules/constructs_dns.html +++ b/modules/constructs_dns.html @@ -1,4 +1,4 @@ -constructs/dns | @guardian/cdk

    Module constructs/dns

    Index

    Enumerations

    RecordType +constructs/dns | @guardian/cdk

    Module constructs/dns

    Index

    Enumerations

    RecordType

    Classes

    GuCname GuDnsRecordSet

    Interfaces

    GuCnameProps diff --git a/modules/constructs_dynamodb.html b/modules/constructs_dynamodb.html index e5d62d62e7..a7cb3fdbe1 100644 --- a/modules/constructs_dynamodb.html +++ b/modules/constructs_dynamodb.html @@ -1,4 +1,4 @@ -constructs/dynamodb | @guardian/cdk

    Module constructs/dynamodb

    Index

    Classes

    GuDynamoTable +constructs/dynamodb | @guardian/cdk

    Module constructs/dynamodb

    Index

    Classes

    GuDynamoTable

    Interfaces

    GuDynamoTableProps OptIn OptOut diff --git a/modules/constructs_ec2.html b/modules/constructs_ec2.html index ade9dbe375..b795b2b2dd 100644 --- a/modules/constructs_ec2.html +++ b/modules/constructs_ec2.html @@ -1,4 +1,4 @@ -constructs/ec2 | @guardian/cdk

    Module constructs/ec2

    Index

    Enumerations

    SubnetType +constructs/ec2 | @guardian/cdk

    Module constructs/ec2

    Index

    Enumerations

    SubnetType

    Classes

    GuBaseSecurityGroup GuHttpsEgressSecurityGroup GuSecurityGroup diff --git a/modules/constructs_ecs.html b/modules/constructs_ecs.html index b4b30d4cb9..321af0f2d9 100644 --- a/modules/constructs_ecs.html +++ b/modules/constructs_ecs.html @@ -1,4 +1,4 @@ -constructs/ecs | @guardian/cdk

    Module constructs/ecs

    Index

    Classes

    GuEcsTask +constructs/ecs | @guardian/cdk

    Module constructs/ecs

    Index

    Classes

    GuEcsTask

    Interfaces

    GuEcsTaskProps

    Type Aliases

    ContainerConfiguration GuEcsTaskMonitoringProps diff --git a/modules/constructs_iam.html b/modules/constructs_iam.html index 2336d21d21..e9e5dec0ce 100644 --- a/modules/constructs_iam.html +++ b/modules/constructs_iam.html @@ -1,4 +1,4 @@ -constructs/iam | @guardian/cdk

    Module constructs/iam

    Index

    Classes

    GuAllowPolicy +constructs/iam | @guardian/cdk

    Module constructs/iam

    Index

    Classes

    GuAllowPolicy GuAnghammaradSenderPolicy GuAssumeRolePolicy GuDenyPolicy diff --git a/modules/constructs_kinesis.html b/modules/constructs_kinesis.html index 4da04d2ffe..149d321bd4 100644 --- a/modules/constructs_kinesis.html +++ b/modules/constructs_kinesis.html @@ -1,3 +1,3 @@ -constructs/kinesis | @guardian/cdk

    Module constructs/kinesis

    Index

    Classes

    GuKinesisStream +constructs/kinesis | @guardian/cdk

    Module constructs/kinesis

    Index

    Classes

    GuKinesisStream

    Type Aliases

    GuKinesisStreamProps

    Settings

    Member Visibility
    diff --git a/modules/constructs_lambda.html b/modules/constructs_lambda.html index c71957d7a4..02ed7767af 100644 --- a/modules/constructs_lambda.html +++ b/modules/constructs_lambda.html @@ -1,3 +1,3 @@ -constructs/lambda | @guardian/cdk

    Module constructs/lambda

    Index

    Classes

    GuLambdaFunction +constructs/lambda | @guardian/cdk

    Module constructs/lambda

    Index

    Classes

    GuLambdaFunction

    Interfaces

    GuFunctionProps

    Settings

    Member Visibility
    diff --git a/modules/constructs_loadbalancing.html b/modules/constructs_loadbalancing.html index 744123e77b..804d492cde 100644 --- a/modules/constructs_loadbalancing.html +++ b/modules/constructs_loadbalancing.html @@ -1,4 +1,4 @@ -constructs/loadbalancing | @guardian/cdk

    Module constructs/loadbalancing

    Index

    Classes

    GuApplicationListener +constructs/loadbalancing | @guardian/cdk

    Module constructs/loadbalancing

    Index

    Classes

    GuApplicationListener GuApplicationLoadBalancer GuApplicationTargetGroup GuHttpsApplicationListener diff --git a/modules/constructs_rds.html b/modules/constructs_rds.html index 43246e938c..9d72acf159 100644 --- a/modules/constructs_rds.html +++ b/modules/constructs_rds.html @@ -1,4 +1,4 @@ -constructs/rds | @guardian/cdk

    Module constructs/rds

    Index

    Classes

    GuDatabaseInstance +constructs/rds | @guardian/cdk

    Module constructs/rds

    Index

    Classes

    GuDatabaseInstance

    Interfaces

    GuDatabaseInstanceProps OptIn OptOut diff --git a/modules/constructs_s3.html b/modules/constructs_s3.html index 815edc4ba0..3dc21185aa 100644 --- a/modules/constructs_s3.html +++ b/modules/constructs_s3.html @@ -1,3 +1,3 @@ -constructs/s3 | @guardian/cdk

    Module constructs/s3

    Index

    Classes

    GuS3Bucket +constructs/s3 | @guardian/cdk

    Module constructs/s3

    Index

    Classes

    GuS3Bucket

    Interfaces

    GuS3BucketProps

    Settings

    Member Visibility
    diff --git a/modules/constructs_ses.html b/modules/constructs_ses.html index dcb4a8156b..4a5c9ab3f8 100644 --- a/modules/constructs_ses.html +++ b/modules/constructs_ses.html @@ -1,3 +1,3 @@ -constructs/ses | @guardian/cdk

    Module constructs/ses

    Index

    Classes

    GuEmailIdentity +constructs/ses | @guardian/cdk

    Module constructs/ses

    Index

    Classes

    GuEmailIdentity

    Interfaces

    GuEmailIdentityProps

    Settings

    Member Visibility
    diff --git a/modules/constructs_vpc.html b/modules/constructs_vpc.html index 84454f740e..ce634735b7 100644 --- a/modules/constructs_vpc.html +++ b/modules/constructs_vpc.html @@ -1,3 +1,3 @@ -constructs/vpc | @guardian/cdk

    Module constructs/vpc

    Index

    Classes

    GuVpc +constructs/vpc | @guardian/cdk

    Module constructs/vpc

    Index

    Classes

    GuVpc

    Type Aliases

    GuVpcProps

    Settings

    Member Visibility
    diff --git a/modules/experimental_patterns.html b/modules/experimental_patterns.html index e09cc11c5f..0145a8c2e7 100644 --- a/modules/experimental_patterns.html +++ b/modules/experimental_patterns.html @@ -1,4 +1,4 @@ -experimental/patterns | @guardian/cdk

    Module experimental/patterns

    Index

    Classes

    GuKinesisLambdaExperimental +experimental/patterns | @guardian/cdk

    Module experimental/patterns

    Index

    Classes

    GuKinesisLambdaExperimental GuSnsLambdaExperimental

    Interfaces

    ExistingKinesisStream ExistingSnsTopic diff --git a/modules/patterns.html b/modules/patterns.html index cbade4f1c8..1c24d02762 100644 --- a/modules/patterns.html +++ b/modules/patterns.html @@ -1,4 +1,4 @@ -patterns | @guardian/cdk

    Module patterns

    Index

    Classes

    GuApiGatewayWithLambdaByPath +patterns | @guardian/cdk

    Module patterns

    Index

    Classes

    GuApiGatewayWithLambdaByPath GuApiLambda GuEc2App GuNodeApp diff --git a/modules/types.html b/modules/types.html index d6ee879495..0126aaa059 100644 --- a/modules/types.html +++ b/modules/types.html @@ -1,4 +1,4 @@ -types | @guardian/cdk

    Module types

    Index

    Interfaces

    Access +types | @guardian/cdk

    Module types

    Index

    Interfaces

    Access GuAsgCapacity GuDistributable GuDistributableForEc2 diff --git a/modules/utils_ec2.html b/modules/utils_ec2.html index 1d0f2f2534..4160dee092 100644 --- a/modules/utils_ec2.html +++ b/modules/utils_ec2.html @@ -1,2 +1,2 @@ -utils/ec2 | @guardian/cdk

    Module utils/ec2

    Index

    Interfaces

    GuPrivateS3ConfigurationProps +utils/ec2 | @guardian/cdk

    Module utils/ec2

    Index

    Interfaces

    GuPrivateS3ConfigurationProps

    Settings

    Member Visibility
    diff --git a/modules/utils_lambda.html b/modules/utils_lambda.html index 3ceffd8cb0..46f5455ac0 100644 --- a/modules/utils_lambda.html +++ b/modules/utils_lambda.html @@ -1,4 +1,4 @@ -utils/lambda | @guardian/cdk

    Module utils/lambda

    Index

    Classes

    StreamRetry +utils/lambda | @guardian/cdk

    Module utils/lambda

    Index

    Classes

    StreamRetry

    Interfaces

    StreamErrorHandlingProps

    Type Aliases

    StreamProcessingProps

    Functions

    toAwsErrorHandlingProps diff --git a/modules/utils_security_groups.html b/modules/utils_security_groups.html index 40606342a9..51d57515d3 100644 --- a/modules/utils_security_groups.html +++ b/modules/utils_security_groups.html @@ -1,2 +1,2 @@ -utils/security-groups | @guardian/cdk

    Module utils/security-groups

    Index

    Functions

    transformToSecurityGroupAccessRule +utils/security-groups | @guardian/cdk

    Module utils/security-groups

    Index

    Functions

    transformToSecurityGroupAccessRule

    Settings

    Member Visibility
    diff --git a/modules/utils_test.html b/modules/utils_test.html index 74de482206..90cb2b731c 100644 --- a/modules/utils_test.html +++ b/modules/utils_test.html @@ -1,4 +1,4 @@ -utils/test | @guardian/cdk

    Module utils/test

    Index

    Classes

    GuTemplate +utils/test | @guardian/cdk

    Module utils/test

    Index

    Classes

    GuTemplate

    Functions

    attachPolicyToTestRole getTemplateAfterAspectInvocation simpleGuStackForTesting diff --git a/types/constructs_acm.GuCertificatePropsWithApp.html b/types/constructs_acm.GuCertificatePropsWithApp.html index b8872dedab..bbe8931d0e 100644 --- a/types/constructs_acm.GuCertificatePropsWithApp.html +++ b/types/constructs_acm.GuCertificatePropsWithApp.html @@ -1 +1 @@ -GuCertificatePropsWithApp | @guardian/cdk

    Type Alias GuCertificatePropsWithApp

    GuCertificatePropsWithApp: GuDomainName & AppIdentity

    Settings

    Member Visibility
    +GuCertificatePropsWithApp | @guardian/cdk

    Type Alias GuCertificatePropsWithApp

    GuCertificatePropsWithApp: GuDomainName & AppIdentity

    Settings

    Member Visibility
    diff --git a/types/constructs_autoscaling.GuUserDataPropsWithApp.html b/types/constructs_autoscaling.GuUserDataPropsWithApp.html index 6f4310d181..fd6c8bbcf6 100644 --- a/types/constructs_autoscaling.GuUserDataPropsWithApp.html +++ b/types/constructs_autoscaling.GuUserDataPropsWithApp.html @@ -1 +1 @@ -GuUserDataPropsWithApp | @guardian/cdk

    Type Alias GuUserDataPropsWithApp

    GuUserDataPropsWithApp: GuUserDataProps & AppIdentity

    Settings

    Member Visibility
    +GuUserDataPropsWithApp | @guardian/cdk

    Type Alias GuUserDataPropsWithApp

    GuUserDataPropsWithApp: GuUserDataProps & AppIdentity

    Settings

    Member Visibility
    diff --git a/types/constructs_core.GuNoTypeParameterProps.html b/types/constructs_core.GuNoTypeParameterProps.html index 60c59dc1d3..d8cf9d2492 100644 --- a/types/constructs_core.GuNoTypeParameterProps.html +++ b/types/constructs_core.GuNoTypeParameterProps.html @@ -1 +1 @@ -GuNoTypeParameterProps | @guardian/cdk

    Type Alias GuNoTypeParameterProps

    GuNoTypeParameterProps: Omit<GuParameterProps, "type">

    Settings

    Member Visibility
    +GuNoTypeParameterProps | @guardian/cdk

    Type Alias GuNoTypeParameterProps

    GuNoTypeParameterProps: Omit<GuParameterProps, "type">

    Settings

    Member Visibility
    diff --git a/types/constructs_core.GuNoTypeParameterPropsWithAppIdentity.html b/types/constructs_core.GuNoTypeParameterPropsWithAppIdentity.html index 8391f90481..bd87c5648b 100644 --- a/types/constructs_core.GuNoTypeParameterPropsWithAppIdentity.html +++ b/types/constructs_core.GuNoTypeParameterPropsWithAppIdentity.html @@ -1 +1 @@ -GuNoTypeParameterPropsWithAppIdentity | @guardian/cdk

    Type Alias GuNoTypeParameterPropsWithAppIdentity

    GuNoTypeParameterPropsWithAppIdentity: Omit<GuParameterProps, "type"> & AppIdentity

    Settings

    Member Visibility
    +GuNoTypeParameterPropsWithAppIdentity | @guardian/cdk

    Type Alias GuNoTypeParameterPropsWithAppIdentity

    GuNoTypeParameterPropsWithAppIdentity: Omit<GuParameterProps, "type"> & AppIdentity

    Settings

    Member Visibility
    diff --git a/types/constructs_ecs.ContainerConfiguration.html b/types/constructs_ecs.ContainerConfiguration.html index 0890415d62..65918f5795 100644 --- a/types/constructs_ecs.ContainerConfiguration.html +++ b/types/constructs_ecs.ContainerConfiguration.html @@ -1 +1 @@ -ContainerConfiguration | @guardian/cdk

    Type Alias ContainerConfiguration

    ContainerConfiguration: RepositoryContainer | RegistryContainer

    Settings

    Member Visibility
    +ContainerConfiguration | @guardian/cdk

    Type Alias ContainerConfiguration

    ContainerConfiguration: RepositoryContainer | RegistryContainer

    Settings

    Member Visibility
    diff --git a/types/constructs_ecs.GuEcsTaskMonitoringProps.html b/types/constructs_ecs.GuEcsTaskMonitoringProps.html index f463a010ea..ab27fc385d 100644 --- a/types/constructs_ecs.GuEcsTaskMonitoringProps.html +++ b/types/constructs_ecs.GuEcsTaskMonitoringProps.html @@ -1 +1 @@ -GuEcsTaskMonitoringProps | @guardian/cdk

    Type Alias GuEcsTaskMonitoringProps

    GuEcsTaskMonitoringProps: {
        noMonitoring: false;
        snsTopicArn: string;
    }

    Settings

    Member Visibility
    +GuEcsTaskMonitoringProps | @guardian/cdk

    Type Alias GuEcsTaskMonitoringProps

    GuEcsTaskMonitoringProps: {
        noMonitoring: false;
        snsTopicArn: string;
    }

    Settings

    Member Visibility
    diff --git a/types/constructs_ecs.RegistryContainer.html b/types/constructs_ecs.RegistryContainer.html index 08e3295e6f..1317339174 100644 --- a/types/constructs_ecs.RegistryContainer.html +++ b/types/constructs_ecs.RegistryContainer.html @@ -1 +1 @@ -RegistryContainer | @guardian/cdk

    Type Alias RegistryContainer

    RegistryContainer: {
        id?: string;
        imageProps?: RepositoryImageProps;
        type: "registry";
    }

    Settings

    Member Visibility
    +RegistryContainer | @guardian/cdk

    Type Alias RegistryContainer

    RegistryContainer: {
        id?: string;
        imageProps?: RepositoryImageProps;
        type: "registry";
    }

    Settings

    Member Visibility
    diff --git a/types/constructs_ecs.RepositoryContainer.html b/types/constructs_ecs.RepositoryContainer.html index 8869039055..e1615ba132 100644 --- a/types/constructs_ecs.RepositoryContainer.html +++ b/types/constructs_ecs.RepositoryContainer.html @@ -7,4 +7,4 @@ 
    import { Repository } from "aws-cdk-lib/aws-ecr";
    const repository = new Repository(scope, `${app}-repository`, {
       repositoryName: app,
     });
    const containerConfiguration = {
        repository: Repository.fromRepositoryArn("<repository arn>"),
        version: '1'
    }
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/types/constructs_iam.GuDenyPolicyProps.html b/types/constructs_iam.GuDenyPolicyProps.html index 4b07b6294b..9805ccd644 100644 --- a/types/constructs_iam.GuDenyPolicyProps.html +++ b/types/constructs_iam.GuDenyPolicyProps.html @@ -1 +1 @@ -GuDenyPolicyProps | @guardian/cdk

    Type Alias GuDenyPolicyProps

    GuDenyPolicyProps: GuAllowPolicyProps

    Settings

    Member Visibility
    +GuDenyPolicyProps | @guardian/cdk

    Type Alias GuDenyPolicyProps

    GuDenyPolicyProps: GuAllowPolicyProps

    Settings

    Member Visibility
    diff --git a/types/constructs_iam.GuInstanceRolePropsWithApp.html b/types/constructs_iam.GuInstanceRolePropsWithApp.html index 27643c6395..15f6555ed1 100644 --- a/types/constructs_iam.GuInstanceRolePropsWithApp.html +++ b/types/constructs_iam.GuInstanceRolePropsWithApp.html @@ -1 +1 @@ -GuInstanceRolePropsWithApp | @guardian/cdk

    Type Alias GuInstanceRolePropsWithApp

    GuInstanceRolePropsWithApp: GuInstanceRoleProps & AppIdentity

    Settings

    Member Visibility
    +GuInstanceRolePropsWithApp | @guardian/cdk

    Type Alias GuInstanceRolePropsWithApp

    GuInstanceRolePropsWithApp: GuInstanceRoleProps & AppIdentity

    Settings

    Member Visibility
    diff --git a/types/constructs_iam.GuNoStatementsPolicyProps.html b/types/constructs_iam.GuNoStatementsPolicyProps.html index 7bd46ce508..a925851b75 100644 --- a/types/constructs_iam.GuNoStatementsPolicyProps.html +++ b/types/constructs_iam.GuNoStatementsPolicyProps.html @@ -1 +1 @@ -GuNoStatementsPolicyProps | @guardian/cdk

    Type Alias GuNoStatementsPolicyProps

    GuNoStatementsPolicyProps: Omit<GuPolicyProps, "statements">

    Settings

    Member Visibility
    +GuNoStatementsPolicyProps | @guardian/cdk

    Type Alias GuNoStatementsPolicyProps

    GuNoStatementsPolicyProps: Omit<GuPolicyProps, "statements">

    Settings

    Member Visibility
    diff --git a/types/constructs_iam.GuPolicyProps.html b/types/constructs_iam.GuPolicyProps.html index dd8bc89a5c..742c919362 100644 --- a/types/constructs_iam.GuPolicyProps.html +++ b/types/constructs_iam.GuPolicyProps.html @@ -1 +1 @@ -GuPolicyProps | @guardian/cdk

    Type Alias GuPolicyProps

    GuPolicyProps: PolicyProps

    Settings

    Member Visibility
    +GuPolicyProps | @guardian/cdk

    Type Alias GuPolicyProps

    GuPolicyProps: PolicyProps

    Settings

    Member Visibility
    diff --git a/types/constructs_iam.GuRoleProps.html b/types/constructs_iam.GuRoleProps.html index c22e43e747..81a80c9fee 100644 --- a/types/constructs_iam.GuRoleProps.html +++ b/types/constructs_iam.GuRoleProps.html @@ -1 +1 @@ -GuRoleProps | @guardian/cdk

    Type Alias GuRoleProps

    GuRoleProps: RoleProps

    Settings

    Member Visibility
    +GuRoleProps | @guardian/cdk

    Type Alias GuRoleProps

    GuRoleProps: RoleProps

    Settings

    Member Visibility
    diff --git a/types/constructs_kinesis.GuKinesisStreamProps.html b/types/constructs_kinesis.GuKinesisStreamProps.html index ee04443627..c40ed85260 100644 --- a/types/constructs_kinesis.GuKinesisStreamProps.html +++ b/types/constructs_kinesis.GuKinesisStreamProps.html @@ -1 +1 @@ -GuKinesisStreamProps | @guardian/cdk

    Type Alias GuKinesisStreamProps

    GuKinesisStreamProps: StreamProps

    Settings

    Member Visibility
    +GuKinesisStreamProps | @guardian/cdk

    Type Alias GuKinesisStreamProps

    GuKinesisStreamProps: StreamProps

    Settings

    Member Visibility
    diff --git a/types/constructs_vpc.GuVpcProps.html b/types/constructs_vpc.GuVpcProps.html index 9f3aad8a4c..785da6b29f 100644 --- a/types/constructs_vpc.GuVpcProps.html +++ b/types/constructs_vpc.GuVpcProps.html @@ -1 +1 @@ -GuVpcProps | @guardian/cdk

    Type Alias GuVpcProps

    GuVpcProps: VpcProps

    Settings

    Member Visibility
    +GuVpcProps | @guardian/cdk

    Type Alias GuVpcProps

    GuVpcProps: VpcProps

    Settings

    Member Visibility
    diff --git a/types/patterns.HttpMethod.html b/types/patterns.HttpMethod.html index c6c2790311..54d8bf274f 100644 --- a/types/patterns.HttpMethod.html +++ b/types/patterns.HttpMethod.html @@ -1,2 +1,2 @@ HttpMethod | @guardian/cdk

    Type Alias HttpMethod

    HttpMethod:
        | "GET"
        | "HEAD"
        | "POST"
        | "PUT"
        | "DELETE"
        | "CONNECT"
        | "OPTIONS"
        | "TRACE"
        | "PATCH"

    See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/types/types.AppAccess.html b/types/types.AppAccess.html index cc35632c52..b649f61d3b 100644 --- a/types/types.AppAccess.html +++ b/types/types.AppAccess.html @@ -1 +1 @@ -AppAccess | @guardian/cdk

    Type Alias AppAccess

    AppAccess: PublicAccess | RestrictedAccess | InternalAccess

    Settings

    Member Visibility
    +AppAccess | @guardian/cdk

    Type Alias AppAccess

    AppAccess: PublicAccess | RestrictedAccess | InternalAccess

    Settings

    Member Visibility
    diff --git a/types/utils_lambda.StreamProcessingProps.html b/types/utils_lambda.StreamProcessingProps.html index ae7b19011d..63081dc4fb 100644 --- a/types/utils_lambda.StreamProcessingProps.html +++ b/types/utils_lambda.StreamProcessingProps.html @@ -1 +1 @@ -StreamProcessingProps | @guardian/cdk

    Type Alias StreamProcessingProps

    StreamProcessingProps: Omit<KinesisEventSourceProps,
        | "bisectBatchOnError"
        | "maxRecordAge"
        | "onFailure"
        | "retryAttempts">

    Settings

    Member Visibility
    +StreamProcessingProps | @guardian/cdk

    Type Alias StreamProcessingProps

    StreamProcessingProps: Omit<KinesisEventSourceProps,
        | "bisectBatchOnError"
        | "maxRecordAge"
        | "onFailure"
        | "retryAttempts">

    Settings

    Member Visibility
    diff --git a/variables/constants.ALL_SSM_PARAMETER_PATHS.html b/variables/constants.ALL_SSM_PARAMETER_PATHS.html index 52d838fe2a..a8b2ed1bda 100644 --- a/variables/constants.ALL_SSM_PARAMETER_PATHS.html +++ b/variables/constants.ALL_SSM_PARAMETER_PATHS.html @@ -1 +1 @@ -ALL_SSM_PARAMETER_PATHS | @guardian/cdk

    Variable ALL_SSM_PARAMETER_PATHSConst

    ALL_SSM_PARAMETER_PATHS: SsmParameterPath[] = ...

    Settings

    Member Visibility
    +ALL_SSM_PARAMETER_PATHS | @guardian/cdk

    Variable ALL_SSM_PARAMETER_PATHSConst

    ALL_SSM_PARAMETER_PATHS: SsmParameterPath[] = ...

    Settings

    Member Visibility
    diff --git a/variables/constants.ContextKeys.html b/variables/constants.ContextKeys.html index c93280efd8..c335703bd9 100644 --- a/variables/constants.ContextKeys.html +++ b/variables/constants.ContextKeys.html @@ -1,2 +1,2 @@ ContextKeys | @guardian/cdk

    Variable ContextKeysConst

    ContextKeys: {
        REPOSITORY_URL: string;
    } = ...

    A list of items we will read from the CDK context

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/variables/constants.FASTLY_AWS_ACCOUNT_ID.html b/variables/constants.FASTLY_AWS_ACCOUNT_ID.html index 444c10acca..5f4fef9dce 100644 --- a/variables/constants.FASTLY_AWS_ACCOUNT_ID.html +++ b/variables/constants.FASTLY_AWS_ACCOUNT_ID.html @@ -2,4 +2,4 @@ This is needed by IAM roles assumed by Fastly in order to write into an S3 bucket or a Kinesis stream. See https://docs.fastly.com/en/guides/creating-an-aws-iam-role-for-fastly-logging

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/variables/constants.LibraryInfo.html b/variables/constants.LibraryInfo.html index 6ed7dbff84..8a2edd0b75 100644 --- a/variables/constants.LibraryInfo.html +++ b/variables/constants.LibraryInfo.html @@ -4,4 +4,4 @@ You need to match this version exactly.

  • NAME: string

    The name of this package

  • VERSION: string

    The current version of @guardian/cdk.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/variables/constants.MetadataKeys.html b/variables/constants.MetadataKeys.html index 71223d3cf7..f82b43fcba 100644 --- a/variables/constants.MetadataKeys.html +++ b/variables/constants.MetadataKeys.html @@ -1 +1 @@ -MetadataKeys | @guardian/cdk

    Variable MetadataKeysConst

    MetadataKeys: {
        BUILD_IDENTIFIER: string;
        CONSTRUCTS_KEY: string;
        LOG_KINESIS_STREAM_NAME: string;
        REPOSITORY_NAME: string;
        SYSTEMD_UNIT: string;
        VERSION: string;
    } = ...

    Settings

    Member Visibility
    +MetadataKeys | @guardian/cdk

    Variable MetadataKeysConst

    MetadataKeys: {
        BUILD_IDENTIFIER: string;
        CONSTRUCTS_KEY: string;
        LOG_KINESIS_STREAM_NAME: string;
        REPOSITORY_NAME: string;
        SYSTEMD_UNIT: string;
        VERSION: string;
    } = ...

    Settings

    Member Visibility
    diff --git a/variables/constants.NAMED_SSM_PARAMETER_PATHS.html b/variables/constants.NAMED_SSM_PARAMETER_PATHS.html index 71904d575d..ea5916c2a7 100644 --- a/variables/constants.NAMED_SSM_PARAMETER_PATHS.html +++ b/variables/constants.NAMED_SSM_PARAMETER_PATHS.html @@ -1 +1 @@ -NAMED_SSM_PARAMETER_PATHS | @guardian/cdk

    Variable NAMED_SSM_PARAMETER_PATHSConst

    NAMED_SSM_PARAMETER_PATHS: NamedSsmParameterPaths = ...

    Settings

    Member Visibility
    +NAMED_SSM_PARAMETER_PATHS | @guardian/cdk

    Variable NAMED_SSM_PARAMETER_PATHSConst

    NAMED_SSM_PARAMETER_PATHS: NamedSsmParameterPaths = ...

    Settings

    Member Visibility
    diff --git a/variables/constants.RegexPattern.html b/variables/constants.RegexPattern.html index 9bc8f7810f..e4e972145c 100644 --- a/variables/constants.RegexPattern.html +++ b/variables/constants.RegexPattern.html @@ -1 +1 @@ -RegexPattern | @guardian/cdk

    Variable RegexPatternConst

    RegexPattern: {
        ACM_ARN: string;
        ARN: string;
        S3ARN: string;
    } = ...

    Settings

    Member Visibility
    +RegexPattern | @guardian/cdk

    Variable RegexPatternConst

    RegexPattern: {
        ACM_ARN: string;
        ARN: string;
        S3ARN: string;
    } = ...

    Settings

    Member Visibility
    diff --git a/variables/constants.TrackingTag.html b/variables/constants.TrackingTag.html index b814fb93f6..b4057deb44 100644 --- a/variables/constants.TrackingTag.html +++ b/variables/constants.TrackingTag.html @@ -1 +1 @@ -TrackingTag | @guardian/cdk

    Variable TrackingTagConst

    TrackingTag: {
        Key: string;
        Value: string;
    } = ...

    Settings

    Member Visibility
    +TrackingTag | @guardian/cdk

    Variable TrackingTagConst

    TrackingTag: {
        Key: string;
        Value: string;
    } = ...

    Settings

    Member Visibility
    diff --git a/variables/constants.VPC_SSM_PARAMETER_PREFIX.html b/variables/constants.VPC_SSM_PARAMETER_PREFIX.html index 18b4afada9..6ceb5cb7e8 100644 --- a/variables/constants.VPC_SSM_PARAMETER_PREFIX.html +++ b/variables/constants.VPC_SSM_PARAMETER_PREFIX.html @@ -1 +1 @@ -VPC_SSM_PARAMETER_PREFIX | @guardian/cdk

    Variable VPC_SSM_PARAMETER_PREFIXConst

    VPC_SSM_PARAMETER_PREFIX = "/account/vpc"

    Settings

    Member Visibility
    +VPC_SSM_PARAMETER_PREFIX | @guardian/cdk

    Variable VPC_SSM_PARAMETER_PREFIXConst

    VPC_SSM_PARAMETER_PREFIX = "/account/vpc"

    Settings

    Member Visibility
    diff --git a/variables/constructs_core.AppIdentity-1.html b/variables/constructs_core.AppIdentity-1.html index 92166dde03..15b9484458 100644 --- a/variables/constructs_core.AppIdentity-1.html +++ b/variables/constructs_core.AppIdentity-1.html @@ -1 +1 @@ -AppIdentity | @guardian/cdk

    Variable AppIdentity

    AppIdentity: {
        isAppIdentity(props: any): props is AppIdentity;
        suffixText(appIdentity: AppIdentity, text: string): string;
        taggedConstruct<T>(appIdentity: AppIdentity, construct: T): T;
    }

    Settings

    Member Visibility
    +AppIdentity | @guardian/cdk

    Variable AppIdentity

    AppIdentity: {
        isAppIdentity(props: any): props is AppIdentity;
        suffixText(appIdentity: AppIdentity, text: string): string;
        taggedConstruct<T>(appIdentity: AppIdentity, construct: T): T;
    }

    Settings

    Member Visibility
    diff --git a/variables/constructs_loadbalancing.DROP_INVALID_HEADER_FIELDS_ENABLED.html b/variables/constructs_loadbalancing.DROP_INVALID_HEADER_FIELDS_ENABLED.html index e552df3e74..99ccdfde85 100644 --- a/variables/constructs_loadbalancing.DROP_INVALID_HEADER_FIELDS_ENABLED.html +++ b/variables/constructs_loadbalancing.DROP_INVALID_HEADER_FIELDS_ENABLED.html @@ -1,3 +1,3 @@ DROP_INVALID_HEADER_FIELDS_ENABLED | @guardian/cdk

    Variable DROP_INVALID_HEADER_FIELDS_ENABLEDConst

    DROP_INVALID_HEADER_FIELDS_ENABLED = "routing.http.drop_invalid_header_fields.enabled"

    Indicates whether HTTP headers with invalid header fields are removed by the load balancer. Invalid headers are described as HTTP header names that do not conform to the regular expression [-A-Za-z0-9]+

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/variables/constructs_loadbalancing.TLS_VERSION_AND_CIPHER_SUITE_HEADERS_ENABLED.html b/variables/constructs_loadbalancing.TLS_VERSION_AND_CIPHER_SUITE_HEADERS_ENABLED.html index 86d882db61..269b4477e2 100644 --- a/variables/constructs_loadbalancing.TLS_VERSION_AND_CIPHER_SUITE_HEADERS_ENABLED.html +++ b/variables/constructs_loadbalancing.TLS_VERSION_AND_CIPHER_SUITE_HEADERS_ENABLED.html @@ -4,4 +4,4 @@
  • x-amzn-tls-cipher-suite, which has information about the cipher suite negotiated with the client

    • Both headers are in OpenSSL format.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/variables/types.AppAccess-1.html b/variables/types.AppAccess-1.html index 753270becb..37ad887c5e 100644 --- a/variables/types.AppAccess-1.html +++ b/variables/types.AppAccess-1.html @@ -3,4 +3,4 @@ Restricted - Must not include global CIDR ranges as doing so makes other listed CIDR ranges redundant Internal - All CIDR ranges must start 10.

    Throws

    Error when CIDR rules are invalid

    -
      • (access): void

      • Parameters

        Returns void

    Settings

    Member Visibility
    +
      • (access): void

      • Parameters

        Returns void

    Settings

    Member Visibility
    diff --git a/variables/types.GuDistributable-1.html b/variables/types.GuDistributable-1.html index 1bc81ff788..6a8e574f5b 100644 --- a/variables/types.GuDistributable-1.html +++ b/variables/types.GuDistributable-1.html @@ -1 +1 @@ -GuDistributable | @guardian/cdk

    Variable GuDistributable

    GuDistributable: {
        getObjectKey(__namedParameters: GuStack, __namedParameters: AppIdentity, __namedParameters: GuDistributable): string;
    }

    Settings

    Member Visibility
    +GuDistributable | @guardian/cdk

    Variable GuDistributable

    GuDistributable: {
        getObjectKey(__namedParameters: GuStack, __namedParameters: AppIdentity, __namedParameters: GuDistributable): string;
    }

    Settings

    Member Visibility