From f5e6886f6a776d70e9166987cc3d458a3ff0ff8a Mon Sep 17 00:00:00 2001 From: github-actions-bot Date: Thu, 30 Nov 2023 11:17:38 +0000 Subject: [PATCH] Updates --- classes/constructs_acm.GuCertificate.html | 6 +-- ...tructs_autoscaling.GuAutoScalingGroup.html | 6 +-- .../constructs_autoscaling.GuUserData.html | 4 +- classes/constructs_cloudwatch.GuAlarm.html | 4 +- ...ts_cloudwatch.GuAlb4xxPercentageAlarm.html | 4 +- ...ts_cloudwatch.GuAlb5xxPercentageAlarm.html | 4 +- ...oudwatch.GuLambdaErrorPercentageAlarm.html | 4 +- ...ts_cloudwatch.GuLambdaThrottlingAlarm.html | 4 +- ..._cloudwatch.GuUnhealthyInstancesAlarm.html | 4 +- classes/constructs_core.GuAmiParameter.html | 4 +- ...ucts_core.GuAnghammaradTopicParameter.html | 8 ++-- classes/constructs_core.GuArnParameter.html | 4 +- ...tructs_core.GuCertificateArnParameter.html | 4 +- ...ts_core.GuDistributionBucketParameter.html | 8 ++-- ...ucts_core.GuFastlyCustomerIdParameter.html | 8 ++-- ...cts_core.GuLoggingStreamNameParameter.html | 8 ++-- classes/constructs_core.GuParameter.html | 4 +- ...s_core.GuPrivateConfigBucketParameter.html | 6 +-- classes/constructs_core.GuStack.html | 20 +++++----- ...ructs_core.GuStackForStackSetInstance.html | 18 ++++----- .../constructs_core.GuStringParameter.html | 4 +- ...constructs_core.GuSubnetListParameter.html | 4 +- classes/constructs_core.GuVpcParameter.html | 8 ++-- classes/constructs_dns.GuCname.html | 4 +- classes/constructs_dns.GuDnsRecordSet.html | 4 +- .../constructs_ec2.GuBaseSecurityGroup.html | 4 +- ...tructs_ec2.GuHttpsEgressSecurityGroup.html | 8 ++-- classes/constructs_ec2.GuSecurityGroup.html | 6 +-- classes/constructs_ec2.GuVpc.html | 4 +- classes/constructs_ec2.GuWazuhAccess.html | 8 ++-- classes/constructs_ecs.GuEcsTask.html | 6 +-- classes/constructs_iam.GuAllowPolicy.html | 4 +- ...structs_iam.GuAnghammaradSenderPolicy.html | 8 ++-- .../constructs_iam.GuAssumeRolePolicy.html | 4 +- classes/constructs_iam.GuDenyPolicy.html | 4 +- .../constructs_iam.GuDescribeEC2Policy.html | 8 ++-- .../constructs_iam.GuDynamoDBReadPolicy.html | 4 +- .../constructs_iam.GuDynamoDBWritePolicy.html | 4 +- .../constructs_iam.GuFastlyLogsIamRole.html | 4 +- ...ucts_iam.GuGetCloudwatchMetricsPolicy.html | 4 +- ...nstructs_iam.GuGetDistributablePolicy.html | 6 +-- ...iam.GuGetDistributablePolicyStatement.html | 4 +- ...nstructs_iam.GuGetPrivateConfigPolicy.html | 4 +- .../constructs_iam.GuGetS3ObjectsPolicy.html | 4 +- .../constructs_iam.GuGithubActionsRole.html | 4 +- classes/constructs_iam.GuInstanceRole.html | 6 +-- .../constructs_iam.GuLogShippingPolicy.html | 8 ++-- ...tructs_iam.GuParameterStoreReadPolicy.html | 6 +-- classes/constructs_iam.GuPolicy.html | 4 +- ...ucts_iam.GuPutCloudwatchMetricsPolicy.html | 4 +- .../constructs_iam.GuPutS3ObjectsPolicy.html | 4 +- classes/constructs_iam.GuRole.html | 4 +- classes/constructs_iam.GuSESSenderPolicy.html | 4 +- .../constructs_iam.ReadParametersByName.html | 4 +- .../constructs_iam.ReadParametersByPath.html | 4 +- .../constructs_kinesis.GuKinesisStream.html | 4 +- .../constructs_lambda.GuLambdaFunction.html | 12 +++--- ...s_loadbalancing.GuApplicationListener.html | 6 +-- ...adbalancing.GuApplicationLoadBalancer.html | 6 +-- ...oadbalancing.GuApplicationTargetGroup.html | 8 ++-- ...dbalancing.GuHttpsApplicationListener.html | 6 +-- .../constructs_rds.GuDatabaseInstance.html | 6 +-- classes/constructs_s3.GuS3Bucket.html | 6 +-- classes/constructs_ses.GuEmailIdentity.html | 8 ++-- classes/constructs_stack_set.GuStackSet.html | 4 +- classes/constructs_vpc.GuVpc.html | 6 +-- ..._patterns.GuKinesisLambdaExperimental.html | 14 +++---- ...ntal_patterns.GuSnsLambdaExperimental.html | 14 +++---- ...patterns.GuApiGatewayWithLambdaByPath.html | 4 +- classes/patterns.GuApiLambda.html | 12 +++--- classes/patterns.GuEc2App.html | 6 +-- classes/patterns.GuNodeApp.html | 6 +-- classes/patterns.GuPlayApp.html | 6 +-- classes/patterns.GuPlayWorkerApp.html | 6 +-- classes/patterns.GuScheduledEcsTask.html | 8 ++-- classes/patterns.GuScheduledLambda.html | 12 +++--- classes/utils_lambda.StreamRetry.html | 4 +- classes/utils_test.GuTemplate.html | 4 +- enums/constants.AccessScope.html | 8 ++-- enums/constructs_dns.RecordType.html | 4 +- enums/constructs_ec2.SubnetType.html | 4 +- functions/constants.getDependency.html | 2 +- functions/constants.getDevDependency.html | 2 +- functions/constructs_ec2.maybeApp.html | 2 +- .../utils_lambda.toAwsErrorHandlingProps.html | 2 +- ...ps.transformToSecurityGroupAccessRule.html | 2 +- .../utils_test.attachPolicyToTestRole.html | 2 +- .../utils_test.simpleGuStackForTesting.html | 2 +- interfaces/constants.SsmParameterPath.html | 4 +- ...s_autoscaling.GuAutoScalingGroupProps.html | 24 +++++------ ...onstructs_autoscaling.GuUserDataProps.html | 4 +- .../constructs_cloudwatch.GuAlarmProps.html | 6 +-- ...uLambdaErrorPercentageMonitoringProps.html | 4 +- ...tch.GuLambdaThrottlingMonitoringProps.html | 8 ++-- ...nstructs_cloudwatch.Http4xxAlarmProps.html | 4 +- ...nstructs_cloudwatch.Http5xxAlarmProps.html | 4 +- .../constructs_cloudwatch.NoMonitoring.html | 4 +- interfaces/constructs_core.AppIdentity.html | 4 +- .../constructs_core.GuParameterProps.html | 4 +- interfaces/constructs_core.GuStackProps.html | 14 +++---- .../constructs_core.GuStaticLogicalId.html | 6 +-- interfaces/constructs_core.Identity.html | 4 +- .../constructs_core.StackStageIdentity.html | 4 +- interfaces/constructs_dns.GuCnameProps.html | 12 +++--- .../constructs_dns.GuDnsRecordSetProps.html | 4 +- ...nstructs_ec2.GuBaseSecurityGroupProps.html | 4 +- .../constructs_ec2.GuSecurityGroupProps.html | 6 +-- interfaces/constructs_ec2.GuSubnetProps.html | 4 +- ...onstructs_ec2.SecurityGroupAccessRule.html | 8 ++-- interfaces/constructs_ecs.GuEcsTaskProps.html | 6 +-- .../constructs_iam.GuAllowPolicyProps.html | 6 +-- ...onstructs_iam.GuAssumeRolePolicyProps.html | 4 +- ...nstructs_iam.GuFastlyLogsIamRoleProps.html | 6 +-- ...nstructs_iam.GuGetS3ObjectPolicyProps.html | 6 +-- ...am.GuGithubActionsRepositoryCondition.html | 6 +-- ...nstructs_iam.GuGithubActionsRoleProps.html | 6 +-- .../constructs_iam.GuInstanceRoleProps.html | 6 +-- ...nstructs_iam.GuPutS3ObjectPolicyProps.html | 6 +-- .../constructs_lambda.GuFunctionProps.html | 18 ++++----- ...dbalancing.GuApplicationListenerProps.html | 4 +- ...lancing.GuApplicationTargetGroupProps.html | 4 +- ...ncing.GuHttpsApplicationListenerProps.html | 6 +-- ...onstructs_rds.GuDatabaseInstanceProps.html | 6 +-- interfaces/constructs_s3.GuS3BucketProps.html | 4 +- .../constructs_ses.GuEmailIdentityProps.html | 6 +-- ...mental_patterns.ExistingKinesisStream.html | 4 +- ...xperimental_patterns.ExistingSnsTopic.html | 4 +- ...imental_patterns.GuKinesisLambdaProps.html | 26 ++++++------ ...xperimental_patterns.GuSnsLambdaProps.html | 20 +++++----- interfaces/patterns.AccessLoggingProps.html | 6 +-- interfaces/patterns.Alarms.html | 12 +++--- interfaces/patterns.ApiGatewayAlarms.html | 8 ++-- interfaces/patterns.ApiTarget.html | 10 ++--- .../patterns.ApplicationLoggingProps.html | 6 +-- ...rns.GuApiGatewayWithLambdaByPathProps.html | 8 ++-- interfaces/patterns.GuApiLambdaProps.html | 18 ++++----- interfaces/patterns.GuEc2AppProps.html | 40 +++++++++---------- .../patterns.GuScheduledEcsTaskProps.html | 8 ++-- .../patterns.GuScheduledLambdaProps.html | 20 +++++----- interfaces/types.Access.html | 4 +- interfaces/types.GuAsgCapacity.html | 6 +-- interfaces/types.GuDistributable.html | 4 +- interfaces/types.GuDistributableForEc2.html | 6 +-- interfaces/types.GuDomainName.html | 6 +-- interfaces/types.InternalAccess.html | 4 +- interfaces/types.PublicAccess.html | 4 +- interfaces/types.RestrictedAccess.html | 4 +- ...ils_ec2.GuPrivateS3ConfigurationProps.html | 4 +- ...utils_lambda.StreamErrorHandlingProps.html | 4 +- modules/constants.html | 2 +- modules/constructs_acm.html | 2 +- modules/constructs_autoscaling.html | 2 +- modules/constructs_cloudwatch.html | 2 +- modules/constructs_core.html | 2 +- modules/constructs_dns.html | 2 +- modules/constructs_ec2.html | 2 +- modules/constructs_ecs.html | 2 +- modules/constructs_iam.html | 2 +- modules/constructs_kinesis.html | 2 +- modules/constructs_lambda.html | 2 +- modules/constructs_loadbalancing.html | 2 +- modules/constructs_rds.html | 2 +- modules/constructs_s3.html | 2 +- modules/constructs_ses.html | 2 +- modules/constructs_stack_set.html | 2 +- modules/constructs_vpc.html | 2 +- modules/experimental_patterns.html | 2 +- modules/patterns.html | 2 +- modules/types.html | 2 +- modules/utils_ec2.html | 2 +- modules/utils_lambda.html | 2 +- modules/utils_security_groups.html | 2 +- modules/utils_test.html | 2 +- ...structs_acm.GuCertificatePropsWithApp.html | 2 +- ...ts_autoscaling.GuUserDataPropsWithApp.html | 2 +- ...onstructs_core.GuNoTypeParameterProps.html | 2 +- ...GuNoTypeParameterPropsWithAppIdentity.html | 2 +- ...constructs_ecs.ContainerConfiguration.html | 2 +- ...nstructs_ecs.GuEcsTaskMonitoringProps.html | 2 +- types/constructs_ecs.RegistryContainer.html | 2 +- types/constructs_ecs.RepositoryContainer.html | 2 +- types/constructs_iam.GuDenyPolicyProps.html | 2 +- ...tructs_iam.GuInstanceRolePropsWithApp.html | 2 +- ...structs_iam.GuNoStatementsPolicyProps.html | 2 +- types/constructs_iam.GuPolicyProps.html | 2 +- types/constructs_iam.GuRoleProps.html | 2 +- ...nstructs_kinesis.GuKinesisStreamProps.html | 2 +- types/constructs_vpc.GuVpcProps.html | 2 +- types/patterns.HttpMethod.html | 2 +- types/types.AppAccess.html | 2 +- types/utils_lambda.StreamProcessingProps.html | 2 +- .../constants.ALL_SSM_PARAMETER_PATHS.html | 2 +- variables/constants.ContextKeys.html | 2 +- .../constants.FASTLY_AWS_ACCOUNT_ID.html | 2 +- variables/constants.LibraryInfo.html | 2 +- variables/constants.MetadataKeys.html | 2 +- .../constants.NAMED_SSM_PARAMETER_PATHS.html | 2 +- variables/constants.RegexPattern.html | 2 +- variables/constants.TrackingTag.html | 2 +- .../constants.VPC_SSM_PARAMETER_PREFIX.html | 2 +- variables/constructs_core.AppIdentity-1.html | 2 +- variables/types.AppAccess-1.html | 2 +- variables/types.GuDistributable-1.html | 2 +- 203 files changed, 542 insertions(+), 542 deletions(-) diff --git a/classes/constructs_acm.GuCertificate.html b/classes/constructs_acm.GuCertificate.html index cf9b1a7ec9..9f5da60961 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,10 +22,10 @@ isConstruct isOwnedResource isResource -

Constructors

constructor

Properties

Readonly certificateArn

certificateArn: string

The certificate's ARN

+

Constructors

constructor

Properties

Readonly certificateArn

certificateArn: string

The certificate's ARN

Readonly env

env: ResourceEnvironment

Readonly idWithApp

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.

-

Readonly node

node: Node

The tree node.

+

Readonly node

node: Node

The tree node.

Protected Readonly physicalName

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 48044ce165..1654e9c372 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 @@ -62,12 +62,12 @@ isConstruct isOwnedResource isResource -

Constructors

constructor

Properties

Protected Optional albTargetGroup

albTargetGroup?: ApplicationTargetGroup

Readonly amiParameter

amiParameter: GuAmiParameter

Readonly app

app: string

Readonly autoScalingGroupArn

autoScalingGroupArn: string

Arn of the AutoScalingGroup

+

Constructors

constructor

Properties

Protected Optional albTargetGroup

albTargetGroup?: ApplicationTargetGroup

Readonly amiParameter

amiParameter: GuAmiParameter

Readonly app

app: string

Readonly autoScalingGroupArn

autoScalingGroupArn: string

Arn of the AutoScalingGroup

Readonly autoScalingGroupName

autoScalingGroupName: string

Name of the AutoScalingGroup

Readonly env

env: ResourceEnvironment

Readonly grantPrincipal

grantPrincipal: IPrincipal

The principal to grant permissions to

Protected hasCalledScaleOnRequestCount

hasCalledScaleOnRequestCount: boolean

Readonly idWithApp

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 Readonly imageRecipe

imageRecipe?: string | AmigoProps

Optional Readonly maxInstanceLifetime

maxInstanceLifetime?: Duration

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

+

Optional Readonly imageRecipe

imageRecipe?: string | AmigoProps

Optional Readonly maxInstanceLifetime

maxInstanceLifetime?: Duration

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

Protected Optional newInstancesProtectedFromScaleIn

newInstancesProtectedFromScaleIn?: boolean

Readonly node

node: Node

The tree node.

Readonly osType

osType: OperatingSystemType

The type of OS instances of this fleet are running.

Protected Readonly physicalName

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 6852bb2006..c748035286 100644 --- a/classes/constructs_autoscaling.GuUserData.html +++ b/classes/constructs_autoscaling.GuUserData.html @@ -5,11 +5,11 @@

  • download distributable
  • execute distributable
    • -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    _userData

    Accessors

    userData

    Methods

    addCommands addS3DownloadCommand downloadConfiguration downloadDistributable -

    Constructors

    constructor

    Properties

    Private Readonly _userData

    _userData: UserData

    Accessors

    userData

    Methods

    addCommands

    addS3DownloadCommand

    Private downloadConfiguration

    Private downloadDistributable

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Private Readonly _userData

    _userData: UserData

    Accessors

    userData

    Methods

    addCommands

    addS3DownloadCommand

    Private downloadConfiguration

    Private downloadDistributable

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/constructs_cloudwatch.GuAlarm.html b/classes/constructs_cloudwatch.GuAlarm.html index a3c448b652..61c337b8ef 100644 --- a/classes/constructs_cloudwatch.GuAlarm.html +++ b/classes/constructs_cloudwatch.GuAlarm.html @@ -5,7 +5,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

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    Protected Optional alarmActionArns

    alarmActionArns?: string[]

    Readonly alarmArn

    alarmArn: string

    ARN of this alarm

    +

    Constructors

    constructor

    Properties

    Protected Optional alarmActionArns

    alarmActionArns?: string[]

    Readonly alarmArn

    alarmArn: string

    ARN of this alarm

    Attribute

    Readonly alarmName

    alarmName: string

    Name of this alarm.

    Attribute

    Readonly env

    env: ResourceEnvironment

    Protected Optional insufficientDataActionArns

    insufficientDataActionArns?: string[]

    Readonly metric

    metric: IMetric

    The metric object this alarm was based on

    Readonly node

    node: Node

    The tree node.

    diff --git a/classes/constructs_cloudwatch.GuAlb4xxPercentageAlarm.html b/classes/constructs_cloudwatch.GuAlb4xxPercentageAlarm.html index c784e4af1c..f82fd6deb4 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

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    Protected Optional alarmActionArns

    alarmActionArns?: string[]

    Readonly alarmArn

    alarmArn: string

    ARN of this alarm

    +

    Constructors

    constructor

    Properties

    Protected Optional alarmActionArns

    alarmActionArns?: string[]

    Readonly alarmArn

    alarmArn: string

    ARN of this alarm

    Attribute

    Readonly alarmName

    alarmName: string

    Name of this alarm.

    Attribute

    Readonly env

    env: ResourceEnvironment

    Protected Optional insufficientDataActionArns

    insufficientDataActionArns?: string[]

    Readonly metric

    metric: IMetric

    The metric object this alarm was based on

    Readonly node

    node: Node

    The tree node.

    diff --git a/classes/constructs_cloudwatch.GuAlb5xxPercentageAlarm.html b/classes/constructs_cloudwatch.GuAlb5xxPercentageAlarm.html index d3fce026ad..e5f7b3e4ed 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

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    Protected Optional alarmActionArns

    alarmActionArns?: string[]

    Readonly alarmArn

    alarmArn: string

    ARN of this alarm

    +

    Constructors

    constructor

    Properties

    Protected Optional alarmActionArns

    alarmActionArns?: string[]

    Readonly alarmArn

    alarmArn: string

    ARN of this alarm

    Attribute

    Readonly alarmName

    alarmName: string

    Name of this alarm.

    Attribute

    Readonly env

    env: ResourceEnvironment

    Protected Optional insufficientDataActionArns

    insufficientDataActionArns?: string[]

    Readonly metric

    metric: IMetric

    The metric object this alarm was based on

    Readonly node

    node: Node

    The tree node.

    diff --git a/classes/constructs_cloudwatch.GuLambdaErrorPercentageAlarm.html b/classes/constructs_cloudwatch.GuLambdaErrorPercentageAlarm.html index e48c1ace57..ff65a5a9de 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

    • GuAlarm
      • GuLambdaErrorPercentageAlarm

    Constructors

    constructor +

    Hierarchy

    • GuAlarm
      • GuLambdaErrorPercentageAlarm

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    Protected Optional alarmActionArns

    alarmActionArns?: string[]

    Readonly alarmArn

    alarmArn: string

    ARN of this alarm

    +

    Constructors

    constructor

    Properties

    Protected Optional alarmActionArns

    alarmActionArns?: string[]

    Readonly alarmArn

    alarmArn: string

    ARN of this alarm

    Attribute

    Readonly alarmName

    alarmName: string

    Name of this alarm.

    Attribute

    Readonly env

    env: ResourceEnvironment

    Protected Optional insufficientDataActionArns

    insufficientDataActionArns?: string[]

    Readonly metric

    metric: IMetric

    The metric object this alarm was based on

    Readonly node

    node: Node

    The tree node.

    diff --git a/classes/constructs_cloudwatch.GuLambdaThrottlingAlarm.html b/classes/constructs_cloudwatch.GuLambdaThrottlingAlarm.html index 850a0a2e4d..9bf6e60052 100644 --- a/classes/constructs_cloudwatch.GuLambdaThrottlingAlarm.html +++ b/classes/constructs_cloudwatch.GuLambdaThrottlingAlarm.html @@ -5,7 +5,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

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    Protected Optional alarmActionArns

    alarmActionArns?: string[]

    Readonly alarmArn

    alarmArn: string

    ARN of this alarm

    +

    Constructors

    constructor

    Properties

    Protected Optional alarmActionArns

    alarmActionArns?: string[]

    Readonly alarmArn

    alarmArn: string

    ARN of this alarm

    Attribute

    Readonly alarmName

    alarmName: string

    Name of this alarm.

    Attribute

    Readonly env

    env: ResourceEnvironment

    Protected Optional insufficientDataActionArns

    insufficientDataActionArns?: string[]

    Readonly metric

    metric: IMetric

    The metric object this alarm was based on

    Readonly node

    node: Node

    The tree node.

    diff --git a/classes/constructs_cloudwatch.GuUnhealthyInstancesAlarm.html b/classes/constructs_cloudwatch.GuUnhealthyInstancesAlarm.html index e06f2c9a23..e66083decd 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

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    Protected Optional alarmActionArns

    alarmActionArns?: string[]

    Readonly alarmArn

    alarmArn: string

    ARN of this alarm

    +

    Constructors

    constructor

    Properties

    Protected Optional alarmActionArns

    alarmActionArns?: string[]

    Readonly alarmArn

    alarmArn: string

    ARN of this alarm

    Attribute

    Readonly alarmName

    alarmName: string

    Name of this alarm.

    Attribute

    Readonly env

    env: ResourceEnvironment

    Protected Optional insufficientDataActionArns

    insufficientDataActionArns?: string[]

    Readonly metric

    metric: IMetric

    The metric object this alarm was based on

    Readonly node

    node: Node

    The tree node.

    diff --git a/classes/constructs_core.GuAmiParameter.html b/classes/constructs_core.GuAmiParameter.html index bf1cc476f7..b4a36dd38f 100644 --- a/classes/constructs_core.GuAmiParameter.html +++ b/classes/constructs_core.GuAmiParameter.html @@ -1,4 +1,4 @@ -GuAmiParameter | @guardian/cdk

    Class GuAmiParameter

    Hierarchy

    Constructors

    constructor +GuAmiParameter | @guardian/cdk

    Class GuAmiParameter

    Hierarchy

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    Readonly id

    id: string

    Readonly logicalId

    logicalId: string

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

    Constructors

    constructor

    Properties

    Readonly id

    id: string

    Readonly logicalId

    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.GuAnghammaradTopicParameter.html b/classes/constructs_core.GuAnghammaradTopicParameter.html index 8e878d8371..fc805b82a0 100644 --- a/classes/constructs_core.GuAnghammaradTopicParameter.html +++ b/classes/constructs_core.GuAnghammaradTopicParameter.html @@ -1,7 +1,7 @@ GuAnghammaradTopicParameter | @guardian/cdk

    Class GuAnghammaradTopicParameter

    Creates a CloudFormation parameter to a SSM Parameter Store item that holds the ARN of the Anghammarad SNS topic. This parameter is implemented as a singleton, meaning only one can ever be added to a stack and will be reused if necessary.

    See

    https://github.com/guardian/anghammarad

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    id logicalId node @@ -31,14 +31,14 @@ getInstance isCfnElement isConstruct -

    Constructors

    Private constructor

    Properties

    Readonly id

    id: string

    Readonly logicalId

    logicalId: string

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

    Constructors

    Private constructor

    Properties

    Readonly id

    id: string

    Readonly logicalId

    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.

    Readonly node

    node: Node

    The tree node.

    Readonly stack

    stack: Stack

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

    -

    Static Private instance

    instance: undefined | GuAnghammaradTopicParameter

    Accessors

    allowedPattern

    • get allowedPattern(): undefined | string

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

      +

    Static Private instance

    instance: undefined | GuAnghammaradTopicParameter

    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.
    • set allowedPattern(pattern): void

    • Parameters

      • pattern: undefined | string

      Returns void

    allowedValues

    • get allowedValues(): undefined | string[]

    • An array containing the list of values allowed for the parameter.

      @@ -100,7 +100,7 @@

      Returns string

    Static getInstance

    Static isCfnElement

    • isCfnElement(x): x is CfnElement

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

    Returns GuAnghammaradTopicParameter

    Static isCfnElement

    -

    Readonly stack

    stack: Stack

    Static Private instance

    instance: undefined | GuAnghammaradSenderPolicy

    Accessors

    Private isAttached

    • get isAttached(): any

    • Whether the policy resource has been attached to any identity

      +

    Readonly stack

    stack: Stack

    Static Private instance

    instance: undefined | GuAnghammaradSenderPolicy

    Accessors

    Private isAttached

    • get isAttached(): any

    • Whether the policy resource has been attached to any identity

      Returns any

    policyName

    • get policyName(): string

    • The name of this policy.

      Returns string

      Attribute

    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 @@ -78,7 +78,7 @@ Commonly this is the resource's ref.

    Returns string

    toString

    • toString(): string

    • Returns a string representation of this construct.

      Returns string

    Static fromPolicyName

    • fromPolicyName(scope, id, policyName): IPolicy

    • Import a policy in this app based on its name

      -

      Parameters

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

      Returns IPolicy

    Static getInstance

    Static isConstruct

    • isConstruct(x): x is Construct

    • Checks if x is a construct.

      +

      Parameters

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

      Returns IPolicy

    Static getInstance

    Static isConstruct

    -

    Readonly stack

    stack: Stack

    Static Private instance

    instance: undefined | GuPolicy

    Accessors

    Private isAttached

    • get isAttached(): any

    • Whether the policy resource has been attached to any identity

      +

    Readonly stack

    stack: Stack

    Static Private instance

    instance: undefined | GuPolicy

    Accessors

    Private isAttached

    • get isAttached(): any

    • Whether the policy resource has been attached to any identity

      Returns any

    policyName

    • get policyName(): string

    • The name of this policy.

      Returns string

      Attribute

    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 @@ -72,7 +72,7 @@ Commonly this is the resource's ref.

    Returns string

    toString

    • toString(): string

    • Returns a string representation of this construct.

      Returns string

    Static fromPolicyName

    • fromPolicyName(scope, id, policyName): IPolicy

    • Import a policy in this app based on its name

      -

      Parameters

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

      Returns IPolicy

    Static getInstance

    Static isConstruct

    • isConstruct(x): x is Construct

    • Checks if x is a construct.

      +

      Parameters

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

      Returns IPolicy

    Static getInstance

    Static isConstruct

    -

    Readonly stack

    stack: Stack

    Static Private instance

    instance: undefined | GuLogShippingPolicy

    Accessors

    Private isAttached

    • get isAttached(): any

    • Whether the policy resource has been attached to any identity

      +

    Readonly stack

    stack: Stack

    Static Private instance

    instance: undefined | GuLogShippingPolicy

    Accessors

    Private isAttached

    • get isAttached(): any

    • Whether the policy resource has been attached to any identity

      Returns any

    policyName

    • get policyName(): string

    • The name of this policy.

      Returns string

      Attribute

    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 @@ -72,7 +72,7 @@ Commonly this is the resource's ref.

    Returns string

    toString

    • toString(): string

    • Returns a string representation of this construct.

      Returns string

    Static fromPolicyName

    • fromPolicyName(scope, id, policyName): IPolicy

    • Import a policy in this app based on its name

      -

      Parameters

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

      Returns IPolicy

    Static getInstance

    Static isConstruct

    • isConstruct(x): x is Construct

    • Checks if x is a construct.

      +

      Parameters

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

      Returns IPolicy

    Static getInstance

    Static isConstruct

    • 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 aed40a73be..44256453e5 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 @@ -24,10 +24,10 @@ isConstruct isOwnedResource isResource -

      Constructors

      constructor

      Properties

      Readonly document

      document: PolicyDocument

      The policy document.

      +

      Constructors

      constructor

      Properties

      Readonly document

      document: PolicyDocument

      The policy document.

      Readonly env

      env: ResourceEnvironment

      Readonly grantPrincipal

      grantPrincipal: IPrincipal

      Readonly idWithApp

      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.

      -

      Readonly node

      node: Node

      The tree node.

      +

      Readonly node

      node: Node

      The tree node.

      Protected Readonly physicalName

      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 e91f8728ce..2acbdd3dbb 100644 --- a/classes/constructs_iam.GuPolicy.html +++ b/classes/constructs_iam.GuPolicy.html @@ -1,4 +1,4 @@ -GuPolicy | @guardian/cdk

      Class GuPolicy

      Hierarchy

      Constructors

      constructor +GuPolicy | @guardian/cdk

      Class GuPolicy

      Hierarchy

      Constructors

      constructor

      Properties

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

      Constructors

      constructor

      Properties

      Readonly document

      document: PolicyDocument

      The policy document.

      +

      Constructors

      constructor

      Properties

      Readonly document

      document: PolicyDocument

      The policy document.

      Readonly env

      env: ResourceEnvironment

      Readonly grantPrincipal

      grantPrincipal: IPrincipal

      Readonly node

      node: Node

      The tree node.

      Protected Readonly physicalName

      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_iam.GuPutCloudwatchMetricsPolicy.html b/classes/constructs_iam.GuPutCloudwatchMetricsPolicy.html index d34a5f4657..01f6f9c4c0 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 @@ -21,7 +21,7 @@ isConstruct isOwnedResource isResource -

      Constructors

      constructor

      Properties

      Readonly document

      document: PolicyDocument

      The policy document.

      +

      Constructors

      constructor

      Properties

      Readonly document

      document: PolicyDocument

      The policy document.

      Readonly env

      env: ResourceEnvironment

      Readonly grantPrincipal

      grantPrincipal: IPrincipal

      Readonly node

      node: Node

      The tree node.

      Protected Readonly physicalName

      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_iam.GuPutS3ObjectsPolicy.html b/classes/constructs_iam.GuPutS3ObjectsPolicy.html index c7989ba73d..e0cec52c72 100644 --- a/classes/constructs_iam.GuPutS3ObjectsPolicy.html +++ b/classes/constructs_iam.GuPutS3ObjectsPolicy.html @@ -1,4 +1,4 @@ -GuPutS3ObjectsPolicy | @guardian/cdk

      Class GuPutS3ObjectsPolicy

      Hierarchy

      Constructors

      constructor +GuPutS3ObjectsPolicy | @guardian/cdk

      Class GuPutS3ObjectsPolicy

      Hierarchy

      Constructors

      constructor

      Properties

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

      Constructors

      constructor

      Properties

      Readonly document

      document: PolicyDocument

      The policy document.

      +

      Constructors

      constructor

      Properties

      Readonly document

      document: PolicyDocument

      The policy document.

      Readonly env

      env: ResourceEnvironment

      Readonly grantPrincipal

      grantPrincipal: IPrincipal

      Readonly node

      node: Node

      The tree node.

      Protected Readonly physicalName

      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_iam.GuRole.html b/classes/constructs_iam.GuRole.html index bbe733b0a7..cb73a9d7b2 100644 --- a/classes/constructs_iam.GuRole.html +++ b/classes/constructs_iam.GuRole.html @@ -1,4 +1,4 @@ -GuRole | @guardian/cdk

      Class GuRole

      Hierarchy

      Constructors

      constructor +GuRole | @guardian/cdk

      Class GuRole

      Hierarchy

      Constructors

      constructor

      Properties

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

      Constructors

      constructor

      Properties

      Readonly assumeRoleAction

      assumeRoleAction: string

      Optional Readonly assumeRolePolicy

      assumeRolePolicy?: PolicyDocument

      The assume role policy document associated with this role.

      +

      Constructors

      constructor

      Properties

      Readonly assumeRoleAction

      assumeRoleAction: string

      Optional Readonly assumeRolePolicy

      assumeRolePolicy?: PolicyDocument

      The assume role policy document associated with this role.

      Readonly env

      env: ResourceEnvironment

      Readonly grantPrincipal

      grantPrincipal: IPrincipal

      Readonly node

      node: Node

      The tree node.

      Optional Readonly permissionsBoundary

      permissionsBoundary?: IManagedPolicy

      Returns the permissions boundary attached to this role

      Protected Readonly physicalName

      physicalName: string

      Returns a string-encoded token that resolves to the physical name that diff --git a/classes/constructs_iam.GuSESSenderPolicy.html b/classes/constructs_iam.GuSESSenderPolicy.html index dfcf3d755a..29040e13ee 100644 --- a/classes/constructs_iam.GuSESSenderPolicy.html +++ b/classes/constructs_iam.GuSESSenderPolicy.html @@ -1,4 +1,4 @@ -GuSESSenderPolicy | @guardian/cdk

      Class GuSESSenderPolicy

      Hierarchy

      Constructors

      constructor +GuSESSenderPolicy | @guardian/cdk

      Class GuSESSenderPolicy

      Hierarchy

      Constructors

      constructor

      Properties

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

      Constructors

      constructor

      Properties

      Readonly document

      document: PolicyDocument

      The policy document.

      +

      Constructors

      constructor

      Properties

      Readonly document

      document: PolicyDocument

      The policy document.

      Readonly env

      env: ResourceEnvironment

      Readonly grantPrincipal

      grantPrincipal: IPrincipal

      Readonly node

      node: Node

      The tree node.

      Protected Readonly physicalName

      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_iam.ReadParametersByName.html b/classes/constructs_iam.ReadParametersByName.html index d26a51b14b..8fedb8406b 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

      • get effect(): Effect

      • Whether to allow or deny the actions in this statement

        Returns Effect

      • set effect(effect): void

      • Set effect for this statement

        diff --git a/classes/constructs_iam.ReadParametersByPath.html b/classes/constructs_iam.ReadParametersByPath.html index 2aa201a6e5..10d851039e 100644 --- a/classes/constructs_iam.ReadParametersByPath.html +++ b/classes/constructs_iam.ReadParametersByPath.html @@ -1,6 +1,6 @@ ReadParametersByPath | @guardian/cdk

        Class ReadParametersByPath

        This is helpful for reading all private configuration for a given app. For example, the simple-configuration library requires these permissions.

        -

        Hierarchy

        • PolicyStatement
          • ReadParametersByPath

        Constructors

        constructor +

        Hierarchy

        • PolicyStatement
          • ReadParametersByPath

        Constructors

        constructor

        Accessors

        actions conditions effect @@ -42,7 +42,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

        • get effect(): Effect

        • Whether to allow or deny the actions in this statement

          Returns Effect

        • set effect(effect): void

        • Set effect for this statement

          diff --git a/classes/constructs_kinesis.GuKinesisStream.html b/classes/constructs_kinesis.GuKinesisStream.html index 52c4107108..fd723f87c6 100644 --- a/classes/constructs_kinesis.GuKinesisStream.html +++ b/classes/constructs_kinesis.GuKinesisStream.html @@ -1,7 +1,7 @@ GuKinesisStream | @guardian/cdk

          Class GuKinesisStream

          Construct which creates a Kinesis stream.

          This resource is stateful.

          See

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

          -

          Hierarchy

          • Stream
            • GuKinesisStream

          Constructors

          constructor +

          Hierarchy

          • Stream
            • GuKinesisStream

          Constructors

          constructor

          Properties

          encryptionKey? env node @@ -44,7 +44,7 @@ isConstruct isOwnedResource isResource -

          Constructors

          constructor

          Properties

          Optional Readonly encryptionKey

          encryptionKey?: IKey

          Readonly env

          env: ResourceEnvironment

          Readonly node

          node: Node

          The tree node.

          +

          Constructors

          constructor

          Properties

          Optional Readonly encryptionKey

          encryptionKey?: IKey

          Readonly env

          env: ResourceEnvironment

          Readonly node

          node: Node

          The tree node.

          Protected Readonly physicalName

          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_lambda.GuLambdaFunction.html b/classes/constructs_lambda.GuLambdaFunction.html index 9ea1a31501..ebb4013cf2 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

          Constructors

          constructor +

          Hierarchy

          Constructors

          constructor

          Properties

          _connections? _functionUrlInvocationGrants _invocationGrants @@ -99,7 +99,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.

          @@ -108,10 +108,10 @@ 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 alias

          alias?: Alias

          Readonly app

          app: string

          Readonly architecture

          architecture: Architecture

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

          -

          Readonly bucketNamePath

          bucketNamePath: undefined | string

          Protected Readonly canCreatePermissions

          canCreatePermissions: true = true

          Optional Readonly deadLetterQueue

          deadLetterQueue?: IQueue

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

          +

          Optional Readonly alias

          alias?: Alias

          Readonly app

          app: string

          Readonly architecture

          architecture: Architecture

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

          +

          Readonly bucketNamePath

          bucketNamePath: undefined | string

          Protected Readonly canCreatePermissions

          canCreatePermissions: true = true

          Optional Readonly deadLetterQueue

          deadLetterQueue?: IQueue

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

          Optional Readonly deadLetterTopic

          deadLetterTopic?: ITopic

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

          -

          Readonly env

          env: ResourceEnvironment

          Readonly fileName

          fileName: string

          Readonly functionArn

          functionArn: string

          ARN of this function

          +

          Readonly env

          env: ResourceEnvironment

          Readonly fileName

          fileName: string

          Readonly functionArn

          functionArn: string

          ARN of this function

          Readonly functionName

          functionName: string

          Name of this function

          Readonly grantPrincipal

          grantPrincipal: IPrincipal

          The principal this Lambda Function is running as

          Readonly node

          node: Node

          The tree node.

          @@ -127,7 +127,7 @@

          Optional Readonly role

          role?: IRole

          Execution role associated with this function

          Readonly runtime

          runtime: Runtime

          The runtime configured for this lambda.

          Readonly stack

          stack: Stack

          Optional Readonly timeout

          timeout?: Duration

          The timeout configured for this lambda.

          -

          Readonly withoutArtifactUpload

          withoutArtifactUpload: boolean

          Readonly withoutFilePrefix

          withoutFilePrefix: boolean

          Static Internal _VER_PROPS

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

          Type declaration

          • [key: string]: boolean

          Accessors

          connections

          • get connections(): Connections

          • Access the Connections object

            +

          Readonly withoutArtifactUpload

          withoutArtifactUpload: boolean

          Readonly withoutFilePrefix

          withoutFilePrefix: boolean

          Static Internal _VER_PROPS

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

          Type declaration

          • [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 6bb39907ba..b6012fb9bd 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 @@ -34,10 +34,10 @@ isConstruct isOwnedResource isResource -

          Constructors

          constructor

          Properties

          Readonly connections

          connections: Connections

          Manage connections to this ApplicationListener

          +

          Constructors

          constructor

          Properties

          Readonly connections

          connections: Connections

          Manage connections to this ApplicationListener

          Readonly env

          env: ResourceEnvironment

          Readonly idWithApp

          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.

          -

          Readonly listenerArn

          listenerArn: string

          Attribute

          Readonly loadBalancer

          loadBalancer: IApplicationLoadBalancer

          Load balancer this listener is associated with

          +

          Readonly listenerArn

          listenerArn: string

          Attribute

          Readonly loadBalancer

          loadBalancer: IApplicationLoadBalancer

          Load balancer this listener is associated with

          Readonly node

          node: Node

          The tree node.

          Protected Readonly physicalName

          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 710fd9dda0..4a43e329a2 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 @@ -64,9 +64,9 @@ isConstruct isOwnedResource isResource -

          Constructors

          constructor

          Properties

          Readonly connections

          connections: Connections

          Readonly env

          env: ResourceEnvironment

          Readonly idWithApp

          idWithApp: string

          The ID of the construct with the App suffix. +

          Constructors

          constructor

          Properties

          Readonly connections

          connections: Connections

          Readonly env

          env: ResourceEnvironment

          Readonly idWithApp

          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 Readonly ipAddressType

          ipAddressType?: IpAddressType

          Readonly listeners

          listeners: ApplicationListener[]

          Readonly loadBalancerArn

          loadBalancerArn: string

          The ARN of this load balancer

          +

          Optional Readonly ipAddressType

          ipAddressType?: IpAddressType

          Readonly listeners

          listeners: ApplicationListener[]

          Readonly loadBalancerArn

          loadBalancerArn: string

          The ARN of this load balancer

          Example value: arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/50dc6c495c0c9188

          Attribute

          Readonly loadBalancerCanonicalHostedZoneId

          loadBalancerCanonicalHostedZoneId: string

          The canonical hosted zone ID of this load balancer

          Example value: Z2P70J7EXAMPLE

          diff --git a/classes/constructs_loadbalancing.GuApplicationTargetGroup.html b/classes/constructs_loadbalancing.GuApplicationTargetGroup.html index b3be4fa2f1..bb38de7d8d 100644 --- a/classes/constructs_loadbalancing.GuApplicationTargetGroup.html +++ b/classes/constructs_loadbalancing.GuApplicationTargetGroup.html @@ -9,7 +9,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 Readonly defaultPort

          defaultPort: number

          Default port configured for members of this target group

          +

          Constructors

          constructor

          Properties

          Protected Readonly defaultPort

          defaultPort: number

          Default port configured for members of this target group

          healthCheck

          healthCheck: HealthCheck

          Health check for the members of this target group

          Readonly idWithApp

          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.

          -

          Readonly loadBalancerArns

          loadBalancerArns: string

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

          +

          Readonly loadBalancerArns

          loadBalancerArns: string

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

          Protected Readonly loadBalancerAttachedDependencies

          loadBalancerAttachedDependencies: DependencyGroup

          Configurable dependable with all resources that lead to load balancer attachment

          Readonly node

          node: Node

          The tree node.

          Readonly targetGroupArn

          targetGroupArn: string

          The ARN of the target group

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

          Readonly targetGroupLoadBalancerArns

          targetGroupLoadBalancerArns: string[]

          ARNs of load balancers load balancing to this TargetGroup

          Readonly targetGroupName

          targetGroupName: string

          The name of the target group

          Protected Optional targetType

          targetType?: TargetType

          The types of the directly registered members of this target group

          -

          Static DefaultHealthCheck

          DefaultHealthCheck: HealthCheck = ...

          Static Private defaultHealthcheckInterval

          defaultHealthcheckInterval: Duration = ...

          Static Private defaultHealthcheckTimeout

          defaultHealthcheckTimeout: Duration = ...

          Accessors

          firstLoadBalancerFullName

          • get firstLoadBalancerFullName(): string

          • Full name of first load balancer

            +

          Static DefaultHealthCheck

          DefaultHealthCheck: HealthCheck = ...

          Static Private defaultHealthcheckInterval

          defaultHealthcheckInterval: Duration = ...

          Static Private defaultHealthcheckTimeout

          defaultHealthcheckTimeout: Duration = ...

          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

          • Returns IApplicationTargetGroupMetrics

          Methods

          Protected addLoadBalancerTarget

          • addLoadBalancerTarget(props): void

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

            Parameters

            • props: LoadBalancerTargetProps

            Returns void

          addTarget

          • addTarget(...targets): void

          • Add a load balancing target to this target group

            diff --git a/classes/constructs_loadbalancing.GuHttpsApplicationListener.html b/classes/constructs_loadbalancing.GuHttpsApplicationListener.html index db3b12d94e..747487ac82 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 @@ -29,10 +29,10 @@ isConstruct isOwnedResource isResource -

            Constructors

            constructor

            Properties

            Readonly connections

            connections: Connections

            Manage connections to this ApplicationListener

            +

            Constructors

            constructor

            Properties

            Readonly connections

            connections: Connections

            Manage connections to this ApplicationListener

            Readonly env

            env: ResourceEnvironment

            Readonly idWithApp

            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.

            -

            Readonly listenerArn

            listenerArn: string

            Attribute

            Readonly loadBalancer

            loadBalancer: IApplicationLoadBalancer

            Load balancer this listener is associated with

            +

            Readonly listenerArn

            listenerArn: string

            Attribute

            Readonly loadBalancer

            loadBalancer: IApplicationLoadBalancer

            Load balancer this listener is associated with

            Readonly node

            node: Node

            The tree node.

            Protected Readonly physicalName

            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 794ac88b8a..3b0aba7c5e 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

            connections dbInstanceEndpointAddress dbInstanceEndpointPort @@ -43,9 +43,9 @@ isConstruct isOwnedResource isResource -

            Constructors

            constructor

            Properties

            Readonly connections

            connections: Connections

            Readonly dbInstanceEndpointAddress

            dbInstanceEndpointAddress: string

            Readonly dbInstanceEndpointPort

            dbInstanceEndpointPort: string

            Protected Optional enableIamAuthentication

            enableIamAuthentication?: boolean

            Optional Readonly engine

            engine?: IInstanceEngine

            Readonly env

            env: ResourceEnvironment

            Readonly idWithApp

            idWithApp: string

            The ID of the construct with the App suffix. +

            Constructors

            constructor

            Properties

            Readonly connections

            connections: Connections

            Readonly dbInstanceEndpointAddress

            dbInstanceEndpointAddress: string

            Readonly dbInstanceEndpointPort

            dbInstanceEndpointPort: string

            Protected Optional enableIamAuthentication

            enableIamAuthentication?: boolean

            Optional Readonly engine

            engine?: IInstanceEngine

            Readonly env

            env: ResourceEnvironment

            Readonly idWithApp

            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.

            -

            Readonly instanceEndpoint

            instanceEndpoint: Endpoint

            Readonly instanceIdentifier

            instanceIdentifier: string

            Optional Readonly instanceResourceId

            instanceResourceId?: string

            Protected Readonly instanceType

            instanceType: InstanceType

            Protected Readonly newCfnProps

            newCfnProps: CfnDBInstanceProps

            Readonly node

            node: Node

            The tree node.

            +

            Readonly instanceEndpoint

            instanceEndpoint: Endpoint

            Readonly instanceIdentifier

            instanceIdentifier: string

            Optional Readonly instanceResourceId

            instanceResourceId?: string

            Protected Readonly instanceType

            instanceType: InstanceType

            Protected Readonly newCfnProps

            newCfnProps: CfnDBInstanceProps

            Readonly node

            node: Node

            The tree node.

            Protected Readonly physicalName

            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 cfa8ea5784..285d483efb 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 @@ -59,9 +59,9 @@ isOwnedResource isResource validateBucketName -

            Constructors

            constructor

            Properties

            Protected autoCreatePolicy

            autoCreatePolicy: boolean

            Readonly bucketArn

            bucketArn: string

            Readonly bucketDomainName

            bucketDomainName: string

            Readonly bucketDualStackDomainName

            bucketDualStackDomainName: string

            Readonly bucketName

            bucketName: string

            Readonly bucketRegionalDomainName

            bucketRegionalDomainName: string

            Readonly bucketWebsiteDomainName

            bucketWebsiteDomainName: string

            Readonly bucketWebsiteUrl

            bucketWebsiteUrl: string

            Protected Optional disallowPublicAccess

            disallowPublicAccess?: boolean

            Optional Readonly encryptionKey

            encryptionKey?: IKey

            Readonly env

            env: ResourceEnvironment

            Readonly idWithApp

            idWithApp: string

            The ID of the construct with the App suffix. +

            Constructors

            constructor

            Properties

            Protected autoCreatePolicy

            autoCreatePolicy: boolean

            Readonly bucketArn

            bucketArn: string

            Readonly bucketDomainName

            bucketDomainName: string

            Readonly bucketDualStackDomainName

            bucketDualStackDomainName: string

            Readonly bucketName

            bucketName: string

            Readonly bucketRegionalDomainName

            bucketRegionalDomainName: string

            Readonly bucketWebsiteDomainName

            bucketWebsiteDomainName: string

            Readonly bucketWebsiteUrl

            bucketWebsiteUrl: string

            Protected Optional disallowPublicAccess

            disallowPublicAccess?: boolean

            Optional Readonly encryptionKey

            encryptionKey?: IKey

            Readonly env

            env: ResourceEnvironment

            Readonly idWithApp

            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 Readonly isWebsite

            isWebsite?: boolean

            Readonly node

            node: Node

            The tree node.

            +

            Optional Readonly isWebsite

            isWebsite?: boolean

            Readonly node

            node: Node

            The tree node.

            Protected Optional notificationsHandlerRole

            notificationsHandlerRole?: IRole

            Protected Optional objectOwnership

            objectOwnership?: ObjectOwnership

            Protected Readonly physicalName

            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_ses.GuEmailIdentity.html b/classes/constructs_ses.GuEmailIdentity.html index 7e22665543..d8a3eb1594 100644 --- a/classes/constructs_ses.GuEmailIdentity.html +++ b/classes/constructs_ses.GuEmailIdentity.html @@ -6,7 +6,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 @@ -31,7 +31,7 @@

        Example

        newisConstruct
 isOwnedResource
 isResource
-

        Constructors

        constructor

        Properties

        Readonly dkimDnsTokenName1

        dkimDnsTokenName1: string

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

        Constructors

        constructor

        Properties

        Readonly dkimDnsTokenName1

        dkimDnsTokenName1: string

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

        Attribute

        Readonly dkimDnsTokenName2

        dkimDnsTokenName2: string

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

        @@ -46,7 +46,7 @@

        Example

        new
        Attribute

        Readonly dkimRecords

        dkimRecords: DkimRecord[]

        DKIM records for this identity

        Readonly emailIdentityName

        emailIdentityName: string

        Readonly env

        env: ResourceEnvironment

        Readonly idWithApp

        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.

        -

        Readonly node

        node: Node

        The tree node.

        +

        Readonly node

        node: Node

        The tree node.

        Protected Readonly physicalName

        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:

        @@ -56,7 +56,7 @@

        Example

        newa concrete name generated automatically during synthesis, in
 cross-environment scenarios.
      -

      Readonly stack

      stack: Stack

      Accessors

      Static validDomains

      Methods

      _enableCrossEnvironment

      • _enableCrossEnvironment(): void
      • Internal

        Called when this resource is referenced across environments +

      Readonly stack

      stack: Stack

      Accessors

      Static validDomains

      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_stack_set.GuStackSet.html b/classes/constructs_stack_set.GuStackSet.html index e576924e46..08dab52990 100644 --- a/classes/constructs_stack_set.GuStackSet.html +++ b/classes/constructs_stack_set.GuStackSet.html @@ -8,7 +8,7 @@ 
        Resources:
          AccountAlarmResourcesStackSet:
            Type: AWS::CloudFormation::StackSet
            Properties:
              PermissionModel: SERVICE_MANAGED
              StackSetName: centralised-alarms
              AutoDeployment:
                Enabled: true
                RetainStacksOnAccountRemoval: false
              Description: Provisioning of standard account alerting resources
              Parameters: []
              StackInstancesGroup:
                - DeploymentTargets:
                    OrganizationalUnitIds:
                      - o-abcde12345
                  Regions:
                    - Ref: AWS::Region
              Tags:
                - Key: gu:cdk:version
                  Value: TEST
                - Key: gu:repo
                  Value: guardian/cdk
                - Key: Stack
                  Value: alarms
                - Key: Stage
                  Value: INFRA
              TemplateBody: |-
                {
                  "Resources": {
                    "topicforalerts57330FBE": {
                      "Type": "AWS::SNS::Topic",
                      "Properties": {
                        "Tags": [
                          {
                            "Key": "gu:cdk:version",
                            "Value": "TEST"
                          },
                          {
                            "Key": "gu:repo",
                            "Value": "guardian/cdk"
                          },
                          {
                            "Key": "Stack",
                            "Value": "alarms"
                          },
                          {
                            "Key": "Stage",
                            "Value": "INFRA"
                          }
                        ]
                      }
                    }
                  }
                }

        See

        https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

        -

      Hierarchy

      • CfnStackSet
        • GuStackSet

      Constructors

      constructor +

      Hierarchy

      • CfnStackSet
        • GuStackSet

      Constructors

      constructor

      Properties

      _cfnProperties administrationRoleArn? attrStackSetId @@ -66,7 +66,7 @@ isCfnElement isCfnResource isConstruct -

      Constructors

      constructor

      Properties

      Protected Readonly Internal _cfnProperties

      _cfnProperties: any

      AWS CloudFormation resource properties.

      +

      Constructors

      constructor

      Properties

      Protected Readonly Internal _cfnProperties

      _cfnProperties: any

      AWS CloudFormation resource properties.

      This object is returned via cfnProperties

      Optional administrationRoleArn

      administrationRoleArn?: string

      The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.

      Readonly attrStackSetId

      attrStackSetId: string

      The ID of the stack that you're creating.

      diff --git a/classes/constructs_vpc.GuVpc.html b/classes/constructs_vpc.GuVpc.html index fbbe321f88..7226f07459 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 @@ -75,7 +75,7 @@ isOwnedResource isResource setAvailabilityZoneContext -

      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

      Readonly availabilityZones

      availabilityZones: string[]

      AZs for this VPC

      Readonly dnsHostnamesEnabled

      dnsHostnamesEnabled: boolean

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

      Readonly dnsSupportEnabled

      dnsSupportEnabled: boolean

      Indicates if DNS support is enabled for this VPC.

      @@ -183,4 +183,4 @@ This means consuming stacks do NOT have to commit a cdk.context.json file when using this construct in eu-west-1.

      Parameters

      Returns void

      Throws

      if the account ID has not been explicitly set on the parent GuStack

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/experimental_patterns.GuKinesisLambdaExperimental.html b/classes/experimental_patterns.GuKinesisLambdaExperimental.html index 9ce5befdd7..37346c1cf8 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

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    _connections? _functionUrlInvocationGrants _invocationGrants @@ -85,7 +85,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.

    @@ -94,13 +94,13 @@ 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 alias

    alias?: Alias

    Readonly app

    app: string

    Readonly architecture

    architecture: Architecture

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

    -

    Readonly bucketNamePath

    bucketNamePath: undefined | string

    Protected Readonly canCreatePermissions

    canCreatePermissions: true = true

    Optional Readonly deadLetterQueue

    deadLetterQueue?: IQueue

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

    +

    Optional Readonly alias

    alias?: Alias

    Readonly app

    app: string

    Readonly architecture

    architecture: Architecture

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

    +

    Readonly bucketNamePath

    bucketNamePath: undefined | string

    Protected Readonly canCreatePermissions

    canCreatePermissions: true = true

    Optional Readonly deadLetterQueue

    deadLetterQueue?: IQueue

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

    Optional Readonly deadLetterTopic

    deadLetterTopic?: ITopic

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

    -

    Readonly env

    env: ResourceEnvironment

    Readonly fileName

    fileName: string

    Readonly functionArn

    functionArn: string

    ARN of this function

    +

    Readonly env

    env: ResourceEnvironment

    Readonly fileName

    fileName: string

    Readonly functionArn

    functionArn: string

    ARN of this function

    Readonly functionName

    functionName: string

    Name of this function

    Readonly grantPrincipal

    grantPrincipal: IPrincipal

    The principal this Lambda Function is running as

    -

    Readonly kinesisStream

    kinesisStream: IStream

    Readonly node

    node: Node

    The tree node.

    +

    Readonly kinesisStream

    kinesisStream: IStream

    Readonly node

    node: Node

    The tree node.

    Readonly permissionsNode

    permissionsNode: Node

    Protected Readonly physicalName

    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:

    @@ -113,7 +113,7 @@

    Optional Readonly role

    role?: IRole

    Execution role associated with this function

    Readonly runtime

    runtime: Runtime

    The runtime configured for this lambda.

    Readonly stack

    stack: Stack

    Optional Readonly timeout

    timeout?: Duration

    The timeout configured for this lambda.

    -

    Readonly withoutArtifactUpload

    withoutArtifactUpload: boolean

    Readonly withoutFilePrefix

    withoutFilePrefix: boolean

    Static Internal _VER_PROPS

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

    Type declaration

    • [key: string]: boolean

    Accessors

    connections

    • get connections(): Connections

    • Access the Connections object

      +

    Readonly withoutArtifactUpload

    withoutArtifactUpload: boolean

    Readonly withoutFilePrefix

    withoutFilePrefix: boolean

    Static Internal _VER_PROPS

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

    Type declaration

    • [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/experimental_patterns.GuSnsLambdaExperimental.html b/classes/experimental_patterns.GuSnsLambdaExperimental.html index 9a65a194c7..e6c744e9f7 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

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    _connections? _functionUrlInvocationGrants _invocationGrants @@ -85,7 +85,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.

    @@ -94,10 +94,10 @@ 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 alias

    alias?: Alias

    Readonly app

    app: string

    Readonly architecture

    architecture: Architecture

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

    -

    Readonly bucketNamePath

    bucketNamePath: undefined | string

    Protected Readonly canCreatePermissions

    canCreatePermissions: true = true

    Optional Readonly deadLetterQueue

    deadLetterQueue?: IQueue

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

    +

    Optional Readonly alias

    alias?: Alias

    Readonly app

    app: string

    Readonly architecture

    architecture: Architecture

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

    +

    Readonly bucketNamePath

    bucketNamePath: undefined | string

    Protected Readonly canCreatePermissions

    canCreatePermissions: true = true

    Optional Readonly deadLetterQueue

    deadLetterQueue?: IQueue

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

    Optional Readonly deadLetterTopic

    deadLetterTopic?: ITopic

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

    -

    Readonly env

    env: ResourceEnvironment

    Readonly fileName

    fileName: string

    Readonly functionArn

    functionArn: string

    ARN of this function

    +

    Readonly env

    env: ResourceEnvironment

    Readonly fileName

    fileName: string

    Readonly functionArn

    functionArn: string

    ARN of this function

    Readonly functionName

    functionName: string

    Name of this function

    Readonly grantPrincipal

    grantPrincipal: IPrincipal

    The principal this Lambda Function is running as

    Readonly node

    node: Node

    The tree node.

    @@ -112,8 +112,8 @@

    Optional Readonly role

    role?: IRole

    Execution role associated with this function

    Readonly runtime

    runtime: Runtime

    The runtime configured for this lambda.

    -

    Readonly snsTopic

    snsTopic: ITopic

    Readonly stack

    stack: Stack

    Optional Readonly timeout

    timeout?: Duration

    The timeout configured for this lambda.

    -

    Readonly withoutArtifactUpload

    withoutArtifactUpload: boolean

    Readonly withoutFilePrefix

    withoutFilePrefix: boolean

    Static Internal _VER_PROPS

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

    Type declaration

    • [key: string]: boolean

    Accessors

    connections

    • get connections(): Connections

    • Access the Connections object

      +

    Readonly snsTopic

    snsTopic: ITopic

    Readonly stack

    stack: Stack

    Optional Readonly timeout

    timeout?: Duration

    The timeout configured for this lambda.

    +

    Readonly withoutArtifactUpload

    withoutArtifactUpload: boolean

    Readonly withoutFilePrefix

    withoutFilePrefix: boolean

    Static Internal _VER_PROPS

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

    Type declaration

    • [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.GuApiGatewayWithLambdaByPath.html b/classes/patterns.GuApiGatewayWithLambdaByPath.html index 816bf262dd..4e9ea8f0f5 100644 --- a/classes/patterns.GuApiGatewayWithLambdaByPath.html +++ b/classes/patterns.GuApiGatewayWithLambdaByPath.html @@ -8,12 +8,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

    Readonly api

    api: RestApi

    Readonly node

    node: Node

    The tree node.

    +

    Constructors

    constructor

    Properties

    Readonly api

    api: RestApi

    Readonly node

    node: Node

    The tree node.

    Methods

    toString

    • toString(): string

    • Returns a string representation of this construct.

      Returns string

    Static isConstruct

    • 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 b31efeef49..22f43ed0b3 100644 --- a/classes/patterns.GuApiLambda.html +++ b/classes/patterns.GuApiLambda.html @@ -8,7 +8,7 @@

      Example usage:

      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

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    _connections? _functionUrlInvocationGrants _invocationGrants @@ -87,7 +87,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.

    @@ -96,10 +96,10 @@ 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 alias

    alias?: Alias

    Readonly api

    api: LambdaRestApi

    Readonly app

    app: string

    Readonly architecture

    architecture: Architecture

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

    -

    Readonly bucketNamePath

    bucketNamePath: undefined | string

    Protected Readonly canCreatePermissions

    canCreatePermissions: true = true

    Optional Readonly deadLetterQueue

    deadLetterQueue?: IQueue

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

    +

    Optional Readonly alias

    alias?: Alias

    Readonly api

    api: LambdaRestApi

    Readonly app

    app: string

    Readonly architecture

    architecture: Architecture

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

    +

    Readonly bucketNamePath

    bucketNamePath: undefined | string

    Protected Readonly canCreatePermissions

    canCreatePermissions: true = true

    Optional Readonly deadLetterQueue

    deadLetterQueue?: IQueue

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

    Optional Readonly deadLetterTopic

    deadLetterTopic?: ITopic

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

    -

    Readonly env

    env: ResourceEnvironment

    Readonly fileName

    fileName: string

    Readonly functionArn

    functionArn: string

    ARN of this function

    +

    Readonly env

    env: ResourceEnvironment

    Readonly fileName

    fileName: string

    Readonly functionArn

    functionArn: string

    ARN of this function

    Readonly functionName

    functionName: string

    Name of this function

    Readonly grantPrincipal

    grantPrincipal: IPrincipal

    The principal this Lambda Function is running as

    Readonly node

    node: Node

    The tree node.

    @@ -115,7 +115,7 @@

    Optional Readonly role

    role?: IRole

    Execution role associated with this function

    Readonly runtime

    runtime: Runtime

    The runtime configured for this lambda.

    Readonly stack

    stack: Stack

    Optional Readonly timeout

    timeout?: Duration

    The timeout configured for this lambda.

    -

    Readonly withoutArtifactUpload

    withoutArtifactUpload: boolean

    Readonly withoutFilePrefix

    withoutFilePrefix: boolean

    Static Internal _VER_PROPS

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

    Type declaration

    • [key: string]: boolean

    Accessors

    connections

    • get connections(): Connections

    • Access the Connections object

      +

    Readonly withoutArtifactUpload

    withoutArtifactUpload: boolean

    Readonly withoutFilePrefix

    withoutFilePrefix: boolean

    Static Internal _VER_PROPS

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

    Type declaration

    • [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 f28a3cb0c2..79bf874450 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

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

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

    Methods

    toString isConstruct -

    Constructors

    constructor

    Properties

    Readonly autoScalingGroup

    autoScalingGroup: GuAutoScalingGroup

    Optional Readonly certificate

    certificate?: GuCertificate

    Readonly listener

    listener: GuHttpsApplicationListener

    Readonly loadBalancer

    loadBalancer: GuApplicationLoadBalancer

    Readonly node

    node: Node

    The tree node.

    -

    Readonly targetGroup

    targetGroup: GuApplicationTargetGroup

    Readonly vpc

    vpc: IVpc

    Methods

    toString

    • toString(): string

    • Returns a string representation of this construct.

      +

    Constructors

    constructor

    Properties

    Readonly autoScalingGroup

    autoScalingGroup: GuAutoScalingGroup

    Optional Readonly certificate

    certificate?: GuCertificate

    Readonly listener

    listener: GuHttpsApplicationListener

    Readonly loadBalancer

    loadBalancer: GuApplicationLoadBalancer

    Readonly node

    node: Node

    The tree node.

    +

    Readonly targetGroup

    targetGroup: GuApplicationTargetGroup

    Readonly vpc

    vpc: IVpc

    Methods

    toString

    • toString(): string

    • Returns a string representation of this construct.

      Returns string

    Static isConstruct

    Optional withoutImdsv2

    withoutImdsv2?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_autoscaling.GuUserDataProps.html b/interfaces/constructs_autoscaling.GuUserDataProps.html index 3ead32697f..af3ce609bd 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

    Optional configuration

    configuration?: GuPrivateS3ConfigurationProps

    distributable

    distributable: GuDistributableForEc2

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional configuration

    configuration?: GuPrivateS3ConfigurationProps

    distributable

    distributable: GuDistributableForEc2

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_cloudwatch.GuAlarmProps.html b/interfaces/constructs_cloudwatch.GuAlarmProps.html index 686fc273a4..0fd360148a 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

    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

    Properties

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

    Optional Readonly alarmName

    alarmName?: string

    Name of the alarm

    Default

    Automatically generated name
    -

    app

    app: string

    Optional Readonly comparisonOperator

    comparisonOperator?: ComparisonOperator

    Comparison to use to check if metric is breaching

    +

    app

    app: string

    Optional Readonly comparisonOperator

    comparisonOperator?: ComparisonOperator

    Comparison to use to check if metric is breaching

    Default

    GreaterThanOrEqualToThreshold

    Optional Readonly datapointsToAlarm

    datapointsToAlarm?: number

    The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M @@ -36,7 +36,7 @@

    See

    Readonly metric

    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.

    -

    Optional okAction

    okAction?: boolean

    snsTopicName

    snsTopicName: string

    Readonly threshold

    threshold: number

    The value against which the specified statistic is compared.

    +

    Optional okAction

    okAction?: boolean

    snsTopicName

    snsTopicName: string

    Readonly threshold

    threshold: number

    The value against which the specified statistic is compared.

    Optional Readonly treatMissingData

    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 ceb6c42cfe..83e3276fdc 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? @@ -27,4 +27,4 @@

    See

    Default

    - Not configured.
    -

    Optional lengthOfEvaluationPeriod

    lengthOfEvaluationPeriod?: Duration

    Optional noMonitoring

    noMonitoring?: false

    Optional numberOfEvaluationPeriodsAboveThresholdBeforeAlarm

    numberOfEvaluationPeriodsAboveThresholdBeforeAlarm?: number

    Optional okAction

    okAction?: boolean

    snsTopicName

    snsTopicName: string

    toleratedErrorPercentage

    toleratedErrorPercentage: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional lengthOfEvaluationPeriod

    lengthOfEvaluationPeriod?: Duration

    Optional noMonitoring

    noMonitoring?: false

    Optional numberOfEvaluationPeriodsAboveThresholdBeforeAlarm

    numberOfEvaluationPeriodsAboveThresholdBeforeAlarm?: number

    Optional okAction

    okAction?: boolean

    snsTopicName

    snsTopicName: string

    toleratedErrorPercentage

    toleratedErrorPercentage: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_cloudwatch.GuLambdaThrottlingMonitoringProps.html b/interfaces/constructs_cloudwatch.GuLambdaThrottlingMonitoringProps.html index c2b85f9163..c92a17c479 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? @@ -26,10 +26,10 @@

    See

    Default

    - Not configured.
    -

    Optional noMonitoring

    noMonitoring?: false

    Optional numberOfMinutesAboveThresholdBeforeAlarm

    numberOfMinutesAboveThresholdBeforeAlarm?: number

    Evaluation period in minutes for alarm.

    +

    Optional noMonitoring

    noMonitoring?: false

    Optional numberOfMinutesAboveThresholdBeforeAlarm

    numberOfMinutesAboveThresholdBeforeAlarm?: number

    Evaluation period in minutes for alarm.

    Default Value

    1
    -

    Optional okAction

    okAction?: boolean

    snsTopicName

    snsTopicName: string

    Optional toleratedThrottlingCount

    toleratedThrottlingCount?: number

    Sum of thottled invocations above which to alarm.

    +

    Optional okAction

    okAction?: boolean

    snsTopicName

    snsTopicName: string

    Optional toleratedThrottlingCount

    toleratedThrottlingCount?: number

    Sum of thottled invocations above which to alarm.

    Default Value

    0
    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_cloudwatch.Http4xxAlarmProps.html b/interfaces/constructs_cloudwatch.Http4xxAlarmProps.html index e3cc95906d..e1d95d79d0 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? @@ -28,4 +28,4 @@

    See

    Default

    - Not configured.
    -

    Optional numberOfMinutesAboveThresholdBeforeAlarm

    numberOfMinutesAboveThresholdBeforeAlarm?: number

    Optional okAction

    okAction?: boolean

    tolerated4xxPercentage

    tolerated4xxPercentage: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional numberOfMinutesAboveThresholdBeforeAlarm

    numberOfMinutesAboveThresholdBeforeAlarm?: number

    Optional okAction

    okAction?: boolean

    tolerated4xxPercentage

    tolerated4xxPercentage: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_cloudwatch.Http5xxAlarmProps.html b/interfaces/constructs_cloudwatch.Http5xxAlarmProps.html index af201fee91..592530ef0b 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? @@ -28,4 +28,4 @@

    See

    Default

    - Not configured.
    -

    Optional numberOfMinutesAboveThresholdBeforeAlarm

    numberOfMinutesAboveThresholdBeforeAlarm?: number

    Optional okAction

    okAction?: boolean

    tolerated5xxPercentage

    tolerated5xxPercentage: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional numberOfMinutesAboveThresholdBeforeAlarm

    numberOfMinutesAboveThresholdBeforeAlarm?: number

    Optional okAction

    okAction?: boolean

    tolerated5xxPercentage

    tolerated5xxPercentage: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_cloudwatch.NoMonitoring.html b/interfaces/constructs_cloudwatch.NoMonitoring.html index 1bed74a3fb..06a927820a 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: true

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +NoMonitoring | @guardian/cdk

    Interface NoMonitoring

    interface NoMonitoring {
        noMonitoring: true;
    }

    Properties

    noMonitoring +

    Properties

    noMonitoring

    noMonitoring: true

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_core.AppIdentity.html b/interfaces/constructs_core.AppIdentity.html index 885a9d289f..38fabe3f92 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;
    }

    Properties

    app -

    Properties

    app

    app: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +AppIdentity | @guardian/cdk

    Interface AppIdentity

    interface AppIdentity {
        app: string;
    }

    Properties

    app +

    Properties

    app

    app: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_core.GuParameterProps.html b/interfaces/constructs_core.GuParameterProps.html index 1ae1d86d29..1d0fd95202 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? @@ -30,7 +30,7 @@

    Optional Readonly description

    description?: string

    A string of up to 4000 characters that describes the parameter.

    Default

    - No description for the parameter.
    -

    Optional fromSSM

    fromSSM?: boolean

    Optional Readonly maxLength

    maxLength?: number

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

    +

    Optional fromSSM

    fromSSM?: boolean

    Optional Readonly maxLength

    maxLength?: number

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

    Default

    - None.

    Optional Readonly maxValue

    maxValue?: number

    A numeric value that determines the largest numeric value you want to allow for Number types.

    diff --git a/interfaces/constructs_core.GuStackProps.html b/interfaces/constructs_core.GuStackProps.html index ed6477615d..2bf81ed565 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;
        permissionsBoundary?: PermissionsBoundary;
        stack: string;
        stage: string;
        suppressTemplateIndentation?: boolean;
        synthesizer?: IStackSynthesizer;
        tags?: {
            [key: string]: string;
        };
        terminationProtection?: boolean;
        withBackup?: 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;
        permissionsBoundary?: PermissionsBoundary;
        stack: string;
        stage: string;
        suppressTemplateIndentation?: boolean;
        synthesizer?: IStackSynthesizer;
        tags?: {
            [key: string]: string;
        };
        terminationProtection?: boolean;
        withBackup?: 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

    Optional app

    app?: string

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

    -

    Optional cloudFormationStackName

    cloudFormationStackName?: string

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

    +

    Optional cloudFormationStackName

    cloudFormationStackName?: string

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

    Default Value

    the GU_CFN_STACK_NAME environment variable

    -

    Optional Readonly crossRegionReferences

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    +

    Optional Readonly crossRegionReferences

    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

    @@ -58,7 +58,7 @@

    Default

    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

    Optional Readonly suppressTemplateIndentation

    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated +

    stage

    stage: string

    Optional Readonly suppressTemplateIndentation

    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 @@ -88,9 +88,9 @@

    Default

    Default

    false - backups are not enabled

    See

    https://github.com/guardian/aws-backup

    -

    Optional withoutMetadata

    withoutMetadata?: boolean

    Set to disable CDK metadata. Only for internal use (for disabling for some +

    Optional withoutMetadata

    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.

    -

    Optional withoutTags

    withoutTags?: boolean

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

    Optional withoutTags

    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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_core.GuStaticLogicalId.html b/interfaces/constructs_core.GuStaticLogicalId.html index e5a607d173..7c59e10aa0 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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    reason

    reason: string

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

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_core.Identity.html b/interfaces/constructs_core.Identity.html index 339c345448..57f267a0d0 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

    Properties

    app +Identity | @guardian/cdk

    Interface Identity

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

    Hierarchy

    Properties

    app stack stage -

    Properties

    app

    app: string

    stack

    stack: string

    stage

    stage: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    app

    app: string

    stack

    stack: string

    stage

    stage: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_core.StackStageIdentity.html b/interfaces/constructs_core.StackStageIdentity.html index b4df1e0670..7c207e1339 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

    Implemented by

    Properties

    stack +StackStageIdentity | @guardian/cdk

    Interface StackStageIdentity

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

    Hierarchy

    Implemented by

    Properties

    stack stage -

    Properties

    stack

    stack: string

    stage

    stage: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    stack

    stack: string

    stage

    stage: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_dns.GuCnameProps.html b/interfaces/constructs_dns.GuCnameProps.html index a81e1d1471..f2693a12d8 100644 --- a/interfaces/constructs_dns.GuCnameProps.html +++ b/interfaces/constructs_dns.GuCnameProps.html @@ -1,13 +1,13 @@ -GuCnameProps | @guardian/cdk

    Interface GuCnameProps

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

    Hierarchy

    Properties

    app +GuCnameProps | @guardian/cdk

    Interface GuCnameProps

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

    Hierarchy

    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"
    -

    Optional hostedZoneId

    hostedZoneId?: string

    Route53 Zone ID.

    +

    Optional hostedZoneId

    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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_dns.GuDnsRecordSetProps.html b/interfaces/constructs_dns.GuDnsRecordSetProps.html index a9d1c7152c..6f1a253870 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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    name

    name: string

    recordType

    recordType: CNAME

    resourceRecords

    resourceRecords: string[]

    ttl

    ttl: Duration

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_ec2.GuBaseSecurityGroupProps.html b/interfaces/constructs_ec2.GuBaseSecurityGroupProps.html index 5d4469ed97..dfe64b269a 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

    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

    Properties

    allowAllIpv6Outbound? allowAllOutbound? description? disableInlineRules? @@ -32,7 +32,7 @@ '@aws-cdk/aws-ec2.securityGroupDisableInlineRules'.

    Default

    false
    -

    Optional egresses

    egresses?: SecurityGroupAccessRule[]

    Optional ingresses

    ingresses?: SecurityGroupAccessRule[]

    Optional Readonly securityGroupName

    securityGroupName?: string

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

    Optional egresses

    egresses?: SecurityGroupAccessRule[]

    Optional ingresses

    ingresses?: SecurityGroupAccessRule[]

    Optional Readonly securityGroupName

    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 c058ccc695..6de4f8b40a 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

    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

    Properties

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

    To allow all ipv6 traffic use allowAllIpv6Outbound

    Default

    true
    -

    app

    app: string

    Optional Readonly description

    description?: string

    A description of the security group.

    +

    app

    app: string

    Optional Readonly description

    description?: string

    A description of the security group.

    Default

    The default name will be the construct's CDK path.

    Optional Readonly disableInlineRules

    disableInlineRules?: boolean

    Whether to disable inline ingress and egress rule optimization.

    @@ -33,7 +33,7 @@ '@aws-cdk/aws-ec2.securityGroupDisableInlineRules'.

    Default

    false
    -

    Optional egresses

    egresses?: SecurityGroupAccessRule[]

    Optional ingresses

    ingresses?: SecurityGroupAccessRule[]

    Optional Readonly securityGroupName

    securityGroupName?: string

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

    Optional egresses

    egresses?: SecurityGroupAccessRule[]

    Optional ingresses

    ingresses?: SecurityGroupAccessRule[]

    Optional Readonly securityGroupName

    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 7092befca1..2c55894f75 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

    Optional app

    app?: string

    Optional type

    type?: SubnetType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional app

    app?: string

    Optional type

    type?: SubnetType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_ec2.SecurityGroupAccessRule.html b/interfaces/constructs_ec2.SecurityGroupAccessRule.html index 93e932f1ad..c9d928085f 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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_ecs.GuEcsTaskProps.html b/interfaces/constructs_ecs.GuEcsTaskProps.html index 5e999b8f57..e2f4cc0a9b 100644 --- a/interfaces/constructs_ecs.GuEcsTaskProps.html +++ b/interfaces/constructs_ecs.GuEcsTaskProps.html @@ -27,7 +27,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;
        containerConfiguration: ContainerConfiguration;
        cpu?: number;
        customTaskPolicies?: PolicyStatement[];
        enableDistributablePolicy?: boolean;
        environmentOverrides?: TaskEnvironmentVariable[];
        memory?: number;
        monitoringConfiguration: NoMonitoring | GuEcsTaskMonitoringProps;
        securityGroups?: ISecurityGroup[];
        storage?: number;
        taskCommand?: string;
        taskTimeoutInMinutes?: number;
        vpc: IVpc;
    }

    Hierarchy

    Properties

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

    Hierarchy

    Properties

    app containerConfiguration cpu? customTaskPolicies? @@ -40,8 +40,8 @@ taskCommand? taskTimeoutInMinutes? vpc -

    Properties

    app

    app: string

    containerConfiguration

    containerConfiguration: ContainerConfiguration

    Optional cpu

    cpu?: number

    Optional customTaskPolicies

    customTaskPolicies?: PolicyStatement[]

    Optional enableDistributablePolicy

    enableDistributablePolicy?: boolean

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

    Properties

    app

    app: string

    containerConfiguration

    containerConfiguration: ContainerConfiguration

    Optional cpu

    cpu?: number

    Optional customTaskPolicies

    customTaskPolicies?: PolicyStatement[]

    Optional enableDistributablePolicy

    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.

    -

    Optional environmentOverrides

    environmentOverrides?: TaskEnvironmentVariable[]

    Optional memory

    memory?: number

    monitoringConfiguration

    monitoringConfiguration: NoMonitoring | GuEcsTaskMonitoringProps

    Optional securityGroups

    securityGroups?: ISecurityGroup[]

    Optional storage

    storage?: number

    Optional taskCommand

    taskCommand?: string

    Optional taskTimeoutInMinutes

    taskTimeoutInMinutes?: number

    vpc

    vpc: IVpc

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional environmentOverrides

    environmentOverrides?: TaskEnvironmentVariable[]

    Optional memory

    memory?: number

    monitoringConfiguration

    monitoringConfiguration: NoMonitoring | GuEcsTaskMonitoringProps

    Optional securityGroups

    securityGroups?: ISecurityGroup[]

    Optional storage

    storage?: number

    Optional taskCommand

    taskCommand?: string

    Optional taskTimeoutInMinutes

    taskTimeoutInMinutes?: number

    vpc

    vpc: IVpc

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_iam.GuAllowPolicyProps.html b/interfaces/constructs_iam.GuAllowPolicyProps.html index 890ef97340..515da3e6bb 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

    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

    Properties

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

    Properties

    actions

    actions: string[]

    Optional Readonly document

    document?: PolicyDocument

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

    Properties

    actions

    actions: string[]

    Optional Readonly document

    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.
@@ -30,7 +30,7 @@
 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.
    -

    resources

    resources: string[]

    Optional Readonly roles

    roles?: IRole[]

    Roles to attach this policy to. +

    resources

    resources: string[]

    Optional Readonly roles

    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 f7ad631219..f6e5aa375b 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

    Properties

    document? +GuAssumeRolePolicyProps | @guardian/cdk

    Interface GuAssumeRolePolicyProps

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

    Hierarchy

    Properties

    document? force? groups? policyName? @@ -29,7 +29,7 @@ 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.
    -

    resources

    resources: string[]

    Optional Readonly roles

    roles?: IRole[]

    Roles to attach this policy to. +

    resources

    resources: string[]

    Optional Readonly roles

    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 ab518b7593..1124218a50 100644 --- a/interfaces/constructs_iam.GuFastlyLogsIamRoleProps.html +++ b/interfaces/constructs_iam.GuFastlyLogsIamRoleProps.html @@ -1,7 +1,7 @@ -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

    -

    Optional path

    path?: string

    Path within the S3 bucket where Fastly will ship logs.

    +

    Optional path

    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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_iam.GuGetS3ObjectPolicyProps.html b/interfaces/constructs_iam.GuGetS3ObjectPolicyProps.html index 881970c819..f05963a57e 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

    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

    Properties

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

    Properties

    bucketName

    bucketName: string

    Optional Readonly document

    document?: PolicyDocument

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

    Properties

    bucketName

    bucketName: string

    Optional Readonly document

    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.
@@ -25,7 +25,7 @@
 You can also use attachToGroup(group) to attach this policy to a group.

    Default

    - No groups.
    -

    Optional paths

    paths?: string[]

    Optional Readonly policyName

    policyName?: string

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

    Optional paths

    paths?: string[]

    Optional Readonly policyName

    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 6df0be15dc..a33889775e 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.
    
-
    Optional repositories
    repositories?: string
    Repositories to constrain the IAM Role to.
    
-
    Settings
    Member Visibility
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
+
    Optional repositories
    repositories?: string
    Repositories to constrain the IAM Role to.
    
+
    Settings
    Member Visibility
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/interfaces/constructs_iam.GuGithubActionsRoleProps.html b/interfaces/constructs_iam.GuGithubActionsRoleProps.html
index 7320421a58..14c4ee1e0b 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
    Optional condition
    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
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
+
    policies
    policies: GuPolicy[]
    A list of IAM Policies for the GitHub Action.
    
+
    Settings
    Member Visibility
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/interfaces/constructs_iam.GuInstanceRoleProps.html b/interfaces/constructs_iam.GuInstanceRoleProps.html
index bc4ed99d88..27e9333378 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
    Optional additionalPolicies
    additionalPolicies?: GuPolicy[]
    Optional withoutLogShipping
    withoutLogShipping?: boolean
    By default, instances are given permissions to write to Kinesis. Set to
+
    Properties
    Optional additionalPolicies
    additionalPolicies?: GuPolicy[]
    Optional withoutLogShipping
    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
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
+

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/constructs_iam.GuPutS3ObjectPolicyProps.html b/interfaces/constructs_iam.GuPutS3ObjectPolicyProps.html index 955a2d7e1b..e21acfa3c8 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

    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

    Properties

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

    Properties

    bucketName

    bucketName: string

    Optional Readonly document

    document?: PolicyDocument

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

    Properties

    bucketName

    bucketName: string

    Optional Readonly document

    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.
@@ -25,7 +25,7 @@
 You can also use attachToGroup(group) to attach this policy to a group.

    Default

    - No groups.
    -

    Optional paths

    paths?: string[]

    Optional Readonly policyName

    policyName?: string

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

    Optional paths

    paths?: string[]

    Optional Readonly policyName

    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 798b9a189f..c68e8773de 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; 
        allowAllOutbound?: boolean; 
        allowPublicSubnet?: boolean; 
        app: string; 
        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; 
        layers?: ILayerVersion[]; 
        logRetention?: RetentionDays; 
        logRetentionRetryOptions?: LogRetentionRetryOptions; 
        logRetentionRole?: IRole; 
        maxEventAge?: Duration; 
        memorySize?: number; 
        onFailure?: IDestination; 
        onSuccess?: IDestination; 
        paramsAndSecrets?: ParamsAndSecretsLayerVersion; 
        profiling?: boolean; 
        profilingGroup?: IProfilingGroup; 
        reservedConcurrentExecutions?: number; 
        retryAttempts?: number; 
        role?: IRole; 
        runtime: Runtime; 
        runtimeManagementMode?: RuntimeManagementMode; 
        securityGroups?: ISecurityGroup[]; 
        snapStart?: SnapStartConf; 
        throttlingMonitoring?: GuLambdaThrottlingMonitoringProps; 
        timeout?: Duration; 
        tracing?: Tracing; 
        vpc?: IVpc; 
        vpcSubnets?: SubnetSelection; 
        withoutArtifactUpload?: boolean; 
        withoutFilePrefix?: boolean; 
    }
    Hierarchy
    Properties
    adotInstrumentation?
+GuFunctionProps | @guardian/cdk
    Interface GuFunctionProps
    interface GuFunctionProps { 
        adotInstrumentation?: AdotInstrumentationConfig; 
        allowAllOutbound?: boolean; 
        allowPublicSubnet?: boolean; 
        app: string; 
        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; 
        layers?: ILayerVersion[]; 
        logRetention?: RetentionDays; 
        logRetentionRetryOptions?: LogRetentionRetryOptions; 
        logRetentionRole?: IRole; 
        maxEventAge?: Duration; 
        memorySize?: number; 
        onFailure?: IDestination; 
        onSuccess?: IDestination; 
        paramsAndSecrets?: ParamsAndSecretsLayerVersion; 
        profiling?: boolean; 
        profilingGroup?: IProfilingGroup; 
        reservedConcurrentExecutions?: number; 
        retryAttempts?: number; 
        role?: IRole; 
        runtime: Runtime; 
        runtimeManagementMode?: RuntimeManagementMode; 
        securityGroups?: ISecurityGroup[]; 
        snapStart?: SnapStartConf; 
        throttlingMonitoring?: GuLambdaThrottlingMonitoringProps; 
        timeout?: Duration; 
        tracing?: Tracing; 
        vpc?: IVpc; 
        vpcSubnets?: SubnetSelection; 
        withoutArtifactUpload?: boolean; 
        withoutFilePrefix?: boolean; 
    }
    Hierarchy
    Properties
    adotInstrumentation?
 allowAllOutbound?
 allowPublicSubnet?
 app
@@ -61,7 +61,7 @@ 
    Default
    - 
    See
    https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841
    
 
    Default
    false
 
    
-
    app
    app: string
    Optional Readonly architecture
    architecture?: Architecture
    The system architectures compatible with this lambda function.
    
+
    app
    app: string
    Optional Readonly architecture
    architecture?: Architecture
    The system architectures compatible with this lambda function.
    
 
    Default
    Architecture.X86_64
 
    
 
    Optional bucketNamePath
    bucketNamePath?: string
    SSM parameter for the S3 bucket that contains your lambda file.
    
@@ -69,7 +69,7 @@ 
    Default
    false
 you are referencing a file that is shared across many apps and/or AWS
 accounts.
    
 
    Default Value
    [[GuDistributionBucketParameter]]
    
-
    Optional Readonly codeSigningConfig
    codeSigningConfig?: ICodeSigningConfig
    Code signing config associated with this function
    
+
    Optional Readonly codeSigningConfig
    codeSigningConfig?: ICodeSigningConfig
    Code signing config associated with this function
    
 
    Default
    - Not Sign the Code
 
    
 
    Optional Readonly currentVersionOptions
    currentVersionOptions?: VersionOptions
    Options for the lambda.Version resource automatically created by the
@@ -99,7 +99,7 @@ 
    Default
    false
 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 Readonly environment
    environment?: { 
        [key: string]: string; 
    }
    Key-value pairs that Lambda caches and makes available for your Lambda
+
    Optional Readonly environment
    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.
    
@@ -112,13 +112,13 @@ 
    Default
    false
 
    Default
    512 MiB
 
    
 
    Optional errorPercentageMonitoring
    errorPercentageMonitoring?: GuLambdaErrorPercentageMonitoringProps
    Alarm if error percentage exceeds a threshold.
    
-
    Optional Readonly events
    events?: IEventSource[]
    Event sources for this function.
    
+
    Optional Readonly events
    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 Readonly filesystem
    filesystem?: FileSystem
    The filesystem configuration for the lambda function
    
+
    Optional Readonly filesystem
    filesystem?: FileSystem
    The filesystem configuration for the lambda function
    
 
    Default
    - will not mount any filesystem
 
    
 
    Optional Readonly functionName
    functionName?: string
    A name for the function.
    
@@ -239,7 +239,7 @@ 
    See
    See
    https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html
    
-
    Optional Readonly timeout
    timeout?: Duration
    The function execution time (in seconds) after which Lambda terminates
+
    Optional Readonly timeout
    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)
@@ -263,8 +263,8 @@ 
    See
    Optional withoutFilePrefix
    withoutFilePrefix?: boolean
    Set to true to use the filename without the stage/stack/app prefix.
    
+
    Optional withoutFilePrefix
    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
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
+
    Settings
    Member Visibility
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/interfaces/constructs_loadbalancing.GuApplicationListenerProps.html b/interfaces/constructs_loadbalancing.GuApplicationListenerProps.html
index 5ca1f70b35..b644076c12 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; 
        open?: boolean; 
        port?: number; 
        protocol?: ApplicationProtocol; 
        sslPolicy?: SslPolicy; 
    }
    Hierarchy
    • ApplicationListenerProps
    • AppIdentity
      • GuApplicationListenerProps
    Properties
    app
+GuApplicationListenerProps | @guardian/cdk
    Interface GuApplicationListenerProps
    interface GuApplicationListenerProps { 
        app: string; 
        certificates?: IListenerCertificate[]; 
        defaultAction?: ListenerAction; 
        defaultTargetGroups?: IApplicationTargetGroup[]; 
        loadBalancer: IApplicationLoadBalancer; 
        open?: boolean; 
        port?: number; 
        protocol?: ApplicationProtocol; 
        sslPolicy?: SslPolicy; 
    }
    Hierarchy
    • ApplicationListenerProps
    • AppIdentity
      • GuApplicationListenerProps
    Properties
    app
 certificates?
 defaultAction?
 defaultTargetGroups?
@@ -7,7 +7,7 @@
 port?
 protocol?
 sslPolicy?
-
    Properties
    app
    app: string
    Optional Readonly certificates
    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 Readonly certificates
    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.
 
    
 
    Optional Readonly defaultAction
    defaultAction?: ListenerAction
    Default action to take for requests to this listener
    
diff --git a/interfaces/constructs_loadbalancing.GuApplicationTargetGroupProps.html b/interfaces/constructs_loadbalancing.GuApplicationTargetGroupProps.html
index 4379feda1b..ab142ddd4f 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; 
        healthCheck?: HealthCheck; 
        loadBalancingAlgorithmType?: TargetGroupLoadBalancingAlgorithmType; 
        port?: number; 
        protocol?: ApplicationProtocol; 
        protocolVersion?: ApplicationProtocolVersion; 
        slowStart?: Duration; 
        stickinessCookieDuration?: Duration; 
        stickinessCookieName?: string; 
        targetGroupName?: string; 
        targetType?: TargetType; 
        targets?: IApplicationLoadBalancerTarget[]; 
        vpc?: IVpc; 
    }
    Hierarchy
    • ApplicationTargetGroupProps
    • AppIdentity
      • GuApplicationTargetGroupProps
    Properties
    app
+GuApplicationTargetGroupProps | @guardian/cdk
    Interface GuApplicationTargetGroupProps
    interface GuApplicationTargetGroupProps { 
        app: string; 
        deregistrationDelay?: Duration; 
        healthCheck?: HealthCheck; 
        loadBalancingAlgorithmType?: TargetGroupLoadBalancingAlgorithmType; 
        port?: number; 
        protocol?: ApplicationProtocol; 
        protocolVersion?: ApplicationProtocolVersion; 
        slowStart?: Duration; 
        stickinessCookieDuration?: Duration; 
        stickinessCookieName?: string; 
        targetGroupName?: string; 
        targetType?: TargetType; 
        targets?: IApplicationLoadBalancerTarget[]; 
        vpc?: IVpc; 
    }
    Hierarchy
    • ApplicationTargetGroupProps
    • AppIdentity
      • GuApplicationTargetGroupProps
    Properties
    app
 deregistrationDelay?
 healthCheck?
 loadBalancingAlgorithmType?
@@ -12,7 +12,7 @@
 targetType?
 targets?
 vpc?
-
    Properties
    app
    app: string
    Optional Readonly deregistrationDelay
    deregistrationDelay?: Duration
    The amount of time for Elastic Load Balancing to wait before deregistering a target.
    
+
    Properties
    app
    app: string
    Optional Readonly deregistrationDelay
    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 64320eb953..debe26929d 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; 
        open?: boolean; 
        port?: number; 
        protocol?: ApplicationProtocol; 
        sslPolicy?: SslPolicy; 
        targetGroup: GuApplicationTargetGroup; 
    }
    Hierarchy
    Properties
    app
+GuHttpsApplicationListenerProps | @guardian/cdk
    Interface GuHttpsApplicationListenerProps
    interface GuHttpsApplicationListenerProps { 
        app: string; 
        certificate?: GuCertificate; 
        defaultTargetGroups?: IApplicationTargetGroup[]; 
        loadBalancer: IApplicationLoadBalancer; 
        open?: boolean; 
        port?: number; 
        protocol?: ApplicationProtocol; 
        sslPolicy?: SslPolicy; 
        targetGroup: GuApplicationTargetGroup; 
    }
    Hierarchy
    Properties
    app
 certificate?
 defaultTargetGroups?
 loadBalancer
@@ -7,7 +7,7 @@
 protocol?
 sslPolicy?
 targetGroup
-
    Properties
    app
    app: string
    Optional certificate
    certificate?: GuCertificate
    Optional Readonly defaultTargetGroups
    defaultTargetGroups?: IApplicationTargetGroup[]
    Default target groups to load balance to
    
+
    Properties
    app
    app: string
    Optional certificate
    certificate?: GuCertificate
    Optional Readonly defaultTargetGroups
    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().
    
@@ -33,4 +33,4 @@
 
    Optional Readonly sslPolicy
    sslPolicy?: SslPolicy
    The security policy that defines which ciphers and protocols are supported.
    
 
    Default
    - The current predefined security policy.
 
    
-
    targetGroup
    targetGroup: GuApplicationTargetGroup
    Settings
    Member Visibility
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
+
    targetGroup
    targetGroup: GuApplicationTargetGroup
    Settings
    Member Visibility
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/interfaces/constructs_rds.GuDatabaseInstanceProps.html b/interfaces/constructs_rds.GuDatabaseInstanceProps.html
index 3f812290b3..6e43bf7958 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; 
        backupRetention?: Duration; 
        caCertificate?: CaCertificate; 
        characterSetName?: string; 
        cloudwatchLogsExports?: string[]; 
        cloudwatchLogsRetention?: RetentionDays; 
        cloudwatchLogsRetentionRole?: IRole; 
        copyTagsToSnapshot?: boolean; 
        credentials?: Credentials; 
        databaseName?: string; 
        deleteAutomatedBackups?: boolean; 
        deletionProtection?: boolean; 
        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; 
        preferredBackupWindow?: string; 
        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
    • Omit<DatabaseInstanceProps, "instanceType">
    • AppIdentity
      • GuDatabaseInstanceProps
    Properties
    allocatedStorage?
+GuDatabaseInstanceProps | @guardian/cdk
    Interface GuDatabaseInstanceProps
    interface GuDatabaseInstanceProps { 
        allocatedStorage?: number; 
        allowMajorVersionUpgrade?: boolean; 
        app: string; 
        autoMinorVersionUpgrade?: boolean; 
        availabilityZone?: string; 
        backupRetention?: Duration; 
        caCertificate?: CaCertificate; 
        characterSetName?: string; 
        cloudwatchLogsExports?: string[]; 
        cloudwatchLogsRetention?: RetentionDays; 
        cloudwatchLogsRetentionRole?: IRole; 
        copyTagsToSnapshot?: boolean; 
        credentials?: Credentials; 
        databaseName?: string; 
        deleteAutomatedBackups?: boolean; 
        deletionProtection?: boolean; 
        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; 
        preferredBackupWindow?: string; 
        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
    • Omit<DatabaseInstanceProps, "instanceType">
    • AppIdentity
      • GuDatabaseInstanceProps
    Properties
    allocatedStorage?
 allowMajorVersionUpgrade?
 app
 autoMinorVersionUpgrade?
@@ -58,7 +58,7 @@
 
    Optional Readonly allowMajorVersionUpgrade
    allowMajorVersionUpgrade?: boolean
    Whether to allow major version upgrades.
    
 
    Default
    false
 
    
-
    app
    app: string
    Optional Readonly autoMinorVersionUpgrade
    autoMinorVersionUpgrade?: boolean
    Indicates that minor engine upgrades are applied automatically to the
+
    app
    app: string
    Optional Readonly autoMinorVersionUpgrade
    autoMinorVersionUpgrade?: boolean
    Indicates that minor engine upgrades are applied automatically to the
 DB instance during the maintenance window.
    
 
    Default
    true
 
    
@@ -137,7 +137,7 @@ 
    Default
    - 
 
    Default
    - a CloudFormation generated name
 
    
-
    instanceType
    instanceType: string
    Optional Readonly iops
    iops?: number
    The number of I/O operations per second (IOPS) that the database provisions.
+
    instanceType
    instanceType: string
    Optional Readonly iops
    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_s3.GuS3BucketProps.html b/interfaces/constructs_s3.GuS3BucketProps.html
index b86022669d..1ca6cccae6 100644
--- a/interfaces/constructs_s3.GuS3BucketProps.html
+++ b/interfaces/constructs_s3.GuS3BucketProps.html
@@ -1,4 +1,4 @@
-GuS3BucketProps | @guardian/cdk
    Interface GuS3BucketProps
    interface GuS3BucketProps { 
        accessControl?: BucketAccessControl; 
        app: string; 
        autoDeleteObjects?: boolean; 
        blockPublicAccess?: BlockPublicAccess; 
        bucketKeyEnabled?: boolean; 
        bucketName?: string; 
        cors?: CorsRule[]; 
        encryption?: BucketEncryption; 
        encryptionKey?: IKey; 
        enforceSSL?: boolean; 
        eventBridgeEnabled?: boolean; 
        intelligentTieringConfigurations?: IntelligentTieringConfiguration[]; 
        inventories?: Inventory[]; 
        lifecycleRules?: LifecycleRule[]; 
        metrics?: BucketMetrics[]; 
        minimumTLSVersion?: number; 
        notificationsHandlerRole?: IRole; 
        objectLockDefaultRetention?: ObjectLockRetention; 
        objectLockEnabled?: boolean; 
        objectOwnership?: ObjectOwnership; 
        publicReadAccess?: boolean; 
        serverAccessLogsBucket?: IBucket; 
        serverAccessLogsPrefix?: string; 
        transferAcceleration?: boolean; 
        versioned?: boolean; 
        websiteErrorDocument?: string; 
        websiteIndexDocument?: string; 
        websiteRedirect?: RedirectTarget; 
        websiteRoutingRules?: RoutingRule[]; 
    }
    Hierarchy
    • Omit<BucketProps, "removalPolicy">
    • AppIdentity
      • GuS3BucketProps
    Properties
    accessControl?
+GuS3BucketProps | @guardian/cdk
    Interface GuS3BucketProps
    interface GuS3BucketProps { 
        accessControl?: BucketAccessControl; 
        app: string; 
        autoDeleteObjects?: boolean; 
        blockPublicAccess?: BlockPublicAccess; 
        bucketKeyEnabled?: boolean; 
        bucketName?: string; 
        cors?: CorsRule[]; 
        encryption?: BucketEncryption; 
        encryptionKey?: IKey; 
        enforceSSL?: boolean; 
        eventBridgeEnabled?: boolean; 
        intelligentTieringConfigurations?: IntelligentTieringConfiguration[]; 
        inventories?: Inventory[]; 
        lifecycleRules?: LifecycleRule[]; 
        metrics?: BucketMetrics[]; 
        minimumTLSVersion?: number; 
        notificationsHandlerRole?: IRole; 
        objectLockDefaultRetention?: ObjectLockRetention; 
        objectLockEnabled?: boolean; 
        objectOwnership?: ObjectOwnership; 
        publicReadAccess?: boolean; 
        serverAccessLogsBucket?: IBucket; 
        serverAccessLogsPrefix?: string; 
        transferAcceleration?: boolean; 
        versioned?: boolean; 
        websiteErrorDocument?: string; 
        websiteIndexDocument?: string; 
        websiteRedirect?: RedirectTarget; 
        websiteRoutingRules?: RoutingRule[]; 
    }
    Hierarchy
    • Omit<BucketProps, "removalPolicy">
    • AppIdentity
      • GuS3BucketProps
    Properties
    accessControl?
 app
 autoDeleteObjects?
 blockPublicAccess?
@@ -30,7 +30,7 @@
 
    Properties
    Optional Readonly accessControl
    accessControl?: BucketAccessControl
    Specifies a canned ACL that grants predefined permissions to the bucket.
    
 
    Default
    BucketAccessControl.PRIVATE
 
    
-
    app
    app: string
    Optional Readonly autoDeleteObjects
    autoDeleteObjects?: boolean
    Whether all objects should be automatically deleted when the bucket is
+
    app
    app: string
    Optional Readonly autoDeleteObjects
    autoDeleteObjects?: boolean
    Whether all objects should be automatically deleted when the bucket is
 removed from the stack or when the stack is deleted.
    
 
    Requires the removalPolicy to be set to RemovalPolicy.DESTROY.
    
 
    Warning if you have deployed a bucket with autoDeleteObjects: true,
diff --git a/interfaces/constructs_ses.GuEmailIdentityProps.html b/interfaces/constructs_ses.GuEmailIdentityProps.html
index f1d3a20b36..bd4cc22aa1 100644
--- a/interfaces/constructs_ses.GuEmailIdentityProps.html
+++ b/interfaces/constructs_ses.GuEmailIdentityProps.html
@@ -2,7 +2,7 @@
 domainName: The domain name to use for this identity
 The domain name must be one of GuEmailIdentity.validDomains
    
 
    See
    https://github.com/guardian/dns-validation-lambda/blob/main/README.md
    
-
    interface GuEmailIdentityProps { 
        app: string; 
        configurationSet?: IConfigurationSet; 
        dkimIdentity?: DkimIdentity; 
        dkimSigning?: boolean; 
        domainName: string; 
        feedbackForwarding?: boolean; 
        mailFromBehaviorOnMxFailure?: MailFromBehaviorOnMxFailure; 
        mailFromDomain?: string; 
    }
    Hierarchy
    • Omit<EmailIdentityProps, "identity">
    • AppIdentity
      • GuEmailIdentityProps
    Properties
    app
+
    interface GuEmailIdentityProps { 
        app: string; 
        configurationSet?: IConfigurationSet; 
        dkimIdentity?: DkimIdentity; 
        dkimSigning?: boolean; 
        domainName: string; 
        feedbackForwarding?: boolean; 
        mailFromBehaviorOnMxFailure?: MailFromBehaviorOnMxFailure; 
        mailFromDomain?: string; 
    }
    Hierarchy
    • Omit<EmailIdentityProps, "identity">
    • AppIdentity
      • GuEmailIdentityProps
    Properties
    app
 configurationSet?
 dkimIdentity?
 dkimSigning?
@@ -10,7 +10,7 @@
 feedbackForwarding?
 mailFromBehaviorOnMxFailure?
 mailFromDomain?
-
    Properties
    app
    app: string
    Optional Readonly configurationSet
    configurationSet?: IConfigurationSet
    The configuration set to associate with the email identity
    
+
    Properties
    app
    app: string
    Optional Readonly configurationSet
    configurationSet?: IConfigurationSet
    The configuration set to associate with the email identity
    
 
    Default
    - do not use a specific configuration set
 
    
 
    Optional Readonly dkimIdentity
    dkimIdentity?: DkimIdentity
    The type of DKIM identity to use
    
@@ -19,7 +19,7 @@
 
    Optional Readonly dkimSigning
    dkimSigning?: boolean
    Whether the messages that are sent from the identity are signed using DKIM
    
 
    Default
    true
 
    
-
    domainName
    domainName: string
    Optional Readonly feedbackForwarding
    feedbackForwarding?: boolean
    Whether to receive email notifications when bounce or complaint events occur.
+
    domainName
    domainName: string
    Optional Readonly feedbackForwarding
    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 8e2317bfc9..c52ec320f9 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
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
+
    interface ExistingKinesisStream { 
        externalKinesisStreamName: string; 
    }
    Properties
    externalKinesisStreamName
+
    Properties
    externalKinesisStreamName
    externalKinesisStreamName: string
    Settings
    Member Visibility
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/interfaces/experimental_patterns.ExistingSnsTopic.html b/interfaces/experimental_patterns.ExistingSnsTopic.html
index 491e3cdb3e..3c28e6302f 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
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
+
    interface ExistingSnsTopic { 
        externalTopicName: string; 
    }
    Properties
    externalTopicName
+
    Properties
    externalTopicName
    externalTopicName: string
    Settings
    Member Visibility
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/interfaces/experimental_patterns.GuKinesisLambdaProps.html b/interfaces/experimental_patterns.GuKinesisLambdaProps.html
index 1331635b81..900e3cbea1 100644
--- a/interfaces/experimental_patterns.GuKinesisLambdaProps.html
+++ b/interfaces/experimental_patterns.GuKinesisLambdaProps.html
@@ -18,7 +18,7 @@
 
    If your team do not use CloudWatch, it's possible to opt-out with the following configuration:
    
 
     monitoringConfiguration: { noMonitoring: true } as NoMonitoring
 
    
-
    interface GuKinesisLambdaProps { 
        adotInstrumentation?: AdotInstrumentationConfig; 
        allowAllOutbound?: boolean; 
        allowPublicSubnet?: boolean; 
        app: string; 
        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; 
        kinesisStreamProps?: StreamProps; 
        layers?: ILayerVersion[]; 
        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; 
        reservedConcurrentExecutions?: number; 
        retryAttempts?: number; 
        role?: IRole; 
        runtime: Runtime; 
        runtimeManagementMode?: RuntimeManagementMode; 
        securityGroups?: ISecurityGroup[]; 
        snapStart?: SnapStartConf; 
        throttlingMonitoring?: GuLambdaThrottlingMonitoringProps; 
        timeout?: Duration; 
        tracing?: Tracing; 
        vpc?: IVpc; 
        vpcSubnets?: SubnetSelection; 
        withoutArtifactUpload?: boolean; 
        withoutFilePrefix?: boolean; 
    }
    Hierarchy
    Properties
    adotInstrumentation?
+
    interface GuKinesisLambdaProps { 
        adotInstrumentation?: AdotInstrumentationConfig; 
        allowAllOutbound?: boolean; 
        allowPublicSubnet?: boolean; 
        app: string; 
        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; 
        kinesisStreamProps?: StreamProps; 
        layers?: ILayerVersion[]; 
        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; 
        reservedConcurrentExecutions?: number; 
        retryAttempts?: number; 
        role?: IRole; 
        runtime: Runtime; 
        runtimeManagementMode?: RuntimeManagementMode; 
        securityGroups?: ISecurityGroup[]; 
        snapStart?: SnapStartConf; 
        throttlingMonitoring?: GuLambdaThrottlingMonitoringProps; 
        timeout?: Duration; 
        tracing?: Tracing; 
        vpc?: IVpc; 
        vpcSubnets?: SubnetSelection; 
        withoutArtifactUpload?: boolean; 
        withoutFilePrefix?: boolean; 
    }
    Hierarchy
    Properties
    adotInstrumentation?
 allowAllOutbound?
 allowPublicSubnet?
 app
@@ -85,7 +85,7 @@ 
    Default
    - 
    See
    https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841
    
 
    Default
    false
 
    
-
    app
    app: string
    Optional Readonly architecture
    architecture?: Architecture
    The system architectures compatible with this lambda function.
    
+
    app
    app: string
    Optional Readonly architecture
    architecture?: Architecture
    The system architectures compatible with this lambda function.
    
 
    Default
    Architecture.X86_64
 
    
 
    Optional bucketNamePath
    bucketNamePath?: string
    SSM parameter for the S3 bucket that contains your lambda file.
    
@@ -93,7 +93,7 @@ 
    Default
    false
 you are referencing a file that is shared across many apps and/or AWS
 accounts.
    
 
    Default Value
    [[GuDistributionBucketParameter]]
    
-
    Optional Readonly codeSigningConfig
    codeSigningConfig?: ICodeSigningConfig
    Code signing config associated with this function
    
+
    Optional Readonly codeSigningConfig
    codeSigningConfig?: ICodeSigningConfig
    Code signing config associated with this function
    
 
    Default
    - Not Sign the Code
 
    
 
    Optional Readonly currentVersionOptions
    currentVersionOptions?: VersionOptions
    Options for the lambda.Version resource automatically created by the
@@ -123,7 +123,7 @@ 
    Default
    false
 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 Readonly environment
    environment?: { 
        [key: string]: string; 
    }
    Key-value pairs that Lambda caches and makes available for your Lambda
+
    Optional Readonly environment
    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.
    
@@ -135,13 +135,13 @@ 
    Default
    false
 
    Optional Readonly ephemeralStorageSize
    ephemeralStorageSize?: Size
    The size of the function’s /tmp directory in MiB.
    
 
    Default
    512 MiB
 
    
-
    errorHandlingConfiguration
    errorHandlingConfiguration: StreamErrorHandlingProps
    Optional Readonly events
    events?: IEventSource[]
    Event sources for this function.
    
+
    errorHandlingConfiguration
    errorHandlingConfiguration: StreamErrorHandlingProps
    Optional Readonly events
    events?: IEventSource[]
    Event sources for this function.
    
 
    You can also add event sources using addEventSource.
    
 
    Default
    - No event sources.
 
    
-
    Optional existingKinesisStream
    existingKinesisStream?: ExistingKinesisStream
    fileName
    fileName: string
    The filename for an executable package within the bucket [[GuDistributionBucketParameter]].
+
    Optional existingKinesisStream
    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 Readonly filesystem
    filesystem?: FileSystem
    The filesystem configuration for the lambda function
    
+
    Optional Readonly filesystem
    filesystem?: FileSystem
    The filesystem configuration for the lambda function
    
 
    Default
    - will not mount any filesystem
 
    
 
    Optional Readonly functionName
    functionName?: string
    A name for the function.
    
@@ -170,7 +170,7 @@ 
    Default
    false
 
 
    Default
    - No Lambda Insights
 
    
-
    Optional kinesisStreamProps
    kinesisStreamProps?: StreamProps
    Optional Readonly layers
    layers?: ILayerVersion[]
    A list of layers to add to the function's execution environment. You can configure your Lambda function to pull in
+
    Optional kinesisStreamProps
    kinesisStreamProps?: StreamProps
    Optional Readonly layers
    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.
@@ -200,7 +200,7 @@ 
    Default
    - 
 
    Default
    128
 
    
-
    monitoringConfiguration
    monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring
    Optional Readonly onFailure
    onFailure?: IDestination
    The destination for failed invocations.
    
+
    monitoringConfiguration
    monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring
    Optional Readonly onFailure
    onFailure?: IDestination
    The destination for failed invocations.
    
 
    Default
    - no destination
 
    
 
    Optional Readonly onSuccess
    onSuccess?: IDestination
    The destination for successful invocations.
    
@@ -213,7 +213,7 @@ 
    Default
    - 
 
    Default
    - No Parameters and Secrets Extension
 
    
-
    Optional processingProps
    processingProps?: StreamProcessingProps
    Optional Readonly profiling
    profiling?: boolean
    Enable profiling.
    
+
    Optional processingProps
    processingProps?: StreamProcessingProps
    Optional Readonly profiling
    profiling?: boolean
    Enable profiling.
    
 
    See
    https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html
    
 
    Default
    - No profiling.
 
    
@@ -262,7 +262,7 @@ 
    See
    See
    https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html
    
-
    Optional Readonly timeout
    timeout?: Duration
    The function execution time (in seconds) after which Lambda terminates
+
    Optional Readonly timeout
    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)
@@ -286,8 +286,8 @@ 
    See
    Optional withoutFilePrefix
    withoutFilePrefix?: boolean
    Set to true to use the filename without the stage/stack/app prefix.
    
+
    Optional withoutFilePrefix
    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
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
+
    Settings
    Member Visibility
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/interfaces/experimental_patterns.GuSnsLambdaProps.html b/interfaces/experimental_patterns.GuSnsLambdaProps.html
index 94a205526c..6e6b2bd0b0 100644
--- a/interfaces/experimental_patterns.GuSnsLambdaProps.html
+++ b/interfaces/experimental_patterns.GuSnsLambdaProps.html
@@ -12,7 +12,7 @@
 
    If your team do not use CloudWatch, it's possible to opt-out with the following configuration:
    
 
     monitoringConfiguration: { noMonitoring: true } as NoMonitoring
 
    
-
    interface GuSnsLambdaProps { 
        adotInstrumentation?: AdotInstrumentationConfig; 
        allowAllOutbound?: boolean; 
        allowPublicSubnet?: boolean; 
        app: string; 
        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; 
        layers?: ILayerVersion[]; 
        logRetention?: RetentionDays; 
        logRetentionRetryOptions?: LogRetentionRetryOptions; 
        logRetentionRole?: IRole; 
        maxEventAge?: Duration; 
        memorySize?: number; 
        monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring; 
        onFailure?: IDestination; 
        onSuccess?: IDestination; 
        paramsAndSecrets?: ParamsAndSecretsLayerVersion; 
        profiling?: boolean; 
        profilingGroup?: IProfilingGroup; 
        reservedConcurrentExecutions?: number; 
        retryAttempts?: number; 
        role?: IRole; 
        runtime: Runtime; 
        runtimeManagementMode?: RuntimeManagementMode; 
        securityGroups?: ISecurityGroup[]; 
        snapStart?: SnapStartConf; 
        throttlingMonitoring?: GuLambdaThrottlingMonitoringProps; 
        timeout?: Duration; 
        tracing?: Tracing; 
        vpc?: IVpc; 
        vpcSubnets?: SubnetSelection; 
        withoutArtifactUpload?: boolean; 
        withoutFilePrefix?: boolean; 
    }
    Hierarchy
    Properties
    adotInstrumentation?
+
    interface GuSnsLambdaProps { 
        adotInstrumentation?: AdotInstrumentationConfig; 
        allowAllOutbound?: boolean; 
        allowPublicSubnet?: boolean; 
        app: string; 
        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; 
        layers?: ILayerVersion[]; 
        logRetention?: RetentionDays; 
        logRetentionRetryOptions?: LogRetentionRetryOptions; 
        logRetentionRole?: IRole; 
        maxEventAge?: Duration; 
        memorySize?: number; 
        monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring; 
        onFailure?: IDestination; 
        onSuccess?: IDestination; 
        paramsAndSecrets?: ParamsAndSecretsLayerVersion; 
        profiling?: boolean; 
        profilingGroup?: IProfilingGroup; 
        reservedConcurrentExecutions?: number; 
        retryAttempts?: number; 
        role?: IRole; 
        runtime: Runtime; 
        runtimeManagementMode?: RuntimeManagementMode; 
        securityGroups?: ISecurityGroup[]; 
        snapStart?: SnapStartConf; 
        throttlingMonitoring?: GuLambdaThrottlingMonitoringProps; 
        timeout?: Duration; 
        tracing?: Tracing; 
        vpc?: IVpc; 
        vpcSubnets?: SubnetSelection; 
        withoutArtifactUpload?: boolean; 
        withoutFilePrefix?: boolean; 
    }
    Hierarchy
    Properties
    adotInstrumentation?
 allowAllOutbound?
 allowPublicSubnet?
 app
@@ -76,7 +76,7 @@ 
    Default
    - 
    See
    https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841
    
 
    Default
    false
 
    
-
    app
    app: string
    Optional Readonly architecture
    architecture?: Architecture
    The system architectures compatible with this lambda function.
    
+
    app
    app: string
    Optional Readonly architecture
    architecture?: Architecture
    The system architectures compatible with this lambda function.
    
 
    Default
    Architecture.X86_64
 
    
 
    Optional bucketNamePath
    bucketNamePath?: string
    SSM parameter for the S3 bucket that contains your lambda file.
    
@@ -84,7 +84,7 @@ 
    Default
    false
 you are referencing a file that is shared across many apps and/or AWS
 accounts.
    
 
    Default Value
    [[GuDistributionBucketParameter]]
    
-
    Optional Readonly codeSigningConfig
    codeSigningConfig?: ICodeSigningConfig
    Code signing config associated with this function
    
+
    Optional Readonly codeSigningConfig
    codeSigningConfig?: ICodeSigningConfig
    Code signing config associated with this function
    
 
    Default
    - Not Sign the Code
 
    
 
    Optional Readonly currentVersionOptions
    currentVersionOptions?: VersionOptions
    Options for the lambda.Version resource automatically created by the
@@ -114,7 +114,7 @@ 
    Default
    false
 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 Readonly environment
    environment?: { 
        [key: string]: string; 
    }
    Key-value pairs that Lambda caches and makes available for your Lambda
+
    Optional Readonly environment
    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.
    
@@ -130,9 +130,9 @@ 
    Default
    false
 
    You can also add event sources using addEventSource.
    
 
    Default
    - No event sources.
 
    
-
    Optional existingSnsTopic
    existingSnsTopic?: ExistingSnsTopic
    fileName
    fileName: string
    The filename for an executable package within the bucket [[GuDistributionBucketParameter]].
+
    Optional existingSnsTopic
    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 Readonly filesystem
    filesystem?: FileSystem
    The filesystem configuration for the lambda function
    
+
    Optional Readonly filesystem
    filesystem?: FileSystem
    The filesystem configuration for the lambda function
    
 
    Default
    - will not mount any filesystem
 
    
 
    Optional Readonly functionName
    functionName?: string
    A name for the function.
    
@@ -191,7 +191,7 @@ 
    Default
    - 
 
    Default
    128
 
    
-
    monitoringConfiguration
    monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring
    Optional Readonly onFailure
    onFailure?: IDestination
    The destination for failed invocations.
    
+
    monitoringConfiguration
    monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring
    Optional Readonly onFailure
    onFailure?: IDestination
    The destination for failed invocations.
    
 
    Default
    - no destination
 
    
 
    Optional Readonly onSuccess
    onSuccess?: IDestination
    The destination for successful invocations.
    
@@ -253,7 +253,7 @@ 
    See
    See
    https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html
    
-
    Optional Readonly timeout
    timeout?: Duration
    The function execution time (in seconds) after which Lambda terminates
+
    Optional Readonly timeout
    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)
@@ -277,8 +277,8 @@ 
    See
    Optional withoutFilePrefix
    withoutFilePrefix?: boolean
    Set to true to use the filename without the stage/stack/app prefix.
    
+
    Optional withoutFilePrefix
    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
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
+

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/patterns.AccessLoggingProps.html b/interfaces/patterns.AccessLoggingProps.html index 1b7c8bbf75..d6a0a4d31c 100644 --- a/interfaces/patterns.AccessLoggingProps.html +++ b/interfaces/patterns.AccessLoggingProps.html @@ -1,10 +1,10 @@ -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

    -

    Optional prefix

    prefix?: string

    S3 prefix for the logs.

    +

    Optional prefix

    prefix?: string

    S3 prefix for the logs.

    Default Value

    no prefix
    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/patterns.Alarms.html b/interfaces/patterns.Alarms.html index 084da43b5c..a016a21aa8 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

    Optional http4xxAlarm

    http4xxAlarm?: false | Http4xxAlarmProps

    Enable the 4xx alarm with settings.

    -

    http5xxAlarm

    http5xxAlarm: false | Http5xxAlarmProps

    Enable the 5xx alarm with settings.

    -

    Optional noMonitoring

    noMonitoring?: false

    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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    http5xxAlarm

    http5xxAlarm: false | Http5xxAlarmProps

    Enable the 5xx alarm with settings.

    +

    Optional noMonitoring

    noMonitoring?: false

    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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/patterns.ApiGatewayAlarms.html b/interfaces/patterns.ApiGatewayAlarms.html index c6cd6a0f86..1c63236a64 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.

    -

    Optional noMonitoring

    noMonitoring?: false

    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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional noMonitoring

    noMonitoring?: false

    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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/patterns.ApiTarget.html b/interfaces/patterns.ApiTarget.html index aca681651b..db749af92d 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

    Optional apiKeyRequired

    apiKeyRequired?: true

    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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/patterns.ApplicationLoggingProps.html b/interfaces/patterns.ApplicationLoggingProps.html index b9b5ecf4c4..95d93cf844 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

    -

    Optional systemdUnitName

    systemdUnitName?: string

    This needs to match the name of your SystemD unit.

    +

    Optional systemdUnitName

    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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/patterns.GuApiGatewayWithLambdaByPathProps.html b/interfaces/patterns.GuApiGatewayWithLambdaByPathProps.html index 813e545670..dbb1f59c5b 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

    • 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

    • RestApiProps
    • AppIdentity
      • GuApiGatewayWithLambdaByPathProps

    Properties

    apiKeySourceType? app binaryMediaTypes? cloneFrom? @@ -28,7 +28,7 @@ plan.

    Default

    - Metering is disabled.
    -

    app

    app: string

    Optional Readonly binaryMediaTypes

    binaryMediaTypes?: string[]

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

    app

    app: string

    Optional Readonly binaryMediaTypes

    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.
    @@ -130,7 +130,7 @@

    Deprecated

      If your team do not use CloudWatch, it's possible to opt-out with the following configuration:

       monitoringConfiguration: { noMonitoring: true }
      -

    Optional Readonly parameters

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

    Custom header parameters for the request.

    +

    Optional Readonly parameters

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

    Custom header parameters for the request.

    Type declaration

    • [key: string]: string

    See

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

    Default

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

    Default

    - 
    Default
    false

    targets

    targets: ApiTarget[]

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/patterns.GuApiLambdaProps.html b/interfaces/patterns.GuApiLambdaProps.html index 21730cfb47..f8a16adc4e 100644 --- a/interfaces/patterns.GuApiLambdaProps.html +++ b/interfaces/patterns.GuApiLambdaProps.html @@ -1,4 +1,4 @@ -GuApiLambdaProps | @guardian/cdk

    Interface GuApiLambdaProps

    interface GuApiLambdaProps {
        adotInstrumentation?: AdotInstrumentationConfig;
        allowAllOutbound?: boolean;
        allowPublicSubnet?: boolean;
        api: ApiProps;
        app: string;
        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;
        layers?: ILayerVersion[];
        logRetention?: RetentionDays;
        logRetentionRetryOptions?: LogRetentionRetryOptions;
        logRetentionRole?: IRole;
        maxEventAge?: Duration;
        memorySize?: number;
        monitoringConfiguration: NoMonitoring | ApiGatewayAlarms;
        onFailure?: IDestination;
        onSuccess?: IDestination;
        paramsAndSecrets?: ParamsAndSecretsLayerVersion;
        profiling?: boolean;
        profilingGroup?: IProfilingGroup;
        reservedConcurrentExecutions?: number;
        retryAttempts?: number;
        role?: IRole;
        runtime: Runtime;
        runtimeManagementMode?: RuntimeManagementMode;
        securityGroups?: ISecurityGroup[];
        snapStart?: SnapStartConf;
        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;
        allowAllOutbound?: boolean;
        allowPublicSubnet?: boolean;
        api: ApiProps;
        app: string;
        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;
        layers?: ILayerVersion[];
        logRetention?: RetentionDays;
        logRetentionRetryOptions?: LogRetentionRetryOptions;
        logRetentionRole?: IRole;
        maxEventAge?: Duration;
        memorySize?: number;
        monitoringConfiguration: NoMonitoring | ApiGatewayAlarms;
        onFailure?: IDestination;
        onSuccess?: IDestination;
        paramsAndSecrets?: ParamsAndSecretsLayerVersion;
        profiling?: boolean;
        profilingGroup?: IProfilingGroup;
        reservedConcurrentExecutions?: number;
        retryAttempts?: number;
        role?: IRole;
        runtime: Runtime;
        runtimeManagementMode?: RuntimeManagementMode;
        securityGroups?: ISecurityGroup[];
        snapStart?: SnapStartConf;
        throttlingMonitoring?: GuLambdaThrottlingMonitoringProps;
        timeout?: Duration;
        tracing?: Tracing;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection;
        withoutArtifactUpload?: boolean;
        withoutFilePrefix?: boolean;
    }

    Hierarchy

    Properties

    adotInstrumentation? allowAllOutbound? allowPublicSubnet? api @@ -63,7 +63,7 @@

    Default

    - Default
    false

    api

    api: ApiProps

    [[LambdaRestApiProps]] to configure for the lambda.

    -

    app

    app: string

    Optional Readonly architecture

    architecture?: Architecture

    The system architectures compatible with this lambda function.

    +

    app

    app: string

    Optional Readonly architecture

    architecture?: Architecture

    The system architectures compatible with this lambda function.

    Default

    Architecture.X86_64

    Optional bucketNamePath

    bucketNamePath?: string

    SSM parameter for the S3 bucket that contains your lambda file.

    @@ -71,7 +71,7 @@

    Default

    false
 you are referencing a file that is shared across many apps and/or AWS
 accounts.

    Default Value

    [[GuDistributionBucketParameter]]

    -

    Optional Readonly codeSigningConfig

    codeSigningConfig?: ICodeSigningConfig

    Code signing config associated with this function

    +

    Optional Readonly codeSigningConfig

    codeSigningConfig?: ICodeSigningConfig

    Code signing config associated with this function

    Default

    - Not Sign the Code

    Optional Readonly currentVersionOptions

    currentVersionOptions?: VersionOptions

    Options for the lambda.Version resource automatically created by the @@ -101,7 +101,7 @@

    Default

    false
 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 Readonly environment

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

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

    Optional Readonly environment

    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.

    @@ -119,7 +119,7 @@

    Default

    false

    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 Readonly filesystem

    filesystem?: FileSystem

    The filesystem configuration for the lambda function

    +

    Optional Readonly filesystem

    filesystem?: FileSystem

    The filesystem configuration for the lambda function

    Default

    - will not mount any filesystem

    Optional Readonly functionName

    functionName?: string

    A name for the function.

    @@ -182,7 +182,7 @@

    Default

    - If your team do not use CloudWatch, it's possible to opt-out with the following configuration:
    
 
     monitoringConfiguration: { noMonitoring: true }
 
    
-

    Optional Readonly onFailure

    onFailure?: IDestination

    The destination for failed invocations.

    +

    Optional Readonly onFailure

    onFailure?: IDestination

    The destination for failed invocations.

    Default

    - no destination

    Optional Readonly onSuccess

    onSuccess?: IDestination

    The destination for successful invocations.

    @@ -244,7 +244,7 @@

    See

    See

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

    -

    Optional Readonly timeout

    timeout?: Duration

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

    Optional Readonly timeout

    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)
@@ -268,8 +268,8 @@ 
    See

    Optional withoutFilePrefix

    withoutFilePrefix?: boolean

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

    +

    Optional withoutFilePrefix

    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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/patterns.GuEc2AppProps.html b/interfaces/patterns.GuEc2AppProps.html index e631cac88d..685062c804 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;
        googleAuth?: {
            allowedGroups?: 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;
        userData: string | GuUserDataProps;
        vpc?: IVpc;
        withoutImdsv2?: boolean;
    }

    Hierarchy

    Properties

    access +GuEc2AppProps | @guardian/cdk

    Interface GuEc2AppProps

    interface GuEc2AppProps {
        access: AppAccess;
        accessLogging?: AccessLoggingProps;
        app: string;
        applicationLogging?: ApplicationLoggingProps;
        applicationPort: number;
        blockDevices?: BlockDevice[];
        certificateProps?: GuDomainName;
        googleAuth?: {
            allowedGroups?: 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;
        userData: string | GuUserDataProps;
        vpc?: IVpc;
        withoutImdsv2?: boolean;
    }

    Hierarchy

    Properties

    access accessLogging? app applicationLogging? @@ -22,12 +22,12 @@

    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.

    -

    Optional accessLogging

    accessLogging?: AccessLoggingProps

    Enable and configures access logs.

    -

    app

    app: string

    Optional applicationLogging

    applicationLogging?: ApplicationLoggingProps

    Enable and configures application logs.

    -

    applicationPort

    applicationPort: number

    The port your application runs on.

    -

    Optional blockDevices

    blockDevices?: BlockDevice[]

    Add block devices (additional storage).

    -

    Optional certificateProps

    certificateProps?: GuDomainName

    Specify certificate for the load balancer.

    -

    Optional googleAuth

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

    Configure Google Auth.

    +

    Optional accessLogging

    accessLogging?: AccessLoggingProps

    Enable and configures access logs.

    +

    app

    app: string

    Optional applicationLogging

    applicationLogging?: ApplicationLoggingProps

    Enable and configures application logs.

    +

    applicationPort

    applicationPort: number

    The port your application runs on.

    +

    Optional blockDevices

    blockDevices?: BlockDevice[]

    Add block devices (additional storage).

    +

    Optional certificateProps

    certificateProps?: GuDomainName

    Specify certificate for the load balancer.

    +

    Optional googleAuth

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

    Configure Google Auth.

    Type declaration

    • Optional allowedGroups?: string[]

      Groups used for membership checks.

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

      @@ -61,23 +61,23 @@

      Default Value

      /:STAGE
 
      NOTE: This value cannot be larger than 60 minutes.

      Default Value

      15
      -

    Optional healthcheck

    healthcheck?: HealthCheck

    Specify custom healthcheck

    -

    Optional imageRecipe

    imageRecipe?: string | AmigoProps

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

    -

    Optional instanceMetadataHopLimit

    instanceMetadataHopLimit?: number

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

    Optional healthcheck

    healthcheck?: HealthCheck

    Specify custom healthcheck

    +

    Optional imageRecipe

    imageRecipe?: string | AmigoProps

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

    +

    Optional instanceMetadataHopLimit

    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.

    -

    Optional privateSubnets

    privateSubnets?: ISubnet[]

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

    monitoringConfiguration

    monitoringConfiguration: NoMonitoring | Alarms

    Enable and configure alarms.

    +

    Optional privateSubnets

    privateSubnets?: ISubnet[]

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

    -

    Optional publicSubnets

    publicSubnets?: ISubnet[]

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

    Optional publicSubnets

    publicSubnets?: ISubnet[]

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

    -

    Optional roleConfiguration

    roleConfiguration?: GuInstanceRoleProps

    Configure IAM roles for autoscaling group EC2 instances.

    -

    scaling

    scaling: GuAsgCapacity

    Autoscaling group min and max sizes.

    -

    userData

    userData: string | GuUserDataProps

    User data for the autoscaling group.

    -

    Optional vpc

    vpc?: IVpc

    Specify the VPC to use.

    +

    Optional roleConfiguration

    roleConfiguration?: GuInstanceRoleProps

    Configure IAM roles for autoscaling group EC2 instances.

    +

    scaling

    scaling: GuAsgCapacity

    Autoscaling group min and max sizes.

    +

    userData

    userData: string | GuUserDataProps

    User data for the autoscaling group.

    +

    Optional vpc

    vpc?: IVpc

    Specify the VPC to use.

    See

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

    -

    Optional withoutImdsv2

    withoutImdsv2?: boolean

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

    +

    Optional withoutImdsv2

    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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/patterns.GuScheduledEcsTaskProps.html b/interfaces/patterns.GuScheduledEcsTaskProps.html index 0c33dfde8f..499d96a366 100644 --- a/interfaces/patterns.GuScheduledEcsTaskProps.html +++ b/interfaces/patterns.GuScheduledEcsTaskProps.html @@ -27,7 +27,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;
        containerConfiguration: ContainerConfiguration;
        cpu?: number;
        customTaskPolicies?: PolicyStatement[];
        enableDistributablePolicy?: boolean;
        environmentOverrides?: TaskEnvironmentVariable[];
        memory?: number;
        monitoringConfiguration: NoMonitoring | GuEcsTaskMonitoringProps;
        schedule: Schedule;
        securityGroups?: ISecurityGroup[];
        storage?: number;
        taskCommand?: string;
        taskTimeoutInMinutes?: number;
        vpc: IVpc;
    }

    Hierarchy

    Properties

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

    Hierarchy

    Properties

    app containerConfiguration cpu? customTaskPolicies? @@ -41,14 +41,14 @@ taskCommand? taskTimeoutInMinutes? vpc -

    Properties

    app

    app: string

    containerConfiguration

    containerConfiguration: ContainerConfiguration

    Optional cpu

    cpu?: number

    Optional customTaskPolicies

    customTaskPolicies?: PolicyStatement[]

    Optional enableDistributablePolicy

    enableDistributablePolicy?: boolean

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

    Properties

    app

    app: string

    containerConfiguration

    containerConfiguration: ContainerConfiguration

    Optional cpu

    cpu?: number

    Optional customTaskPolicies

    customTaskPolicies?: PolicyStatement[]

    Optional enableDistributablePolicy

    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.

    -

    Optional environmentOverrides

    environmentOverrides?: TaskEnvironmentVariable[]

    Optional memory

    memory?: number

    monitoringConfiguration

    monitoringConfiguration: NoMonitoring | GuEcsTaskMonitoringProps

    schedule

    schedule: Schedule

    Schedule for the task.

    +

    Optional environmentOverrides

    environmentOverrides?: TaskEnvironmentVariable[]

    Optional memory

    memory?: number

    monitoringConfiguration

    monitoringConfiguration: NoMonitoring | GuEcsTaskMonitoringProps

    schedule

    schedule: Schedule

    Schedule for the task.

    E.g.:

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

    Optional securityGroups

    securityGroups?: ISecurityGroup[]

    Optional storage

    storage?: number

    Optional taskCommand

    taskCommand?: string

    Optional taskTimeoutInMinutes

    taskTimeoutInMinutes?: number

    vpc

    vpc: IVpc

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional securityGroups

    securityGroups?: ISecurityGroup[]

    Optional storage

    storage?: number

    Optional taskCommand

    taskCommand?: string

    Optional taskTimeoutInMinutes

    taskTimeoutInMinutes?: number

    vpc

    vpc: IVpc

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/patterns.GuScheduledLambdaProps.html b/interfaces/patterns.GuScheduledLambdaProps.html index d71f0d6284..9c0b48941b 100644 --- a/interfaces/patterns.GuScheduledLambdaProps.html +++ b/interfaces/patterns.GuScheduledLambdaProps.html @@ -1,4 +1,4 @@ -GuScheduledLambdaProps | @guardian/cdk

    Interface GuScheduledLambdaProps

    interface GuScheduledLambdaProps {
        adotInstrumentation?: AdotInstrumentationConfig;
        allowAllOutbound?: boolean;
        allowPublicSubnet?: boolean;
        app: string;
        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;
        layers?: ILayerVersion[];
        logRetention?: RetentionDays;
        logRetentionRetryOptions?: LogRetentionRetryOptions;
        logRetentionRole?: IRole;
        maxEventAge?: Duration;
        memorySize?: number;
        monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring;
        onFailure?: IDestination;
        onSuccess?: IDestination;
        paramsAndSecrets?: ParamsAndSecretsLayerVersion;
        profiling?: boolean;
        profilingGroup?: IProfilingGroup;
        reservedConcurrentExecutions?: number;
        retryAttempts?: number;
        role?: IRole;
        rules: {
            description?: string;
            schedule: Schedule;
        }[];
        runtime: Runtime;
        runtimeManagementMode?: RuntimeManagementMode;
        securityGroups?: ISecurityGroup[];
        snapStart?: SnapStartConf;
        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;
        allowAllOutbound?: boolean;
        allowPublicSubnet?: boolean;
        app: string;
        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;
        layers?: ILayerVersion[];
        logRetention?: RetentionDays;
        logRetentionRetryOptions?: LogRetentionRetryOptions;
        logRetentionRole?: IRole;
        maxEventAge?: Duration;
        memorySize?: number;
        monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring;
        onFailure?: IDestination;
        onSuccess?: IDestination;
        paramsAndSecrets?: ParamsAndSecretsLayerVersion;
        profiling?: boolean;
        profilingGroup?: IProfilingGroup;
        reservedConcurrentExecutions?: number;
        retryAttempts?: number;
        role?: IRole;
        rules: {
            description?: string;
            schedule: Schedule;
        }[];
        runtime: Runtime;
        runtimeManagementMode?: RuntimeManagementMode;
        securityGroups?: ISecurityGroup[];
        snapStart?: SnapStartConf;
        throttlingMonitoring?: GuLambdaThrottlingMonitoringProps;
        timeout?: Duration;
        tracing?: Tracing;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection;
        withoutArtifactUpload?: boolean;
        withoutFilePrefix?: boolean;
    }

    Hierarchy

    Properties

    adotInstrumentation? allowAllOutbound? allowPublicSubnet? app @@ -62,7 +62,7 @@

    Default

    - 
    See
    https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841
    
 
    Default
    false
 
    
-

    app

    app: string

    Optional Readonly architecture

    architecture?: Architecture

    The system architectures compatible with this lambda function.

    +

    app

    app: string

    Optional Readonly architecture

    architecture?: Architecture

    The system architectures compatible with this lambda function.

    Default

    Architecture.X86_64

    Optional bucketNamePath

    bucketNamePath?: string

    SSM parameter for the S3 bucket that contains your lambda file.

    @@ -70,7 +70,7 @@

    Default

    false
 you are referencing a file that is shared across many apps and/or AWS
 accounts.

    Default Value

    [[GuDistributionBucketParameter]]

    -

    Optional Readonly codeSigningConfig

    codeSigningConfig?: ICodeSigningConfig

    Code signing config associated with this function

    +

    Optional Readonly codeSigningConfig

    codeSigningConfig?: ICodeSigningConfig

    Code signing config associated with this function

    Default

    - Not Sign the Code

    Optional Readonly currentVersionOptions

    currentVersionOptions?: VersionOptions

    Options for the lambda.Version resource automatically created by the @@ -100,7 +100,7 @@

    Default

    false
 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 Readonly environment

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

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

    Optional Readonly environment

    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.

    @@ -118,7 +118,7 @@

    Default

    false

    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 Readonly filesystem

    filesystem?: FileSystem

    The filesystem configuration for the lambda function

    +

    Optional Readonly filesystem

    filesystem?: FileSystem

    The filesystem configuration for the lambda function

    Default

    - will not mount any filesystem

    Optional Readonly functionName

    functionName?: string

    A name for the function.

    @@ -179,7 +179,7 @@

    Default

    -

    monitoringConfiguration

    monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring

    Monitoring configuration for the lambda.

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

    -

    Optional Readonly onFailure

    onFailure?: IDestination

    The destination for failed invocations.

    +

    Optional Readonly onFailure

    onFailure?: IDestination

    The destination for failed invocations.

    Default

    - no destination

    Optional Readonly onSuccess

    onSuccess?: IDestination

    The destination for successful invocations.

    @@ -229,7 +229,7 @@

    See

    Readonly runtime

    runtime: Runtime

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

    Readonly runtime

    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.

    @@ -248,7 +248,7 @@

    See

    See

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

    -

    Optional Readonly timeout

    timeout?: Duration

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

    Optional Readonly timeout

    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)
@@ -272,8 +272,8 @@ 
    See

    Optional withoutFilePrefix

    withoutFilePrefix?: boolean

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

    +

    Optional withoutFilePrefix

    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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/types.Access.html b/interfaces/types.Access.html index ccc2d0abea..b3a5121169 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

    Properties

    scope -

    Properties

    scope

    scope: AccessScope

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +Access | @guardian/cdk

    Interface Access

    interface Access {
        scope: AccessScope;
    }

    Hierarchy

    Properties

    scope +

    Properties

    scope

    scope: AccessScope

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/types.GuAsgCapacity.html b/interfaces/types.GuAsgCapacity.html index 72fa3e059a..36c4370f43 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

    Properties

    maximumInstances? +GuAsgCapacity | @guardian/cdk

    Interface GuAsgCapacity

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

    Hierarchy

    Properties

    maximumInstances? minimumInstances

    Properties

    Optional maximumInstances

    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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/types.GuDistributable.html b/interfaces/types.GuDistributable.html index c3f0e75b9c..db8258934c 100644 --- a/interfaces/types.GuDistributable.html +++ b/interfaces/types.GuDistributable.html @@ -1,4 +1,4 @@ -GuDistributable | @guardian/cdk

    Interface GuDistributable

    interface GuDistributable {
        fileName: string;
    }

    Properties

    fileName +GuDistributable | @guardian/cdk

    Interface GuDistributable

    interface GuDistributable {
        fileName: string;
    }

    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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/types.GuDistributableForEc2.html b/interfaces/types.GuDistributableForEc2.html index d058ef27b3..78dea0c83f 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

    Properties

    executionStatement +GuDistributableForEc2 | @guardian/cdk

    Interface GuDistributableForEc2

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

    Hierarchy

    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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/types.GuDomainName.html b/interfaces/types.GuDomainName.html index 9dacb204f6..1126d595cd 100644 --- a/interfaces/types.GuDomainName.html +++ b/interfaces/types.GuDomainName.html @@ -1,8 +1,8 @@ -GuDomainName | @guardian/cdk

    Interface GuDomainName

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

    Hierarchy

    Properties

    domainName +GuDomainName | @guardian/cdk

    Interface GuDomainName

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

    Hierarchy

    Properties

    domainName hostedZoneId?

    Properties

    domainName

    domainName: string

    The Fully Qualified Domain Name.

    Example

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

    Optional hostedZoneId

    hostedZoneId?: string

    Route53 Zone ID.

    +

    Optional hostedZoneId

    hostedZoneId?: string

    Route53 Zone ID.

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/types.InternalAccess.html b/interfaces/types.InternalAccess.html index 3f48c0a371..c167a6bff6 100644 --- a/interfaces/types.InternalAccess.html +++ b/interfaces/types.InternalAccess.html @@ -4,6 +4,6 @@

    Example usage:

    {
      scope: AccessScope.INTERNAL,
      cidrRanges: [Peer.ipv4("10.0.0.0/8")]
    }
    -
    interface InternalAccess {
        cidrRanges: IPeer[];
        scope: INTERNAL;
    }

    Hierarchy

    Properties

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

    Hierarchy

    Properties

    cidrRanges scope -

    Properties

    cidrRanges

    cidrRanges: IPeer[]

    scope

    scope: INTERNAL

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    cidrRanges

    cidrRanges: IPeer[]

    scope

    scope: INTERNAL

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/types.PublicAccess.html b/interfaces/types.PublicAccess.html index 1614a37c46..3747509766 100644 --- a/interfaces/types.PublicAccess.html +++ b/interfaces/types.PublicAccess.html @@ -4,5 +4,5 @@

    Example usage:

    { scope: AccessScope.PUBLIC }
    -
    interface PublicAccess {
        scope: PUBLIC;
    }

    Hierarchy

    Properties

    scope -

    Properties

    scope

    scope: PUBLIC

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
    interface PublicAccess {
        scope: PUBLIC;
    }

    Hierarchy

    Properties

    scope +

    Properties

    scope

    scope: PUBLIC

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/types.RestrictedAccess.html b/interfaces/types.RestrictedAccess.html index 55181e49f4..6d481f7d46 100644 --- a/interfaces/types.RestrictedAccess.html +++ b/interfaces/types.RestrictedAccess.html @@ -3,6 +3,6 @@

    Example usage:

    {
      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

    Properties

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

    Hierarchy

    Properties

    cidrRanges scope -

    Properties

    cidrRanges

    cidrRanges: IPeer[]

    scope

    scope: RESTRICTED

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    cidrRanges

    cidrRanges: IPeer[]

    scope

    scope: RESTRICTED

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/utils_ec2.GuPrivateS3ConfigurationProps.html b/interfaces/utils_ec2.GuPrivateS3ConfigurationProps.html index 1c06812816..b054a408ca 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

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    bucket

    bucket: GuPrivateConfigBucketParameter

    files

    files: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/utils_lambda.StreamErrorHandlingProps.html b/interfaces/utils_lambda.StreamErrorHandlingProps.html index c129bcd2b8..3279c746c4 100644 --- a/interfaces/utils_lambda.StreamErrorHandlingProps.html +++ b/interfaces/utils_lambda.StreamErrorHandlingProps.html @@ -7,8 +7,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

    Optional blockProcessingAndRetryIndefinitely

    blockProcessingAndRetryIndefinitely?: false

    Optional deadLetterQueueForSkippedRecords

    deadLetterQueueForSkippedRecords?: IEventSourceDlq

    retryBehaviour

    retryBehaviour: StreamRetry

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    bisectBatchOnError

    bisectBatchOnError: boolean

    Optional blockProcessingAndRetryIndefinitely

    blockProcessingAndRetryIndefinitely?: false

    Optional deadLetterQueueForSkippedRecords

    deadLetterQueueForSkippedRecords?: IEventSourceDlq

    retryBehaviour

    retryBehaviour: StreamRetry

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/constants.html b/modules/constants.html index 3af02297cd..f05a545d56 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 463999e119..9babd0dbd2 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/constructs_autoscaling.html b/modules/constructs_autoscaling.html index 5220cc7e47..d250d45d3f 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 d61b2b02d4..8f836d4686 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 521c19acf0..0604fe98c7 100644 --- a/modules/constructs_core.html +++ b/modules/constructs_core.html @@ -1,4 +1,4 @@ -constructs/core | @guardian/cdk

    Module constructs/core

    Index

    Classes

    GuAmiParameter +constructs/core | @guardian/cdk

    Module constructs/core

    Index

    Classes

    GuAmiParameter GuAnghammaradTopicParameter GuArnParameter GuCertificateArnParameter diff --git a/modules/constructs_dns.html b/modules/constructs_dns.html index 15713406b0..6116d43d4b 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_ec2.html b/modules/constructs_ec2.html index 81a89d19b4..00287fc34c 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 98910c505e..36eaf9689d 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 5ee46249e9..004253951f 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 ad359cf448..30f57fedad 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/constructs_lambda.html b/modules/constructs_lambda.html index ad82c0cc54..658a2f8f20 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/constructs_loadbalancing.html b/modules/constructs_loadbalancing.html index 0e19f7cd78..97cf7d7c13 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 1eb1eb3d4b..97b4b5519d 100644 --- a/modules/constructs_rds.html +++ b/modules/constructs_rds.html @@ -1,3 +1,3 @@ -constructs/rds | @guardian/cdk

    Module constructs/rds

    Index

    Classes

    GuDatabaseInstance +constructs/rds | @guardian/cdk

    Module constructs/rds

    Index

    Classes

    GuDatabaseInstance

    Interfaces

    GuDatabaseInstanceProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/constructs_s3.html b/modules/constructs_s3.html index 5e49c29923..3d69737c4e 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/constructs_ses.html b/modules/constructs_ses.html index 37e633db71..6541c9d264 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/constructs_stack_set.html b/modules/constructs_stack_set.html index c6c686d510..8ccccfb07d 100644 --- a/modules/constructs_stack_set.html +++ b/modules/constructs_stack_set.html @@ -1,2 +1,2 @@ -constructs/stack-set | @guardian/cdk

    Module constructs/stack-set

    Index

    Classes

    GuStackSet +constructs/stack-set | @guardian/cdk

    Module constructs/stack-set

    Index

    Classes

    GuStackSet

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/constructs_vpc.html b/modules/constructs_vpc.html index 2d029ced36..86e445ac03 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/experimental_patterns.html b/modules/experimental_patterns.html index 517b11f49a..944df2d208 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 bd0c7b41bf..2950e1bf81 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 9dafdf6262..d1c65f8341 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 4592cdc711..298913b644 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/utils_lambda.html b/modules/utils_lambda.html index 8d61328843..0dc4802690 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 9b75fca988..57d4d445d3 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/utils_test.html b/modules/utils_test.html index 3ff8ed6c22..aca14c1b8e 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 simpleGuStackForTesting

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/constructs_acm.GuCertificatePropsWithApp.html b/types/constructs_acm.GuCertificatePropsWithApp.html index ecdd4a6163..9089086588 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GuCertificatePropsWithApp | @guardian/cdk

    Type alias GuCertificatePropsWithApp

    GuCertificatePropsWithApp: GuDomainName & AppIdentity

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/constructs_autoscaling.GuUserDataPropsWithApp.html b/types/constructs_autoscaling.GuUserDataPropsWithApp.html index d77358aad8..292ec3cf6d 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GuUserDataPropsWithApp | @guardian/cdk

    Type alias GuUserDataPropsWithApp

    GuUserDataPropsWithApp: GuUserDataProps & AppIdentity

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/constructs_core.GuNoTypeParameterProps.html b/types/constructs_core.GuNoTypeParameterProps.html index 521a195dab..a0eda522c0 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GuNoTypeParameterProps | @guardian/cdk

    Type alias GuNoTypeParameterProps

    GuNoTypeParameterProps: Omit<GuParameterProps, "type">

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/constructs_core.GuNoTypeParameterPropsWithAppIdentity.html b/types/constructs_core.GuNoTypeParameterPropsWithAppIdentity.html index 1c21217d64..6844dfa89b 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GuNoTypeParameterPropsWithAppIdentity | @guardian/cdk

    Type alias GuNoTypeParameterPropsWithAppIdentity

    GuNoTypeParameterPropsWithAppIdentity: Omit<GuParameterProps, "type"> & AppIdentity

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/constructs_ecs.ContainerConfiguration.html b/types/constructs_ecs.ContainerConfiguration.html index af640db4f9..73dd9bcc6d 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ContainerConfiguration | @guardian/cdk

    Type alias ContainerConfiguration

    ContainerConfiguration: RepositoryContainer | RegistryContainer

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/constructs_ecs.GuEcsTaskMonitoringProps.html b/types/constructs_ecs.GuEcsTaskMonitoringProps.html index 54cc996251..33fe731c0c 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;
    }

    Type declaration

    • noMonitoring: false
    • snsTopicArn: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GuEcsTaskMonitoringProps | @guardian/cdk

    Type alias GuEcsTaskMonitoringProps

    GuEcsTaskMonitoringProps: {
        noMonitoring: false;
        snsTopicArn: string;
    }

    Type declaration

    • noMonitoring: false
    • snsTopicArn: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/constructs_ecs.RegistryContainer.html b/types/constructs_ecs.RegistryContainer.html index e5ff1bbaf8..7bda760c50 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";
    }

    Type declaration

    • Optional id?: string
    • Optional imageProps?: RepositoryImageProps
    • type: "registry"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +RegistryContainer | @guardian/cdk

    Type alias RegistryContainer

    RegistryContainer: {
        id?: string;
        imageProps?: RepositoryImageProps;
        type: "registry";
    }

    Type declaration

    • Optional id?: string
    • Optional imageProps?: RepositoryImageProps
    • type: "registry"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/constructs_ecs.RepositoryContainer.html b/types/constructs_ecs.RepositoryContainer.html index ff136bd27c..7a0463a2bc 100644 --- a/types/constructs_ecs.RepositoryContainer.html +++ b/types/constructs_ecs.RepositoryContainer.html @@ -5,4 +5,4 @@

    Alternatively you can specify a repository and version, for example for an ECR repository:

    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'
    }
    -

    Type declaration

    • repository: IRepository
    • type: "repository"
    • version: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • repository: IRepository
    • type: "repository"
    • version: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/constructs_iam.GuDenyPolicyProps.html b/types/constructs_iam.GuDenyPolicyProps.html index 15e51ec93a..f307d768aa 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GuDenyPolicyProps | @guardian/cdk

    Type alias GuDenyPolicyProps

    GuDenyPolicyProps: GuAllowPolicyProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/constructs_iam.GuInstanceRolePropsWithApp.html b/types/constructs_iam.GuInstanceRolePropsWithApp.html index 2db1ede217..691566eec6 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GuInstanceRolePropsWithApp | @guardian/cdk

    Type alias GuInstanceRolePropsWithApp

    GuInstanceRolePropsWithApp: GuInstanceRoleProps & AppIdentity

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/constructs_iam.GuNoStatementsPolicyProps.html b/types/constructs_iam.GuNoStatementsPolicyProps.html index c2624726de..ff5c3c8cde 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GuNoStatementsPolicyProps | @guardian/cdk

    Type alias GuNoStatementsPolicyProps

    GuNoStatementsPolicyProps: Omit<GuPolicyProps, "statements">

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/constructs_iam.GuPolicyProps.html b/types/constructs_iam.GuPolicyProps.html index beaf1368a8..8592bd7035 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GuPolicyProps | @guardian/cdk

    Type alias GuPolicyProps

    GuPolicyProps: PolicyProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/constructs_iam.GuRoleProps.html b/types/constructs_iam.GuRoleProps.html index aa06701e18..872c84b2c6 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GuRoleProps | @guardian/cdk

    Type alias GuRoleProps

    GuRoleProps: RoleProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/constructs_kinesis.GuKinesisStreamProps.html b/types/constructs_kinesis.GuKinesisStreamProps.html index 692033e7fe..d09b072362 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GuKinesisStreamProps | @guardian/cdk

    Type alias GuKinesisStreamProps

    GuKinesisStreamProps: StreamProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/constructs_vpc.GuVpcProps.html b/types/constructs_vpc.GuVpcProps.html index 067dbf29f5..bf95114fd3 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GuVpcProps | @guardian/cdk

    Type alias GuVpcProps

    GuVpcProps: VpcProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/patterns.HttpMethod.html b/types/patterns.HttpMethod.html index e0decee9b5..ab21b566bf 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/types.AppAccess.html b/types/types.AppAccess.html index f2e63dcaed..d349548e2b 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AppAccess | @guardian/cdk

    Type alias AppAccess

    AppAccess: PublicAccess | RestrictedAccess | InternalAccess

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/utils_lambda.StreamProcessingProps.html b/types/utils_lambda.StreamProcessingProps.html index 93a0837755..a9db752974 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +StreamProcessingProps | @guardian/cdk

    Type alias StreamProcessingProps

    StreamProcessingProps: Omit<KinesisEventSourceProps, "bisectBatchOnError" | "maxRecordAge" | "onFailure" | "retryAttempts">

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/constants.ALL_SSM_PARAMETER_PATHS.html b/variables/constants.ALL_SSM_PARAMETER_PATHS.html index 453dcf4099..e1e532006e 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ALL_SSM_PARAMETER_PATHS | @guardian/cdk

    Variable ALL_SSM_PARAMETER_PATHSConst

    ALL_SSM_PARAMETER_PATHS: SsmParameterPath[] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/constants.ContextKeys.html b/variables/constants.ContextKeys.html index 048ea6ca6e..49f3577478 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

    -

    Type declaration

    • REPOSITORY_URL: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • REPOSITORY_URL: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/constants.FASTLY_AWS_ACCOUNT_ID.html b/variables/constants.FASTLY_AWS_ACCOUNT_ID.html index f33c9c1fee..f7bfa39e95 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/constants.LibraryInfo.html b/variables/constants.LibraryInfo.html index 218dc72c0c..742637efb8 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/constants.MetadataKeys.html b/variables/constants.MetadataKeys.html index 0d256b053e..baee057bca 100644 --- a/variables/constants.MetadataKeys.html +++ b/variables/constants.MetadataKeys.html @@ -1 +1 @@ -MetadataKeys | @guardian/cdk

    Variable MetadataKeysConst

    MetadataKeys: {
        CONSTRUCTS_KEY: string;
        LOG_KINESIS_STREAM_NAME: string;
        REPOSITORY_NAME: string;
        SYSTEMD_UNIT: string;
        VERSION: string;
    } = ...

    Type declaration

    • CONSTRUCTS_KEY: string
    • LOG_KINESIS_STREAM_NAME: string
    • REPOSITORY_NAME: string
    • SYSTEMD_UNIT: string
    • VERSION: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +MetadataKeys | @guardian/cdk

    Variable MetadataKeysConst

    MetadataKeys: {
        CONSTRUCTS_KEY: string;
        LOG_KINESIS_STREAM_NAME: string;
        REPOSITORY_NAME: string;
        SYSTEMD_UNIT: string;
        VERSION: string;
    } = ...

    Type declaration

    • CONSTRUCTS_KEY: string
    • LOG_KINESIS_STREAM_NAME: string
    • REPOSITORY_NAME: string
    • SYSTEMD_UNIT: string
    • VERSION: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/constants.NAMED_SSM_PARAMETER_PATHS.html b/variables/constants.NAMED_SSM_PARAMETER_PATHS.html index a97afcea4d..573734cafb 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

    Theme

    Generated using TypeDoc

    \ No newline at end of file +NAMED_SSM_PARAMETER_PATHS | @guardian/cdk

    Variable NAMED_SSM_PARAMETER_PATHSConst

    NAMED_SSM_PARAMETER_PATHS: NamedSsmParameterPaths = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/constants.RegexPattern.html b/variables/constants.RegexPattern.html index 6a31e193ff..1cd67716f6 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;
    } = ...

    Type declaration

    • ACM_ARN: string
    • ARN: string
    • S3ARN: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +RegexPattern | @guardian/cdk

    Variable RegexPatternConst

    RegexPattern: {
        ACM_ARN: string;
        ARN: string;
        S3ARN: string;
    } = ...

    Type declaration

    • ACM_ARN: string
    • ARN: string
    • S3ARN: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/constants.TrackingTag.html b/variables/constants.TrackingTag.html index c1424403de..88ad2ad062 100644 --- a/variables/constants.TrackingTag.html +++ b/variables/constants.TrackingTag.html @@ -1 +1 @@ -TrackingTag | @guardian/cdk

    Variable TrackingTagConst

    TrackingTag: {
        Key: string;
        Value: string;
    } = ...

    Type declaration

    • Key: string
    • Value: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +TrackingTag | @guardian/cdk

    Variable TrackingTagConst

    TrackingTag: {
        Key: string;
        Value: string;
    } = ...

    Type declaration

    • Key: string
    • Value: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/constants.VPC_SSM_PARAMETER_PREFIX.html b/variables/constants.VPC_SSM_PARAMETER_PREFIX.html index da3c1d7c80..c54cc2bfa7 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" = "/account/vpc"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +VPC_SSM_PARAMETER_PREFIX | @guardian/cdk

    Variable VPC_SSM_PARAMETER_PREFIXConst

    VPC_SSM_PARAMETER_PREFIX: "/account/vpc" = "/account/vpc"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/constructs_core.AppIdentity-1.html b/variables/constructs_core.AppIdentity-1.html index eff615a0ca..3024a11df2 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): props is AppIdentity;
        suffixText(appIdentity, text): string;
        taggedConstruct<T>(appIdentity, construct): T;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AppIdentity | @guardian/cdk

    Variable AppIdentity

    AppIdentity: {
        isAppIdentity(props): props is AppIdentity;
        suffixText(appIdentity, text): string;
        taggedConstruct<T>(appIdentity, construct): T;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/types.AppAccess-1.html b/variables/types.AppAccess-1.html index c7021c209e..4441617975 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.

    Parameters

    Returns void

    Throws

    Error when CIDR rules are invalid

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/types.GuDistributable-1.html b/variables/types.GuDistributable-1.html index d222ba4e22..3ff499e94e 100644 --- a/variables/types.GuDistributable-1.html +++ b/variables/types.GuDistributable-1.html @@ -1 +1 @@ -GuDistributable | @guardian/cdk

    Variable GuDistributable

    GuDistributable: {
        getObjectKey(__namedParameters, __namedParameters, __namedParameters): string;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GuDistributable | @guardian/cdk

    Variable GuDistributable

    GuDistributable: {
        getObjectKey(__namedParameters, __namedParameters, __namedParameters): string;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file