diff --git a/404.html b/404.html index 8781987b2..1f3b4bde3 100644 --- a/404.html +++ b/404.html @@ -10,9 +10,8 @@ - - + @@ -20,15 +19,12 @@ - + - - - @@ -52,6 +48,9 @@ + + + @@ -76,7 +75,6 @@
@@ -97,12 +95,8 @@
- - -
\ No newline at end of file diff --git a/api/classes/clusters.ImportClusterProvider.html b/api/classes/clusters.ImportClusterProvider.html index 78270ca8f..7b237ba2d 100644 --- a/api/classes/clusters.ImportClusterProvider.html +++ b/api/classes/clusters.ImportClusterProvider.html @@ -1,18 +1,18 @@ ImportClusterProvider | @aws-quickstart/eks-blueprints

Class ImportClusterProvider

Importing cluster into the blueprint enabling limited blueprinting capabilities such as adding certain addons, teams.

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

id props

Methods

createCluster fromClusterAttributes fromClusterLookup -

Constructors

constructor

Properties

Readonlyid

id: string

Readonlyprops

props: ImportClusterProviderProps

Methods

createCluster

StaticfromClusterAttributes

StaticfromClusterLookup

  • fromClusterLookup(clusterName, region, kubectlRole): Promise<ClusterProvider>

  • Requires iam permission to eks.DescribeCluster at build time. Retrieves the cluster information using DescribeCluster api and +

Constructors

constructor

Properties

Readonlyid

id: string

Readonlyprops

props: ImportClusterProviderProps

Methods

createCluster

StaticfromClusterAttributes

StaticfromClusterLookup

  • fromClusterLookup(clusterName, region, kubectlRole): Promise<ClusterProvider>

  • Requires iam permission to eks.DescribeCluster at build time. Retrieves the cluster information using DescribeCluster api and creates an import cluster provider.

    Parameters

    • clusterName: string

      name of the cluster

    • region: string

      target rego

    • kubectlRole: IRole

      iam Role that provides access to the cluster API (kubectl). The CDK custom resource should be able to assume the role which in some cases may require trust policy for the account root principal.

    Returns Promise<ClusterProvider>

    the cluster provider with the import cluster configuration

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file diff --git a/api/classes/clusters.ManagedNodeGroupConstraints.html b/api/classes/clusters.ManagedNodeGroupConstraints.html index 92e90bff1..0d378875c 100644 --- a/api/classes/clusters.ManagedNodeGroupConstraints.html +++ b/api/classes/clusters.ManagedNodeGroupConstraints.html @@ -1,4 +1,4 @@ -ManagedNodeGroupConstraints | @aws-quickstart/eks-blueprints

Class ManagedNodeGroupConstraints

Implements

Constructors

constructor +ManagedNodeGroupConstraints | @aws-quickstart/eks-blueprints

Class ManagedNodeGroupConstraints

Implements

Constructors

constructor

Properties

amiReleaseVersion desiredSize id @@ -6,15 +6,15 @@ minSize

Constructors

constructor

Properties

amiReleaseVersion

amiReleaseVersion: StringConstraint = ...

amiReleaseVersion can be no less than 1 character long, and no greater than 1024 characters long. https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_Ami.html

-

desiredSize

desiredSize: NumberConstraint = ...

Nodes per node group has a soft limit of 450 nodes, and as little as 0. But we multiply that by a factor of 5 to 2250 in case +

desiredSize

desiredSize: NumberConstraint = ...

Nodes per node group has a soft limit of 450 nodes, and as little as 0. But we multiply that by a factor of 5 to 2250 in case of situations of a hard limit request being accepted, and as a result the limit would be raised https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html

-

id

id: StringConstraint = ...

id can be no less than 1 character long, and no greater than 63 characters long due to DNS system limitations. +

id

id: StringConstraint = ...

id can be no less than 1 character long, and no greater than 63 characters long due to DNS system limitations. https://kubernetes.io/docs/concepts/overview/working-with-objects/names/

-

maxSize

maxSize: NumberConstraint = ...

nodes per node group has a soft limit of 450 nodes, and as little as 0. But we multiply that by a factor of 5 to 2250 in case +

maxSize

maxSize: NumberConstraint = ...

nodes per node group has a soft limit of 450 nodes, and as little as 0. But we multiply that by a factor of 5 to 2250 in case of situations of a hard limit request being accepted, and as a result the limit would be raised https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html

-

minSize

minSize: NumberConstraint = ...

nodes per node group has a soft limit of 450 nodes, and as little as 0. But we multiply that by a factor of 5 to 2250 in case +

minSize

minSize: NumberConstraint = ...

nodes per node group has a soft limit of 450 nodes, and as little as 0. But we multiply that by a factor of 5 to 2250 in case of situations of a hard limit request being accepted, and as a result the limit would be raised https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html

-

Settings

Member Visibility

On This Page

Constructors
Properties
\ No newline at end of file +

Settings

Member Visibility

On This Page

Constructors
Properties
\ No newline at end of file diff --git a/api/classes/clusters.MngClusterProvider.html b/api/classes/clusters.MngClusterProvider.html index e6409cfb6..6dc9a64be 100644 --- a/api/classes/clusters.MngClusterProvider.html +++ b/api/classes/clusters.MngClusterProvider.html @@ -1,5 +1,5 @@ MngClusterProvider | @aws-quickstart/eks-blueprints

Class MngClusterProvider

MngClusterProvider provisions an EKS cluster with a managed node group for managed capacity.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

props

Methods

addAutoScalingGroup addFargateProfile @@ -7,9 +7,9 @@ createCluster getKubectlLayer internalCreateCluster -

Constructors

constructor

Properties

Readonlyprops

props: GenericClusterProviderProps

Methods

addAutoScalingGroup

addFargateProfile

addManagedNodeGroup

createCluster

ProtectedgetKubectlLayer

ProtectedinternalCreateCluster

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file +

Constructors

constructor

Properties

Readonlyprops

props: GenericClusterProviderProps

Methods

addAutoScalingGroup

addFargateProfile

addManagedNodeGroup

createCluster

ProtectedgetKubectlLayer

ProtectedinternalCreateCluster

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file diff --git a/api/classes/pipelines.ApplicationStage.html b/api/classes/pipelines.ApplicationStage.html index 217dc231d..f35cf4406 100644 --- a/api/classes/pipelines.ApplicationStage.html +++ b/api/classes/pipelines.ApplicationStage.html @@ -1,4 +1,4 @@ -ApplicationStage | @aws-quickstart/eks-blueprints

Class ApplicationStage

Hierarchy

  • Stage
    • ApplicationStage

Constructors

constructor +ApplicationStage | @aws-quickstart/eks-blueprints

Class ApplicationStage

Hierarchy

  • Stage
    • ApplicationStage

Constructors

constructor

Properties

_assemblyBuilder account? node @@ -15,7 +15,7 @@ isConstruct isStage of -

Constructors

constructor

Properties

Readonly Internal_assemblyBuilder

_assemblyBuilder: CloudAssemblyBuilder

The cloud assembly builder that is being used for this App

+

Constructors

constructor

Properties

Readonly Internal_assemblyBuilder

_assemblyBuilder: CloudAssemblyBuilder

The cloud assembly builder that is being used for this App

Optional Readonlyaccount

account?: string

The default account for all resources defined within this stage.

Readonlynode

node: Node

The tree node.

Optional ReadonlyparentStage

parentStage?: Stage

The parent stage or undefined if this is the app. @@ -37,7 +37,7 @@

Once an assembly has been synthesized, it cannot be modified. Subsequent calls will return the same assembly.

Parameters

  • Optionaloptions: StageSynthesisOptions

Returns CloudAssembly

toString

  • toString(): string

  • Returns a string representation of this construct.

    -

    Returns string

waitForAsyncTasks

StaticisConstruct

  • isConstruct(x): x is Construct

  • Checks if x is a construct.

    +

    Returns string

waitForAsyncTasks

StaticisConstruct

Constructors

constructor

Methods

application

build

codeBuildPolicies

enableCrossAccountKeys

name

owner

repository

stage

wave

Settings

Member Visibility

On This Page

Constructors
Methods
\ No newline at end of file diff --git a/api/classes/pipelines.CodePipelineStack.html b/api/classes/pipelines.CodePipelineStack.html index cc712d80b..04b6e9e70 100644 --- a/api/classes/pipelines.CodePipelineStack.html +++ b/api/classes/pipelines.CodePipelineStack.html @@ -1,6 +1,6 @@ CodePipelineStack | @aws-quickstart/eks-blueprints

Class CodePipelineStack

Pipeline stack is generating a self-mutating pipeline to faciliate full CI/CD experience with the platform for infrastructure changes.

-

Hierarchy

  • Stack
    • CodePipelineStack

Constructors

constructor +

Hierarchy

  • Stack
    • CodePipelineStack

Constructors

constructor

Properties

_crossRegionReferences _versionReportingEnabled account @@ -52,7 +52,7 @@ isConstruct isStack of -

Constructors

constructor

Properties

Readonly Internal_crossRegionReferences

_crossRegionReferences: boolean

Whether cross region references are enabled for this stack

+

Constructors

constructor

Properties

Readonly Internal_crossRegionReferences

_crossRegionReferences: boolean

Whether cross region references are enabled for this stack

Readonly Internal_versionReportingEnabled

_versionReportingEnabled: boolean

Whether version reporting is enabled for this stack

Controls whether the CDK Metadata resource is injected

Readonlyaccount

account: string

The AWS account into which this stack will be deployed.

@@ -108,7 +108,7 @@ directory during synthesis.

Example value: MyStack.template.json

ReadonlytemplateOptions

templateOptions: ITemplateOptions

Options for CloudFormation template (like version, transform, description).

-

Static ReadonlyUSAGE_ID

USAGE_ID: "qs-1s1r465k6" = "qs-1s1r465k6"

Static ReadonlyUSAGE_ID_MULTI_ACCOUNT

USAGE_ID_MULTI_ACCOUNT: "qs-1s1r465f2" = "qs-1s1r465f2"

Accessors

availabilityZones

  • get availabilityZones(): string[]

  • Returns the list of AZs that are available in the AWS environment +

Static ReadonlyUSAGE_ID

USAGE_ID: "qs-1s1r465k6" = "qs-1s1r465k6"

Static ReadonlyUSAGE_ID_MULTI_ACCOUNT

USAGE_ID_MULTI_ACCOUNT: "qs-1s1r465f2" = "qs-1s1r465f2"

Accessors

availabilityZones

  • get availabilityZones(): string[]

  • Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

    If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve @@ -301,7 +301,7 @@

    Example

Returns ArnComponents

toJsonString

  • toJsonString(obj, space?): string

  • Convert an object, potentially containing tokens, to a JSON string

    Parameters

    • obj: any
    • Optionalspace: number

    Returns string

toString

  • toString(): string

  • Returns a string representation of this construct.

    Returns string

toYamlString

  • toYamlString(obj): string

  • Convert an object, potentially containing tokens, to a YAML string

    -

    Parameters

    • obj: any

    Returns string

Staticbuilder

StaticisConstruct

  • isConstruct(x): x is Construct

  • Checks if x is a construct.

    +

    Parameters

    • obj: any

    Returns string

Staticbuilder

StaticisConstruct

  • isConstruct(x): x is Construct

  • Checks if x is a construct.

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

    Explanation: in JavaScript, multiple copies of the constructs library on diff --git a/api/classes/resources.CreateAmpProvider.html b/api/classes/resources.CreateAmpProvider.html index fb3cf5ac1..a50a6c88e 100644 --- a/api/classes/resources.CreateAmpProvider.html +++ b/api/classes/resources.CreateAmpProvider.html @@ -1,5 +1,5 @@ CreateAmpProvider | @aws-quickstart/eks-blueprints

    Class CreateAmpProvider

    Creates new AMP Workspace with provided AMP Workspace name

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    name workspaceName workspaceTags? @@ -8,7 +8,7 @@

    Parameters

    • name: string

      Name of this resource that other resource providers, add-ons and teams can use for look-up.

    • workspaceName: string

      Name of your AMP Workspace

    • OptionalworkspaceTags: CfnTag[]

      Tags to be used to create AMP Workspace

      -

    Returns CreateAmpProvider

Properties

Readonlyname

name: string

Name of this resource that other resource providers, add-ons and teams can use for look-up.

-

ReadonlyworkspaceName

workspaceName: string

Name of your AMP Workspace

-

Optional ReadonlyworkspaceTags

workspaceTags?: CfnTag[]

Tags to be used to create AMP Workspace

-

Methods

provide

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file +

Returns CreateAmpProvider

Properties

Readonlyname

name: string

Name of this resource that other resource providers, add-ons and teams can use for look-up.

+

ReadonlyworkspaceName

workspaceName: string

Name of your AMP Workspace

+

Optional ReadonlyworkspaceTags

workspaceTags?: CfnTag[]

Tags to be used to create AMP Workspace

+

Methods

provide

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file diff --git a/api/classes/resources.CreateCertificateProvider.html b/api/classes/resources.CreateCertificateProvider.html index 3f9bb43e4..cc4dd6ae5 100644 --- a/api/classes/resources.CreateCertificateProvider.html +++ b/api/classes/resources.CreateCertificateProvider.html @@ -1,11 +1,11 @@ CreateCertificateProvider | @aws-quickstart/eks-blueprints

Class CreateCertificateProvider

Certificate provider that creates a new certificate. Expects a hosted zone to be registed for validation.

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

domainName hostedZoneResourceName name

Methods

provide

Constructors

constructor

Properties

ReadonlydomainName

domainName: string

ReadonlyhostedZoneResourceName

hostedZoneResourceName: string

Readonlyname

name: string

Name of this resource that other resource providers, add-ons and teams can use for look-up.

-

Methods

provide

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file +
  • domainName: string
  • hostedZoneResourceName: string

    • Returns CreateCertificateProvider

    Properties

    ReadonlydomainName

    domainName: string

    ReadonlyhostedZoneResourceName

    hostedZoneResourceName: string

    Readonlyname

    name: string

    Name of this resource that other resource providers, add-ons and teams can use for look-up.

    +

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/resources.CreateEfsFileSystemProvider.html b/api/classes/resources.CreateEfsFileSystemProvider.html index a1cedc822..c10e7318a 100644 --- a/api/classes/resources.CreateEfsFileSystemProvider.html +++ b/api/classes/resources.CreateEfsFileSystemProvider.html @@ -1,7 +1,7 @@ CreateEfsFileSystemProvider | @aws-quickstart/eks-blueprints

    Class CreateEfsFileSystemProvider

    EFS resource provider.

    Param: name

    The name of the EFS file system to create.

    Param: efsProps

    The props used for the file system.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    options

    Methods

    provide -

    Constructors

    constructor

    Properties

    Readonlyoptions

    options: CreateEfsFileSystemProps

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonlyoptions

    options: CreateEfsFileSystemProps

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/resources.CreateKmsKeyProvider.html b/api/classes/resources.CreateKmsKeyProvider.html index a8e528244..72820e8fe 100644 --- a/api/classes/resources.CreateKmsKeyProvider.html +++ b/api/classes/resources.CreateKmsKeyProvider.html @@ -2,9 +2,9 @@

    Example

        const stack = blueprints.EksBlueprint.builder()
          .resourceProvider(GlobalResources.KmsKey, new CreateKmsKeyProvider("my-custom-eks-key"))
          .account("123456789012")
          .region("us-east-1")
          .build(app, "east-test-1");
    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Methods

    provide

    Constructors

    constructor

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file +

    Returns CreateKmsKeyProvider

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file diff --git a/api/classes/resources.CreateRoleProvider.html b/api/classes/resources.CreateRoleProvider.html index f31f0d78b..3abd3ea30 100644 --- a/api/classes/resources.CreateRoleProvider.html +++ b/api/classes/resources.CreateRoleProvider.html @@ -1,9 +1,9 @@ CreateRoleProvider | @aws-quickstart/eks-blueprints

    Class CreateRoleProvider

    Resource provider that creates a new role.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Methods

    provide

    Constructors

    constructor

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file +

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file diff --git a/api/classes/resources.CreateS3BucketProvider.html b/api/classes/resources.CreateS3BucketProvider.html index 5390f95a1..8ad8778e0 100644 --- a/api/classes/resources.CreateS3BucketProvider.html +++ b/api/classes/resources.CreateS3BucketProvider.html @@ -1,6 +1,6 @@ CreateS3BucketProvider | @aws-quickstart/eks-blueprints

    Class CreateS3BucketProvider

    S3 Bucket provider that creates a new S3 Bucket.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    options

    Methods

    provide

    Constructors

    constructor

    Properties

    Readonlyoptions

    options: CreateS3BucketProps

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Parameters

    Returns CreateS3BucketProvider

    Properties

    Readonlyoptions

    options: CreateS3BucketProps

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/resources.DelegatingHostedZoneProvider.html b/api/classes/resources.DelegatingHostedZoneProvider.html index 8bf3e1f70..116408ebc 100644 --- a/api/classes/resources.DelegatingHostedZoneProvider.html +++ b/api/classes/resources.DelegatingHostedZoneProvider.html @@ -1,6 +1,6 @@ DelegatingHostedZoneProvider | @aws-quickstart/eks-blueprints

    Class DelegatingHostedZoneProvider

    Delegating provider is a convenience approach to have a global hosted zone record in a centralized account and subdomain records in respective workload accounts.

    The delegation part allows routing subdomain entries to the child hosted zone in the workload account.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Methods

    provide -

    Constructors

    constructor

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file diff --git a/api/classes/resources.DirectVpcProvider.html b/api/classes/resources.DirectVpcProvider.html index 8743ffb43..77b03c3e9 100644 --- a/api/classes/resources.DirectVpcProvider.html +++ b/api/classes/resources.DirectVpcProvider.html @@ -1,5 +1,5 @@ DirectVpcProvider | @aws-quickstart/eks-blueprints

    Class DirectVpcProvider

    Generic resource provider interface.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    vpc

    Methods

    provide -

    Constructors

    constructor

    Properties

    Readonlyvpc

    vpc: IVpc

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonlyvpc

    vpc: IVpc

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/resources.ImportCertificateProvider.html b/api/classes/resources.ImportCertificateProvider.html index ba9bd3256..685ed0357 100644 --- a/api/classes/resources.ImportCertificateProvider.html +++ b/api/classes/resources.ImportCertificateProvider.html @@ -1,4 +1,4 @@ ImportCertificateProvider | @aws-quickstart/eks-blueprints

    Class ImportCertificateProvider

    Certificate provider that imports certificate into the current stack by arn.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Methods

    provide -

    Constructors

    constructor

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file diff --git a/api/classes/resources.ImportHostedZoneProvider.html b/api/classes/resources.ImportHostedZoneProvider.html index 9fda6e977..ed9cdcd6e 100644 --- a/api/classes/resources.ImportHostedZoneProvider.html +++ b/api/classes/resources.ImportHostedZoneProvider.html @@ -1,5 +1,5 @@ ImportHostedZoneProvider | @aws-quickstart/eks-blueprints

    Class ImportHostedZoneProvider

    Direct import hosted zone provider, based on a known hosted zone ID. Recommended method if hosted zone id is known, as it avoids extra look-ups.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Methods

    provide -

    Constructors

    constructor

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file diff --git a/api/classes/resources.ImportS3BucketProvider.html b/api/classes/resources.ImportS3BucketProvider.html index f8b2f33c1..9040a1e61 100644 --- a/api/classes/resources.ImportS3BucketProvider.html +++ b/api/classes/resources.ImportS3BucketProvider.html @@ -1,6 +1,6 @@ ImportS3BucketProvider | @aws-quickstart/eks-blueprints

    Class ImportS3BucketProvider

    S3 Bucket provider that imports an S3 Bucket into the current stack by name.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Methods

    provide

    Constructors

    constructor

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file +

    Returns ImportS3BucketProvider

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file diff --git a/api/classes/resources.LookupEfsFileSystemProvider.html b/api/classes/resources.LookupEfsFileSystemProvider.html index b77407ef3..151579bd3 100644 --- a/api/classes/resources.LookupEfsFileSystemProvider.html +++ b/api/classes/resources.LookupEfsFileSystemProvider.html @@ -1,7 +1,7 @@ LookupEfsFileSystemProvider | @aws-quickstart/eks-blueprints

    Class LookupEfsFileSystemProvider

    Pass an EFS file system name and id to lookup an existing EFS file system.

    Param: name

    The name of the EFS file system to lookup an existing EFS file system.

    Param: fileSystemId

    The id of the EFS file system to lookup an existing EFS file system.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    options

    Methods

    provide -

    Constructors

    constructor

    Properties

    Readonlyoptions

    options: LookupEfsFileSystemProps

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonlyoptions

    options: LookupEfsFileSystemProps

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/resources.LookupHostedZoneProvider.html b/api/classes/resources.LookupHostedZoneProvider.html index ca65079c1..2850714f8 100644 --- a/api/classes/resources.LookupHostedZoneProvider.html +++ b/api/classes/resources.LookupHostedZoneProvider.html @@ -1,6 +1,6 @@ LookupHostedZoneProvider | @aws-quickstart/eks-blueprints

    Class LookupHostedZoneProvider

    Simple lookup host zone provider

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Methods

    provide

    Constructors

    constructor

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file +

    Returns LookupHostedZoneProvider

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file diff --git a/api/classes/resources.LookupKmsKeyProvider.html b/api/classes/resources.LookupKmsKeyProvider.html index 527ee6718..bce114c59 100644 --- a/api/classes/resources.LookupKmsKeyProvider.html +++ b/api/classes/resources.LookupKmsKeyProvider.html @@ -1,5 +1,5 @@ LookupKmsKeyProvider | @aws-quickstart/eks-blueprints

    Class LookupKmsKeyProvider

    Pass an aliasName to lookup an existing KMS Key.

    Param: aliasName

    The alias name to lookup an existing KMS Key

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Methods

    provide -

    Constructors

    constructor

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file diff --git a/api/classes/resources.LookupOpenIdConnectProvider.html b/api/classes/resources.LookupOpenIdConnectProvider.html index b4fd2392b..052c2de2e 100644 --- a/api/classes/resources.LookupOpenIdConnectProvider.html +++ b/api/classes/resources.LookupOpenIdConnectProvider.html @@ -1,6 +1,6 @@ LookupOpenIdConnectProvider | @aws-quickstart/eks-blueprints

    Class LookupOpenIdConnectProvider

    OpenIdConnect provider can lookup an existing OpenIdConnectProvider based on the OIDC provider URL.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    id url

    Methods

    provide -

    Constructors

    constructor

    Properties

    Protected Readonlyid

    id: string

    Readonlyurl

    url: string

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Protected Readonlyid

    id: string

    Readonlyurl

    url: string

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/resources.LookupRoleProvider.html b/api/classes/resources.LookupRoleProvider.html index 9381b5d82..040c3efee 100644 --- a/api/classes/resources.LookupRoleProvider.html +++ b/api/classes/resources.LookupRoleProvider.html @@ -1,4 +1,4 @@ LookupRoleProvider | @aws-quickstart/eks-blueprints

    Class LookupRoleProvider

    Role provider that imports an existing role, performing its lookup by the provided name.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Methods

    provide -

    Constructors

    constructor

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file diff --git a/api/classes/resources.LookupSubnetProvider.html b/api/classes/resources.LookupSubnetProvider.html index 2a7f9a0bc..9c838ab6b 100644 --- a/api/classes/resources.LookupSubnetProvider.html +++ b/api/classes/resources.LookupSubnetProvider.html @@ -1,5 +1,5 @@ LookupSubnetProvider | @aws-quickstart/eks-blueprints

    Class LookupSubnetProvider

    Direct import secondary subnet provider, based on a known subnet ID. Recommended method if secondary subnet id is known, as it avoids extra look-ups.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Methods

    provide -

    Constructors

    constructor

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file diff --git a/api/classes/resources.VpcProvider.html b/api/classes/resources.VpcProvider.html index e76ff7354..33ccf1570 100644 --- a/api/classes/resources.VpcProvider.html +++ b/api/classes/resources.VpcProvider.html @@ -1,9 +1,9 @@ VpcProvider | @aws-quickstart/eks-blueprints

    Class VpcProvider

    VPC resource provider

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    primaryCidr? secondaryCidr? secondarySubnetCidrs? vpcId?

    Methods

    createSecondarySubnets provide -

    Constructors

    constructor

    Properties

    Optional ReadonlyprimaryCidr

    primaryCidr?: string

    Optional ReadonlysecondaryCidr

    secondaryCidr?: string

    Optional ReadonlysecondarySubnetCidrs

    secondarySubnetCidrs?: string[]

    Optional ReadonlyvpcId

    vpcId?: string

    Methods

    ProtectedcreateSecondarySubnets

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional ReadonlyprimaryCidr

    primaryCidr?: string

    Optional ReadonlysecondaryCidr

    secondaryCidr?: string

    Optional ReadonlysecondarySubnetCidrs

    secondarySubnetCidrs?: string[]

    Optional ReadonlyvpcId

    vpcId?: string

    Methods

    ProtectedcreateSecondarySubnets

    provide

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/stacks.BlueprintBuilder.html b/api/classes/stacks.BlueprintBuilder.html index 830e23303..5fd76c820 100644 --- a/api/classes/stacks.BlueprintBuilder.html +++ b/api/classes/stacks.BlueprintBuilder.html @@ -1,7 +1,7 @@ BlueprintBuilder | @aws-quickstart/eks-blueprints

    Class BlueprintBuilder

    Blueprint builder implements a builder pattern that improves readability (no bloated constructors) and allows creating a blueprint in an abstract state that can be applied to various instantiations in accounts and regions.

    -

    Hierarchy (view full)

    Implements

    Constructors

    constructor +

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    env props

    Methods

    account @@ -22,6 +22,6 @@ version withBlueprintProps withEnv -

    Constructors

    constructor

    Properties

    env

    env: {
        account?: string;
        region?: string;
    }

    props

    props: Partial<EksBlueprintProps>

    Methods

    account

    addOns

    build

    buildAsync

    clone

    clusterProvider

    compatibilityMode

    Constructors

    constructor

    Properties

    env

    env: {
        account?: string;
        region?: string;
    }

    props

    props: Partial<EksBlueprintProps>

    Methods

    account

    addOns

    build

    buildAsync

    clone

    clusterProvider

    compatibilityMode

    enableControlPlaneLogTypes

    enableGitOps

    id

    name

    region

    resourceProvider

    teams

    useDefaultSecretEncryption

    version

    withBlueprintProps

    withEnv

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Returns BlueprintBuilder

    enableControlPlaneLogTypes

    enableGitOps

    id

    name

    region

    resourceProvider

    teams

    useDefaultSecretEncryption

    version

    withBlueprintProps

    withEnv

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/stacks.BlueprintConstructBuilder.html b/api/classes/stacks.BlueprintConstructBuilder.html index e01f91107..bcef3ecdf 100644 --- a/api/classes/stacks.BlueprintConstructBuilder.html +++ b/api/classes/stacks.BlueprintConstructBuilder.html @@ -1,7 +1,7 @@ BlueprintConstructBuilder | @aws-quickstart/eks-blueprints

    Class BlueprintConstructBuilder

    Blueprint builder implements a builder pattern that improves readability (no bloated constructors) and allows creating a blueprint in an abstract state that can be applied to various instantiations in accounts and regions.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    env props

    Methods

    account @@ -18,4 +18,4 @@ version withBlueprintProps withEnv -

    Constructors

    constructor

    Properties

    env

    env: {
        account?: string;
        region?: string;
    }

    props

    props: Partial<EksBlueprintProps>

    Methods

    account

    addOns

    clusterProvider

    enableControlPlaneLogTypes

    enableGitOps

    id

    name

    region

    resourceProvider

    teams

    useDefaultSecretEncryption

    version

    withBlueprintProps

    withEnv

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    env

    env: {
        account?: string;
        region?: string;
    }

    props

    props: Partial<EksBlueprintProps>

    Methods

    account

    addOns

    clusterProvider

    enableControlPlaneLogTypes

    enableGitOps

    id

    name

    region

    resourceProvider

    teams

    useDefaultSecretEncryption

    version

    withBlueprintProps

    withEnv

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/stacks.BlueprintPropsConstraints.html b/api/classes/stacks.BlueprintPropsConstraints.html index dbc7ed2e1..0c88c9b70 100644 --- a/api/classes/stacks.BlueprintPropsConstraints.html +++ b/api/classes/stacks.BlueprintPropsConstraints.html @@ -1,8 +1,8 @@ -BlueprintPropsConstraints | @aws-quickstart/eks-blueprints

    Class BlueprintPropsConstraints

    Implements

    Constructors

    constructor +BlueprintPropsConstraints | @aws-quickstart/eks-blueprints

    Class BlueprintPropsConstraints

    Implements

    Constructors

    constructor

    Properties

    id name

    Constructors

    constructor

    Properties

    id

    id: StringConstraint = ...

    id can be no less than 1 character long, and no greater than 63 characters long. https://kubernetes.io/docs/concepts/overview/working-with-objects/names/

    -

    name

    name: StringConstraint = ...

    name can be no less than 1 character long, and no greater than 63 characters long. +

    name

    name: StringConstraint = ...

    name can be no less than 1 character long, and no greater than 63 characters long. https://kubernetes.io/docs/concepts/overview/working-with-objects/names/

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    \ No newline at end of file diff --git a/api/classes/stacks.EksBlueprint.html b/api/classes/stacks.EksBlueprint.html index c8554038b..6420fdf3e 100644 --- a/api/classes/stacks.EksBlueprint.html +++ b/api/classes/stacks.EksBlueprint.html @@ -1,6 +1,6 @@ EksBlueprint | @aws-quickstart/eks-blueprints

    Class EksBlueprint

    Entry point to the platform provisioning. Creates a CFN stack based on the provided configuration and orchestrates provisioning of add-ons, teams and post deployment hooks.

    -

    Hierarchy

    • Stack
      • EksBlueprint

    Constructors

    constructor +

    Hierarchy

    • Stack
      • EksBlueprint

    Constructors

    constructor

    Properties

    _crossRegionReferences _versionReportingEnabled account @@ -53,7 +53,7 @@ isConstruct isStack of -

    Constructors

    constructor

    Properties

    Readonly Internal_crossRegionReferences

    _crossRegionReferences: boolean

    Whether cross region references are enabled for this stack

    +

    Constructors

    constructor

    Properties

    Readonly Internal_crossRegionReferences

    _crossRegionReferences: boolean

    Whether cross region references are enabled for this stack

    Readonly Internal_versionReportingEnabled

    _versionReportingEnabled: boolean

    Whether version reporting is enabled for this stack

    Controls whether the CDK Metadata resource is injected

    Readonlyaccount

    account: string

    The AWS account into which this stack will be deployed.

    @@ -109,7 +109,7 @@ directory during synthesis.

    Example value: MyStack.template.json

    ReadonlytemplateOptions

    templateOptions: ITemplateOptions

    Options for CloudFormation template (like version, transform, description).

    -

    Static ReadonlyUSAGE_ID

    USAGE_ID: "qs-1s1r465hk" = "qs-1s1r465hk"

    Accessors

    availabilityZones

    • get availabilityZones(): string[]

    • Returns the list of AZs that are available in the AWS environment +

    Static ReadonlyUSAGE_ID

    USAGE_ID: "qs-1s1r465hk" = "qs-1s1r465hk"

    Accessors

    availabilityZones

    getClusterInfo

    getLogicalId

    getLogicalId

    waitForAsyncTasks

    Staticbuilder

    StaticisConstruct

    Staticbuilder

    StaticisConstruct

    ProtectedsetupNamespace

    ProtectedsetupNamespacePolicies

    • setupNamespacePolicies(clusterInfo, namespaceName): void

    • Sets up quotas

      +

      Parameters

      Returns void

    ProtectedsetupSecrets

    ProtectedsetupServiceAccount

    • setupServiceAccount(clusterInfo): void

    • Sets up ServiceAccount for the team namespace

      +

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/teams.BatchEksTeam.html b/api/classes/teams.BatchEksTeam.html index 27c70b118..f004065f3 100644 --- a/api/classes/teams.BatchEksTeam.html +++ b/api/classes/teams.BatchEksTeam.html @@ -1,5 +1,5 @@ BatchEksTeam | @aws-quickstart/eks-blueprints

    Class BatchEksTeam

    Interface for a team.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    batchTeamProps name namespaceManifest @@ -14,12 +14,12 @@ setupSecrets setupServiceAccount

    Constructors

    constructor

    Properties

    ReadonlybatchTeamProps

    batchTeamProps: BatchEksTeamProps

    Readonlyname

    name: string

    Team name, expected to be unique

    -

    namespaceManifest

    namespaceManifest: KubernetesManifest

    serviceAccount

    serviceAccount: ServiceAccount

    ReadonlyteamProps

    teamProps: TeamProps

    Methods

    ProtecteddefaultSetupAccess

    ProtecteddefaultSetupAdminAccess

    ProtectedgetOrCreateRole

    • getOrCreateRole(clusterInfo, users, roleArn?): undefined | IRole

    • Creates a new role with trust relationship or adds trust relationship for an existing role.

      -

      Parameters

      • clusterInfo: ClusterInfo
      • users: ArnPrincipal[]
      • OptionalroleArn: string

      Returns undefined | IRole

    setup

    • setup(clusterInfo): void

    • Setup method is invoked in the lifecycle of cluster provisioning +

    Returns BatchEksTeam

    Properties

    ReadonlybatchTeamProps

    batchTeamProps: BatchEksTeamProps

    Readonlyname

    name: string

    Team name, expected to be unique

    +

    namespaceManifest

    namespaceManifest: KubernetesManifest

    serviceAccount

    serviceAccount: ServiceAccount

    ReadonlyteamProps

    teamProps: TeamProps

    Methods

    ProtecteddefaultSetupAccess

    ProtecteddefaultSetupAdminAccess

    ProtectedgetOrCreateRole

    • getOrCreateRole(clusterInfo, users, roleArn?): undefined | IRole

    • Creates a new role with trust relationship or adds trust relationship for an existing role.

      +

      Parameters

      • clusterInfo: ClusterInfo
      • users: ArnPrincipal[]
      • OptionalroleArn: string

      Returns undefined | IRole

    setup

    ProtectedsetupNamespace

    ProtectedsetupNamespacePolicies

    ProtectedsetupSecrets

    ProtectedsetupServiceAccount

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Parameters

    Returns void

    ProtectedsetupNamespace

    ProtectedsetupNamespacePolicies

    ProtectedsetupSecrets

    ProtectedsetupServiceAccount

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/teams.BedrockTeam.html b/api/classes/teams.BedrockTeam.html index cade18aa7..2f5416a51 100644 --- a/api/classes/teams.BedrockTeam.html +++ b/api/classes/teams.BedrockTeam.html @@ -1,5 +1,5 @@ BedrockTeam | @aws-quickstart/eks-blueprints

    Class BedrockTeam

    Interface for a team.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    name namespaceManifest serviceAccount @@ -13,12 +13,12 @@ setupSecrets setupServiceAccount

    Constructors

    constructor

    Properties

    Readonlyname

    name: string

    Team name, expected to be unique

    -

    namespaceManifest

    namespaceManifest: KubernetesManifest

    serviceAccount

    serviceAccount: ServiceAccount

    ReadonlyteamProps

    teamProps: TeamProps

    Methods

    ProtecteddefaultSetupAccess

    ProtecteddefaultSetupAdminAccess

    ProtectedgetOrCreateRole

    • getOrCreateRole(clusterInfo, users, roleArn?): undefined | IRole

    • Creates a new role with trust relationship or adds trust relationship for an existing role.

      -

      Parameters

      • clusterInfo: ClusterInfo
      • users: ArnPrincipal[]
      • OptionalroleArn: string

      Returns undefined | IRole

    setup

    • setup(clusterInfo): void

    • Setup method is invoked in the lifecycle of cluster provisioning +

    Returns BedrockTeam

    Properties

    Readonlyname

    name: string

    Team name, expected to be unique

    +

    namespaceManifest

    namespaceManifest: KubernetesManifest

    serviceAccount

    serviceAccount: ServiceAccount

    ReadonlyteamProps

    teamProps: TeamProps

    Methods

    ProtecteddefaultSetupAccess

    ProtecteddefaultSetupAdminAccess

    ProtectedgetOrCreateRole

    • getOrCreateRole(clusterInfo, users, roleArn?): undefined | IRole

    • Creates a new role with trust relationship or adds trust relationship for an existing role.

      +

      Parameters

      • clusterInfo: ClusterInfo
      • users: ArnPrincipal[]
      • OptionalroleArn: string

      Returns undefined | IRole

    setup

    • setup(clusterInfo): void

    • Setup method is invoked in the lifecycle of cluster provisioning after add-ons are provisioned but before and post deployment hooks.

      -

      Parameters

      Returns void

    ProtectedsetupNamespace

    ProtectedsetupNamespacePolicies

    ProtectedsetupSecrets

    ProtectedsetupServiceAccount

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Parameters

    Returns void

    ProtectedsetupNamespace

    ProtectedsetupNamespacePolicies

    ProtectedsetupSecrets

    ProtectedsetupServiceAccount

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/teams.EmrEksTeam.html b/api/classes/teams.EmrEksTeam.html index 401a34c95..658288e33 100644 --- a/api/classes/teams.EmrEksTeam.html +++ b/api/classes/teams.EmrEksTeam.html @@ -1,5 +1,5 @@ EmrEksTeam | @aws-quickstart/eks-blueprints

    Class EmrEksTeam

    Interface for a team.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    name namespaceManifest serviceAccount @@ -13,12 +13,12 @@ setupSecrets setupServiceAccount

    Constructors

    constructor

    Properties

    Readonlyname

    name: string

    Team name, expected to be unique

    -

    namespaceManifest

    namespaceManifest: KubernetesManifest

    serviceAccount

    serviceAccount: ServiceAccount

    ReadonlyteamProps

    teamProps: TeamProps

    Methods

    ProtecteddefaultSetupAccess

    ProtecteddefaultSetupAdminAccess

    ProtectedgetOrCreateRole

    • getOrCreateRole(clusterInfo, users, roleArn?): undefined | IRole

    • Creates a new role with trust relationship or adds trust relationship for an existing role.

      -

      Parameters

      • clusterInfo: ClusterInfo
      • users: ArnPrincipal[]
      • OptionalroleArn: string

      Returns undefined | IRole

    setup

    • setup(clusterInfo): void

    • Setup method is invoked in the lifecycle of cluster provisioning +

    Returns EmrEksTeam

    Properties

    Readonlyname

    name: string

    Team name, expected to be unique

    +

    namespaceManifest

    namespaceManifest: KubernetesManifest

    serviceAccount

    serviceAccount: ServiceAccount

    ReadonlyteamProps

    teamProps: TeamProps

    Methods

    ProtecteddefaultSetupAccess

    ProtecteddefaultSetupAdminAccess

    ProtectedgetOrCreateRole

    • getOrCreateRole(clusterInfo, users, roleArn?): undefined | IRole

    • Creates a new role with trust relationship or adds trust relationship for an existing role.

      +

      Parameters

      • clusterInfo: ClusterInfo
      • users: ArnPrincipal[]
      • OptionalroleArn: string

      Returns undefined | IRole

    setup

    ProtectedsetupNamespace

    ProtectedsetupNamespacePolicies

    ProtectedsetupSecrets

    ProtectedsetupServiceAccount

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Parameters

    Returns void

    ProtectedsetupNamespace

    ProtectedsetupNamespacePolicies

    ProtectedsetupSecrets

    ProtectedsetupServiceAccount

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/teams.PlatformTeam.html b/api/classes/teams.PlatformTeam.html index 1bc831c2d..0c4a21368 100644 --- a/api/classes/teams.PlatformTeam.html +++ b/api/classes/teams.PlatformTeam.html @@ -1,6 +1,6 @@ PlatformTeam | @aws-quickstart/eks-blueprints

    Class PlatformTeam

    Platform team will setup all team members as admin access to the cluster by adding them to the master group. The setup skips namespace/quota configuration.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    name namespaceManifest serviceAccount @@ -13,11 +13,11 @@ setupNamespacePolicies setupSecrets setupServiceAccount -

    Constructors

    constructor

    Properties

    Readonlyname

    name: string

    Team name, expected to be unique

    -

    namespaceManifest

    namespaceManifest: KubernetesManifest

    serviceAccount

    serviceAccount: ServiceAccount

    ReadonlyteamProps

    teamProps: TeamProps

    Methods

    ProtecteddefaultSetupAccess

    ProtecteddefaultSetupAdminAccess

    ProtectedgetOrCreateRole

    • getOrCreateRole(clusterInfo, users, roleArn?): undefined | IRole

    • Creates a new role with trust relationship or adds trust relationship for an existing role.

      -

      Parameters

      • clusterInfo: ClusterInfo
      • users: ArnPrincipal[]
      • OptionalroleArn: string

      Returns undefined | IRole

    setup

    ProtectedsetupNamespace

    ProtectedsetupNamespacePolicies

    ProtectedsetupSecrets

    ProtectedsetupServiceAccount

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonlyname

    name: string

    Team name, expected to be unique

    +

    namespaceManifest

    namespaceManifest: KubernetesManifest

    serviceAccount

    serviceAccount: ServiceAccount

    ReadonlyteamProps

    teamProps: TeamProps

    Methods

    ProtecteddefaultSetupAccess

    ProtecteddefaultSetupAdminAccess

    ProtectedgetOrCreateRole

    • getOrCreateRole(clusterInfo, users, roleArn?): undefined | IRole

    • Creates a new role with trust relationship or adds trust relationship for an existing role.

      +

      Parameters

      • clusterInfo: ClusterInfo
      • users: ArnPrincipal[]
      • OptionalroleArn: string

      Returns undefined | IRole

    setup

    ProtectedsetupNamespace

    ProtectedsetupNamespacePolicies

    ProtectedsetupSecrets

    ProtectedsetupServiceAccount

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/teams.TeamProps.html b/api/classes/teams.TeamProps.html index dcca0d93b..1d19eb06d 100644 --- a/api/classes/teams.TeamProps.html +++ b/api/classes/teams.TeamProps.html @@ -1,5 +1,5 @@ TeamProps | @aws-quickstart/eks-blueprints

    Class TeamProps

    Team properties.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    name namespace? namespaceAnnotations? @@ -14,21 +14,21 @@

    Methods

    extensionFunction?

    Constructors

    constructor

    Properties

    Readonlyname

    name: string

    Required unique name for organization. May map to an OU name.

    -

    Optional Readonlynamespace

    namespace?: string

    Defaults to team name prefixed by "team-"

    -

    Optional ReadonlynamespaceAnnotations

    namespaceAnnotations?: {
        [key: string]: any;
    } = ...

    Annotations such as necessary for GitOps engine.

    -

    Optional ReadonlynamespaceHardLimits

    namespaceHardLimits?: Values = ...

    Optional, but highly recommended setting to ensure predictable demands.

    -

    Optional ReadonlynamespaceLabels

    namespaceLabels?: {
        [key: string]: any;
    }

    Labels such as necessary for AWS AppMesh

    -

    Optional ReadonlyserviceAccountName

    serviceAccountName?: string

    Service Account Name

    -

    Optional ReadonlyserviceAccountPolicies

    serviceAccountPolicies?: IManagedPolicy[]

    If specified, the IRSA account will be created for with the IRSA role +

    Optional Readonlynamespace

    namespace?: string

    Defaults to team name prefixed by "team-"

    +

    Optional ReadonlynamespaceAnnotations

    namespaceAnnotations?: {
        [key: string]: any;
    } = ...

    Annotations such as necessary for GitOps engine.

    +

    Optional ReadonlynamespaceHardLimits

    namespaceHardLimits?: Values = ...

    Optional, but highly recommended setting to ensure predictable demands.

    +

    Optional ReadonlynamespaceLabels

    namespaceLabels?: {
        [key: string]: any;
    }

    Labels such as necessary for AWS AppMesh

    +

    Optional ReadonlyserviceAccountName

    serviceAccountName?: string

    Service Account Name

    +

    Optional ReadonlyserviceAccountPolicies

    serviceAccountPolicies?: IManagedPolicy[]

    If specified, the IRSA account will be created for with the IRSA role having the specified managed policies.

    Example

    serviceAccountPolicies: [ManagedPolicy.fromAwsManagedPolicyName("")]
    -

    Optional ReadonlyteamManifestDir

    teamManifestDir?: string

    Optional, directory where a team's manifests are stored

    -

    Optional ReadonlyteamSecrets

    teamSecrets?: CsiSecretProps[]

    Team Secrets

    -

    Optional ReadonlyuserRoleArn

    userRoleArn?: string

    Options existing role that should be used for cluster access. +

    Optional ReadonlyteamManifestDir

    teamManifestDir?: string

    Optional, directory where a team's manifests are stored

    +

    Optional ReadonlyteamSecrets

    teamSecrets?: CsiSecretProps[]

    Team Secrets

    +

    Optional ReadonlyuserRoleArn

    userRoleArn?: string

    Options existing role that should be used for cluster access. If userRole and users are not provided, then no IAM setup is performed.

    -

    Optional Readonlyusers

    users?: ArnPrincipal[]

    Team members who need to get access to the cluster

    -

    Methods

    OptionalextensionFunction

    • extensionFunction(team, clusterInfo): void

    • Optional, Use this function to add infrastructure or workloads +

    Optional Readonlyusers

    users?: ArnPrincipal[]

    Team members who need to get access to the cluster

    +

    Methods

    OptionalextensionFunction

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/utils.ArrayConstraint.html b/api/classes/utils.ArrayConstraint.html index 4bab8f802..8cbbcd12b 100644 --- a/api/classes/utils.ArrayConstraint.html +++ b/api/classes/utils.ArrayConstraint.html @@ -1,6 +1,6 @@ ArrayConstraint | @aws-quickstart/eks-blueprints

    Class ArrayConstraint

    This works just like NumberConstraint but checks the length of the given value for an expected array. If not a detailed Zod Error is thrown also utilizing the identifier for context.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    max? min?

    Methods

    validate -

    Constructors

    constructor

    Properties

    Optional Readonlymax

    max?: number

    Optional Readonlymin

    min?: number

    Methods

    validate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional Readonlymax

    max?: number

    Optional Readonlymin

    min?: number

    Methods

    validate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/utils.CompositeConstraint.html b/api/classes/utils.CompositeConstraint.html index 5b6804b94..fd81a8db4 100644 --- a/api/classes/utils.CompositeConstraint.html +++ b/api/classes/utils.CompositeConstraint.html @@ -1,5 +1,5 @@ CompositeConstraint | @aws-quickstart/eks-blueprints

    Class CompositeConstraint

    Contains a list of constraints and checks whether a given value meets each constraint. If not, a detailed Zod Error is thrown for that constraint.

    -

    Hierarchy (view full)

    Implements

    Constructors

    constructor +

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    constraints

    Methods

    validate -

    Constructors

    constructor

    Properties

    Readonlyconstraints

    constraints: Constraint[]

    Methods

    validate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonlyconstraints

    constraints: Constraint[]

    Methods

    validate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/utils.DummyProxy.html b/api/classes/utils.DummyProxy.html index 73a67d42f..672422077 100644 --- a/api/classes/utils.DummyProxy.html +++ b/api/classes/utils.DummyProxy.html @@ -4,7 +4,7 @@ Since most CDK constructs are not idempotent (meaning you can not call a create function twice, the second will fail) this design choice was the simplest to support declarative resources. Customers can clone the supplied JSON structure with cloneDeep and replace proxies with the actual targets as part of that process.

    -

    Type Parameters

    • T extends object

    Implements

    • ProxyHandler<T>

    Constructors

    constructor +

    Type Parameters

    • T extends object

    Implements

    • ProxyHandler<T>

    Constructors

    constructor

    Methods

    get -

    Constructors

    constructor

    Methods

    get

    • get(_, key): any

    • A trap for getting a property value.

      -

      Parameters

      • _: T
      • key: PropertyKey

      Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    get

    • get(_, key): any

    • A trap for getting a property value.

      +

      Parameters

      • _: T
      • key: PropertyKey

      Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file diff --git a/api/classes/utils.GenericRegexStringConstraint.html b/api/classes/utils.GenericRegexStringConstraint.html index 9dcf61bde..376cc1f5e 100644 --- a/api/classes/utils.GenericRegexStringConstraint.html +++ b/api/classes/utils.GenericRegexStringConstraint.html @@ -1,5 +1,5 @@ GenericRegexStringConstraint | @aws-quickstart/eks-blueprints

    Class GenericRegexStringConstraint

    Checks whether a given string matches the regex. If not, a detailed Zod Error is thrown.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    regex?

    Methods

    validate -

    Constructors

    constructor

    Properties

    Optional Readonlyregex

    regex?: RegExp

    Methods

    validate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional Readonlyregex

    regex?: RegExp

    Methods

    validate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/utils.InternetHostStringConstraint.html b/api/classes/utils.InternetHostStringConstraint.html index 65f209fd8..4d3a3e2dd 100644 --- a/api/classes/utils.InternetHostStringConstraint.html +++ b/api/classes/utils.InternetHostStringConstraint.html @@ -1,5 +1,5 @@ InternetHostStringConstraint | @aws-quickstart/eks-blueprints

    Class InternetHostStringConstraint

    Checks whether a given string matches the regex for RFC 1123. If not, a detailed Zod Error is thrown.

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    constraints

    Methods

    validate -

    Constructors

    constructor

    Properties

    Readonlyconstraints

    constraints: Constraint[]

    Methods

    validate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonlyconstraints

    constraints: Constraint[]

    Methods

    validate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/utils.NumberConstraint.html b/api/classes/utils.NumberConstraint.html index 50d1bee2a..39b54cf95 100644 --- a/api/classes/utils.NumberConstraint.html +++ b/api/classes/utils.NumberConstraint.html @@ -1,6 +1,6 @@ NumberConstraint | @aws-quickstart/eks-blueprints

    Class NumberConstraint

    This class checks if the given number (value) is within the bounds of the given min and max inclusive number bounds. If not a detailed Zod Error is thrown also utilizing the identifier for context.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    max? min?

    Methods

    validate -

    Constructors

    constructor

    Properties

    Optional Readonlymax

    max?: number

    Optional Readonlymin

    min?: number

    Methods

    validate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional Readonlymax

    max?: number

    Optional Readonlymin

    min?: number

    Methods

    validate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/utils.ReplaceServiceAccount.html b/api/classes/utils.ReplaceServiceAccount.html index c8ecc7a55..aff8c6e66 100644 --- a/api/classes/utils.ReplaceServiceAccount.html +++ b/api/classes/utils.ReplaceServiceAccount.html @@ -2,7 +2,7 @@ to replace service account if it already exists (e.g. a case with installing VPC CNI add-on). Once CDK adds support to replace an existing service account, this class should be deleted and replaced with the standard eks.ServiceAccount.

    -

    Hierarchy

    • Construct
      • ReplaceServiceAccount

    Implements

    • IPrincipal

    Constructors

    constructor +

    Hierarchy

    • Construct
      • ReplaceServiceAccount

    Implements

    • IPrincipal

    Constructors

    constructor

    Properties

    assumeRoleAction grantPrincipal node @@ -13,15 +13,15 @@

    Methods

    addToPrincipalPolicy toString isConstruct -

    Constructors

    constructor

    Properties

    ReadonlyassumeRoleAction

    assumeRoleAction: string

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

    -

    ReadonlygrantPrincipal

    grantPrincipal: IPrincipal

    The principal to grant permissions to

    -

    Readonlynode

    node: Node

    The tree node.

    +

    Constructors

    constructor

    Properties

    ReadonlyassumeRoleAction

    assumeRoleAction: string

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

    +

    ReadonlygrantPrincipal

    grantPrincipal: IPrincipal

    The principal to grant permissions to

    +

    Readonlynode

    node: Node

    The tree node.

    ReadonlypolicyFragment

    policyFragment: PrincipalPolicyFragment

    Return the policy fragment that identifies this principal in a Policy.

    -

    Readonlyrole

    role: IRole

    The role which is linked to the service account.

    -

    ReadonlyserviceAccountName

    serviceAccountName: string

    The name of the service account.

    -

    ReadonlyserviceAccountNamespace

    serviceAccountNamespace: string

    The namespace where the service account is located in.

    -

    Methods

    addToPrincipalPolicy

    • addToPrincipalPolicy(statement): AddToPrincipalPolicyResult

    • Add to the policy of this principal.

      -

      Parameters

      • statement: PolicyStatement

      Returns AddToPrincipalPolicyResult

    toString

    • toString(): string

    • Returns a string representation of this construct.

      +

    Readonlyrole

    role: IRole

    The role which is linked to the service account.

    +

    ReadonlyserviceAccountName

    serviceAccountName: string

    The name of the service account.

    +

    ReadonlyserviceAccountNamespace

    serviceAccountNamespace: string

    The namespace where the service account is located in.

    +

    Methods

    addToPrincipalPolicy

    • addToPrincipalPolicy(statement): AddToPrincipalPolicyResult

    • Add to the policy of this principal.

      +

      Parameters

      • statement: PolicyStatement

      Returns AddToPrincipalPolicyResult

    toString

    • toString(): string

    • Returns a string representation of this construct.

      Returns string

    StaticisConstruct

    Constructors

    constructor

    Properties

    Optional Readonlymax

    max?: number

    Optional Readonlymin

    min?: number

    Methods

    validate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/classes/utils.UrlStringConstraint.html b/api/classes/utils.UrlStringConstraint.html index f2e3c3cbe..20fb32188 100644 --- a/api/classes/utils.UrlStringConstraint.html +++ b/api/classes/utils.UrlStringConstraint.html @@ -1,6 +1,6 @@ UrlStringConstraint | @aws-quickstart/eks-blueprints

    Class UrlStringConstraint

    This is the same as StringConstraint, but also checks if the given string is a correctly formatted URL. If not a detailed Zod Error is thrown also utilizing the identifier for context.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    max? min?

    Methods

    validate -

    Constructors

    constructor

    Properties

    Optional Readonlymax

    max?: number

    Optional Readonlymin

    min?: number

    Methods

    validate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional Readonlymax

    max?: number

    Optional Readonlymin

    min?: number

    Methods

    validate

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    \ No newline at end of file diff --git a/api/enums/GitOpsMode.html b/api/enums/GitOpsMode.html index 1f6767940..b3e52ce72 100644 --- a/api/enums/GitOpsMode.html +++ b/api/enums/GitOpsMode.html @@ -1,8 +1,8 @@ GitOpsMode | @aws-quickstart/eks-blueprints

    Enumeration GitOpsMode

    Enum type for two different GitOps operating modes

    -

    Enumeration Members

    APPLICATION +

    Enumeration Members

    APPLICATION APP_OF_APPS

    Enumeration Members

    APPLICATION

    APPLICATION: 0

    CDK deploys the Application resource for each AddOn enabled or customer workloads, and ArgoCD deploys the actual AddOn and workloads via GitOps based on the Application resource.

    -

    APP_OF_APPS

    APP_OF_APPS: 1

    CDK deploys only one Application resource for the App of Apps, aka bootstrap-apps, +

    APP_OF_APPS

    APP_OF_APPS: 1

    CDK deploys only one Application resource for the App of Apps, aka bootstrap-apps, and ArgoCD deploys all the AddOns based on the child Application defined in bootstrap-apps.

    -

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file diff --git a/api/enums/GlobalResources.html b/api/enums/GlobalResources.html index ac006f909..6eb8181d2 100644 --- a/api/enums/GlobalResources.html +++ b/api/enums/GlobalResources.html @@ -1,6 +1,6 @@ -GlobalResources | @aws-quickstart/eks-blueprints

    Enumeration GlobalResources

    Enumeration Members

    Amp +GlobalResources | @aws-quickstart/eks-blueprints

    Enumeration GlobalResources

    Enumeration Members

    Amp Certificate HostedZone KmsKey Vpc -

    Enumeration Members

    Amp

    Amp: "amp"

    Certificate

    Certificate: "certificate"

    HostedZone

    HostedZone: "hosted-zone"

    KmsKey

    KmsKey: "kms-key"

    Vpc

    Vpc: "vpc"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file +

    Enumeration Members

    Amp

    Amp: "amp"

    Certificate

    Certificate: "certificate"

    HostedZone

    HostedZone: "hosted-zone"

    KmsKey

    KmsKey: "kms-key"

    Vpc

    Vpc: "vpc"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file diff --git a/api/enums/addons.AckServiceName.html b/api/enums/addons.AckServiceName.html index 0d22fd82a..7ce0faa6e 100644 --- a/api/enums/addons.AckServiceName.html +++ b/api/enums/addons.AckServiceName.html @@ -1,5 +1,5 @@ AckServiceName | @aws-quickstart/eks-blueprints

    Enumeration AckServiceName

    List of all supported supported AWS services by ACK Addon.

    -

    Enumeration Members

    ACM +

    Enumeration Members

    ACM ACMPCA APIGATEWAYV2 APPLICATIONAUTOSCALING @@ -33,4 +33,4 @@ SFN SNS SQS -

    Enumeration Members

    ACM

    ACM: "acm"

    ACMPCA

    ACMPCA: "acmpca"

    APIGATEWAYV2

    APIGATEWAYV2: "apigatewayv2"

    APPLICATIONAUTOSCALING

    APPLICATIONAUTOSCALING: "applicationautoscaling"

    CLOUDTRAIL

    CLOUDTRAIL: "cloudtrail"

    CLOUDWATCH

    CLOUDWATCH: "cloudwatch"

    CLOUDWATCHLOGS

    CLOUDWATCHLOGS: "cloudwatchlogs"

    DYNAMODB

    DYNAMODB: "dynamodb"

    EC2

    EC2: "ec2"

    ECR

    ECR: "ecr"

    EKS

    EKS: "eks"

    ELASTICACHE

    ELASTICACHE: "elasticache"

    ELASTICSEARCHSERVICE

    ELASTICSEARCHSERVICE: "elasticsearchservice"

    EMRCONTAINERS

    EMRCONTAINERS: "emrcontainers"

    EVENTBRIDGE

    EVENTBRIDGE: "eventbridge"

    IAM

    IAM: "iam"

    KAFKA

    KAFKA: "kafka"

    KINESIS

    KINESIS: "kinesis"

    KMS

    KMS: "kms"

    LAMBDA

    LAMBDA: "lambda"

    MEMORYDB

    MEMORYDB: "memorydb"

    MQ

    MQ: "mq"

    OPENSEARCHSERVICE

    OPENSEARCHSERVICE: "opensearchservice"

    PIPES

    PIPES: "pipes"

    PROMETHEUSSERVICE

    PROMETHEUSSERVICE: "prometheusservice"

    RDS

    RDS: "rds"

    ROUTE53

    ROUTE53: "route53"

    ROUTE53RESOLVER

    ROUTE53RESOLVER: "route53resolver"

    S3

    S3: "s3"

    SAGEMAKER

    SAGEMAKER: "sagemaker"

    SECRETSMANAGER

    SECRETSMANAGER: "secretsmanager"

    SFN

    SFN: "sfn"

    SNS

    SNS: "sns"

    SQS

    SQS: "sqs"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file +

    Enumeration Members

    ACM

    ACM: "acm"

    ACMPCA

    ACMPCA: "acmpca"

    APIGATEWAYV2

    APIGATEWAYV2: "apigatewayv2"

    APPLICATIONAUTOSCALING

    APPLICATIONAUTOSCALING: "applicationautoscaling"

    CLOUDTRAIL

    CLOUDTRAIL: "cloudtrail"

    CLOUDWATCH

    CLOUDWATCH: "cloudwatch"

    CLOUDWATCHLOGS

    CLOUDWATCHLOGS: "cloudwatchlogs"

    DYNAMODB

    DYNAMODB: "dynamodb"

    EC2

    EC2: "ec2"

    ECR

    ECR: "ecr"

    EKS

    EKS: "eks"

    ELASTICACHE

    ELASTICACHE: "elasticache"

    ELASTICSEARCHSERVICE

    ELASTICSEARCHSERVICE: "elasticsearchservice"

    EMRCONTAINERS

    EMRCONTAINERS: "emrcontainers"

    EVENTBRIDGE

    EVENTBRIDGE: "eventbridge"

    IAM

    IAM: "iam"

    KAFKA

    KAFKA: "kafka"

    KINESIS

    KINESIS: "kinesis"

    KMS

    KMS: "kms"

    LAMBDA

    LAMBDA: "lambda"

    MEMORYDB

    MEMORYDB: "memorydb"

    MQ

    MQ: "mq"

    OPENSEARCHSERVICE

    OPENSEARCHSERVICE: "opensearchservice"

    PIPES

    PIPES: "pipes"

    PROMETHEUSSERVICE

    PROMETHEUSSERVICE: "prometheusservice"

    RDS

    RDS: "rds"

    ROUTE53

    ROUTE53: "route53"

    ROUTE53RESOLVER

    ROUTE53RESOLVER: "route53resolver"

    S3

    S3: "s3"

    SAGEMAKER

    SAGEMAKER: "sagemaker"

    SECRETSMANAGER

    SECRETSMANAGER: "secretsmanager"

    SFN

    SFN: "sfn"

    SNS

    SNS: "sns"

    SQS

    SQS: "sqs"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file diff --git a/api/enums/addons.DeploymentMode.html b/api/enums/addons.DeploymentMode.html index 7b02ca20f..311d28154 100644 --- a/api/enums/addons.DeploymentMode.html +++ b/api/enums/addons.DeploymentMode.html @@ -1,5 +1,5 @@ -DeploymentMode | @aws-quickstart/eks-blueprints

    Enumeration DeploymentModeConst

    Enumeration Members

    DAEMONSET +DeploymentMode | @aws-quickstart/eks-blueprints

    Enumeration DeploymentModeConst

    Enumeration Members

    DAEMONSET DEPLOYMENT SIDECAR STATEFULSET -

    Enumeration Members

    DAEMONSET

    DAEMONSET: "daemonset"

    DEPLOYMENT

    DEPLOYMENT: "deployment"

    SIDECAR

    SIDECAR: "sidecar"

    STATEFULSET

    STATEFULSET: "statefulset"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file +

    Enumeration Members

    DAEMONSET

    DAEMONSET: "daemonset"

    DEPLOYMENT

    DEPLOYMENT: "deployment"

    SIDECAR

    SIDECAR: "sidecar"

    STATEFULSET

    STATEFULSET: "statefulset"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file diff --git a/api/enums/addons.JupyterHubServiceType.html b/api/enums/addons.JupyterHubServiceType.html index 7144f91b3..f7f3966cd 100644 --- a/api/enums/addons.JupyterHubServiceType.html +++ b/api/enums/addons.JupyterHubServiceType.html @@ -1,8 +1,8 @@ JupyterHubServiceType | @aws-quickstart/eks-blueprints

    Enumeration JupyterHubServiceType

    Configuration options for exposing the JupyterHub proxy

    -

    Enumeration Members

    ALB +

    Enumeration Members

    ALB CLUSTERIP NLB

    Enumeration Members

    ALB

    ALB: 0

    Expose the service using AWS Application Load Balancer + Ingress controller

    -

    CLUSTERIP

    CLUSTERIP: 2

    Use ClusterIP service type and allow customers to port-forward for localhost access

    -

    NLB

    NLB: 1

    Expose the service using AWS Network Load Balancer + LoadBalancer service

    -

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file +

    CLUSTERIP

    CLUSTERIP: 2

    Use ClusterIP service type and allow customers to port-forward for localhost access

    +

    NLB

    NLB: 1

    Expose the service using AWS Network Load Balancer + LoadBalancer service

    +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file diff --git a/api/enums/addons.KubernetesSecretType.html b/api/enums/addons.KubernetesSecretType.html index d9d61006f..f02707478 100644 --- a/api/enums/addons.KubernetesSecretType.html +++ b/api/enums/addons.KubernetesSecretType.html @@ -1,4 +1,4 @@ -KubernetesSecretType | @aws-quickstart/eks-blueprints

    Enumeration KubernetesSecretType

    Enumeration Members

    BASIC_AUTH +KubernetesSecretType | @aws-quickstart/eks-blueprints

    Enumeration KubernetesSecretType

    Enumeration Members

    BASIC_AUTH DOCKER_CONFIG DOCKER_CONFIG_JSON OPAQUE @@ -6,4 +6,4 @@ SSH_AUTH TLS TOKEN -

    Enumeration Members

    BASIC_AUTH

    BASIC_AUTH: "kubernetes.io/basic-auth"

    DOCKER_CONFIG

    DOCKER_CONFIG: "kubernetes.io/dockercfg"

    DOCKER_CONFIG_JSON

    DOCKER_CONFIG_JSON: "kubernetes.io/dockerconfigjson"

    OPAQUE

    OPAQUE: "Opaque"

    SERVICE_ACCOUNT_TOKEN

    SERVICE_ACCOUNT_TOKEN: "kubernetes.io/service-account-token"

    SSH_AUTH

    SSH_AUTH: "kubernetes.io/ssh-auth"

    TLS

    TLS: "kubernetes.io/tls"

    TOKEN

    TOKEN: "bootstrap.kubernetes.io/token"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file +

    Enumeration Members

    BASIC_AUTH

    BASIC_AUTH: "kubernetes.io/basic-auth"

    DOCKER_CONFIG

    DOCKER_CONFIG: "kubernetes.io/dockercfg"

    DOCKER_CONFIG_JSON

    DOCKER_CONFIG_JSON: "kubernetes.io/dockerconfigjson"

    OPAQUE

    OPAQUE: "Opaque"

    SERVICE_ACCOUNT_TOKEN

    SERVICE_ACCOUNT_TOKEN: "kubernetes.io/service-account-token"

    SSH_AUTH

    SSH_AUTH: "kubernetes.io/ssh-auth"

    TLS

    TLS: "kubernetes.io/tls"

    TOKEN

    TOKEN: "bootstrap.kubernetes.io/token"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file diff --git a/api/enums/addons.Mode.html b/api/enums/addons.Mode.html index b85bff043..1411bd30b 100644 --- a/api/enums/addons.Mode.html +++ b/api/enums/addons.Mode.html @@ -1,6 +1,6 @@ Mode | @aws-quickstart/eks-blueprints

    Enumeration Mode

    Supported Modes

    -

    Enumeration Members

    IMDS +

    Enumeration Members

    IMDS QUEUE

    Enumeration Members

    IMDS

    IMDS: 0

    IMDS Mode

    -

    QUEUE

    QUEUE: 1

    Queue Mode

    -

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file +

    QUEUE

    QUEUE: 1

    Queue Mode

    +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file diff --git a/api/enums/addons.cloudWatchDeploymentMode.html b/api/enums/addons.cloudWatchDeploymentMode.html index ddd548529..8ea3f3205 100644 --- a/api/enums/addons.cloudWatchDeploymentMode.html +++ b/api/enums/addons.cloudWatchDeploymentMode.html @@ -1,5 +1,5 @@ -cloudWatchDeploymentMode | @aws-quickstart/eks-blueprints

    Enumeration cloudWatchDeploymentModeConst

    Enumeration Members

    DAEMONSET +cloudWatchDeploymentMode | @aws-quickstart/eks-blueprints

    Enumeration cloudWatchDeploymentModeConst

    Enumeration Members

    DAEMONSET DEPLOYMENT SIDECAR STATEFULSET -

    Enumeration Members

    DAEMONSET

    DAEMONSET: "daemonset"

    DEPLOYMENT

    DEPLOYMENT: "deployment"

    SIDECAR

    SIDECAR: "sidecar"

    STATEFULSET

    STATEFULSET: "statefulset"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file +

    Enumeration Members

    DAEMONSET

    DAEMONSET: "daemonset"

    DEPLOYMENT

    DEPLOYMENT: "deployment"

    SIDECAR

    SIDECAR: "sidecar"

    STATEFULSET

    STATEFULSET: "statefulset"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file diff --git a/api/enums/addons.xrayDeploymentMode.html b/api/enums/addons.xrayDeploymentMode.html index 4e5dfd78f..7c78ea5c6 100644 --- a/api/enums/addons.xrayDeploymentMode.html +++ b/api/enums/addons.xrayDeploymentMode.html @@ -1,5 +1,5 @@ -xrayDeploymentMode | @aws-quickstart/eks-blueprints

    Enumeration xrayDeploymentModeConst

    Enumeration Members

    DAEMONSET +xrayDeploymentMode | @aws-quickstart/eks-blueprints

    Enumeration xrayDeploymentModeConst

    Enumeration Members

    DAEMONSET DEPLOYMENT SIDECAR STATEFULSET -

    Enumeration Members

    DAEMONSET

    DAEMONSET: "daemonset"

    DEPLOYMENT

    DEPLOYMENT: "deployment"

    SIDECAR

    SIDECAR: "sidecar"

    STATEFULSET

    STATEFULSET: "statefulset"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file +

    Enumeration Members

    DAEMONSET

    DAEMONSET: "daemonset"

    DEPLOYMENT

    DEPLOYMENT: "deployment"

    SIDECAR

    SIDECAR: "sidecar"

    STATEFULSET

    STATEFULSET: "statefulset"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file diff --git a/api/enums/teams.BatchAllocationStrategy.html b/api/enums/teams.BatchAllocationStrategy.html index 53aecee3a..0cdcc72c9 100644 --- a/api/enums/teams.BatchAllocationStrategy.html +++ b/api/enums/teams.BatchAllocationStrategy.html @@ -3,6 +3,6 @@ Instance types with a lower cost for each unit vCPU are preferred. Spot - Spot Capacity Optimized: AWS Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. Instance types that are less likely to be interrupted are preferred. This allocation strategy is only available for Spot Instance compute resources.

    -

    Enumeration Members

    BEST +

    Enumeration Members

    BEST SPOT -

    Enumeration Members

    BEST

    BEST: "BEST_FIT_PROGRESSIVE"

    SPOT

    SPOT: "SPOT_CAPACITY_OPTIMIZED"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file +

    Enumeration Members

    BEST

    BEST: "BEST_FIT_PROGRESSIVE"

    SPOT

    SPOT: "SPOT_CAPACITY_OPTIMIZED"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file diff --git a/api/enums/teams.BatchEnvType.html b/api/enums/teams.BatchEnvType.html index 763a67cd6..0f78cffe2 100644 --- a/api/enums/teams.BatchEnvType.html +++ b/api/enums/teams.BatchEnvType.html @@ -1,6 +1,6 @@ BatchEnvType | @aws-quickstart/eks-blueprints

    Enumeration BatchEnvTypeConst

    Enum for Batch Compute Environment Type

    -

    Enumeration Members

    EC2 +

    Enumeration Members

    EC2 FARGATE FARGATE_SPOT SPOT -

    Enumeration Members

    EC2

    EC2: "EC2"

    FARGATE

    FARGATE: "FARGATE"

    FARGATE_SPOT

    FARGATE_SPOT: "FARGATE_SPOT"

    SPOT

    SPOT: "SPOT"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file +

    Enumeration Members

    EC2

    EC2: "EC2"

    FARGATE

    FARGATE: "FARGATE"

    FARGATE_SPOT

    FARGATE_SPOT: "FARGATE_SPOT"

    SPOT

    SPOT: "SPOT"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file diff --git a/api/enums/utils.ArchType.html b/api/enums/utils.ArchType.html index 027e1d092..be535027e 100644 --- a/api/enums/utils.ArchType.html +++ b/api/enums/utils.ArchType.html @@ -1,3 +1,3 @@ -ArchType | @aws-quickstart/eks-blueprints

    Enumeration ArchType

    Enumeration Members

    ARM +ArchType | @aws-quickstart/eks-blueprints

    Enumeration ArchType

    Enumeration Members

    ARM X86 -

    Enumeration Members

    ARM

    ARM: "arm"

    X86

    X86: "x86"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file +

    Enumeration Members

    ARM

    ARM: "arm"

    X86

    X86: "x86"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    \ No newline at end of file diff --git a/api/functions/addons.createArgoHelmApplication.html b/api/functions/addons.createArgoHelmApplication.html index e55f323dc..226d9d767 100644 --- a/api/functions/addons.createArgoHelmApplication.html +++ b/api/functions/addons.createArgoHelmApplication.html @@ -1 +1 @@ -createArgoHelmApplication | @aws-quickstart/eks-blueprints

    Function createArgoHelmApplication

    Settings

    Member Visibility
    \ No newline at end of file +createArgoHelmApplication | @aws-quickstart/eks-blueprints

    Function createArgoHelmApplication

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/addons.generateArgoHelmApplicationValues.html b/api/functions/addons.generateArgoHelmApplicationValues.html index a7ee6c54a..f8983923c 100644 --- a/api/functions/addons.generateArgoHelmApplicationValues.html +++ b/api/functions/addons.generateArgoHelmApplicationValues.html @@ -1 +1 @@ -generateArgoHelmApplicationValues | @aws-quickstart/eks-blueprints

    Function generateArgoHelmApplicationValues

    Settings

    Member Visibility
    \ No newline at end of file +generateArgoHelmApplicationValues | @aws-quickstart/eks-blueprints

    Function generateArgoHelmApplicationValues

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/clusters.assertEC2NodeGroup.html b/api/functions/clusters.assertEC2NodeGroup.html index fc0148268..aea70bdc7 100644 --- a/api/functions/clusters.assertEC2NodeGroup.html +++ b/api/functions/clusters.assertEC2NodeGroup.html @@ -1,3 +1,3 @@ assertEC2NodeGroup | @aws-quickstart/eks-blueprints

    Function assertEC2NodeGroup

    • assertEC2NodeGroup(clusterInfo, source): eks.Nodegroup[] | asg.AutoScalingGroup[]

    • Validates that cluster is backed by EC2 either through a managed node group or through a self-managed autoscaling group.

      Parameters

      • clusterInfo: ClusterInfo
      • source: string

        Used for error message to identify the source of the check

        -

      Returns eks.Nodegroup[] | asg.AutoScalingGroup[]

    Settings

    Member Visibility
    \ No newline at end of file +

    Returns eks.Nodegroup[] | asg.AutoScalingGroup[]

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/clusters.clusterBuilder-1.html b/api/functions/clusters.clusterBuilder-1.html index 12cb6e56a..9bfcb7994 100644 --- a/api/functions/clusters.clusterBuilder-1.html +++ b/api/functions/clusters.clusterBuilder-1.html @@ -1 +1 @@ -clusterBuilder | @aws-quickstart/eks-blueprints

    Function clusterBuilder

    Settings

    Member Visibility
    \ No newline at end of file +clusterBuilder | @aws-quickstart/eks-blueprints

    Function clusterBuilder

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/clusters.describeCluster.html b/api/functions/clusters.describeCluster.html index f731982b4..66c047de7 100644 --- a/api/functions/clusters.describeCluster.html +++ b/api/functions/clusters.describeCluster.html @@ -1,2 +1,2 @@ describeCluster | @aws-quickstart/eks-blueprints

    Function describeCluster

    Settings

    Member Visibility
    \ No newline at end of file +

    Parameters

    • clusterName: string
    • region: string

    Returns Promise<sdk.Cluster>

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/clusters.selectKubectlLayer.html b/api/functions/clusters.selectKubectlLayer.html index a868c98d1..de74c9005 100644 --- a/api/functions/clusters.selectKubectlLayer.html +++ b/api/functions/clusters.selectKubectlLayer.html @@ -2,4 +2,4 @@

    Parameters

    • scope: Construct

      in whch the kubectl layer must be created

    • version: KubernetesVersion

      EKS version

    Returns ILayerVersion | undefined

    ILayerVersion or undefined

    -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/pipelines.isCodeCommitRepo.html b/api/functions/pipelines.isCodeCommitRepo.html index ec5ea73a1..9216edcc9 100644 --- a/api/functions/pipelines.isCodeCommitRepo.html +++ b/api/functions/pipelines.isCodeCommitRepo.html @@ -1 +1 @@ -isCodeCommitRepo | @aws-quickstart/eks-blueprints

    Function isCodeCommitRepo

    Settings

    Member Visibility
    \ No newline at end of file +isCodeCommitRepo | @aws-quickstart/eks-blueprints

    Function isCodeCommitRepo

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/pipelines.isCodeStarConnection.html b/api/functions/pipelines.isCodeStarConnection.html index 435abdc4e..281f4a052 100644 --- a/api/functions/pipelines.isCodeStarConnection.html +++ b/api/functions/pipelines.isCodeStarConnection.html @@ -1 +1 @@ -isCodeStarConnection | @aws-quickstart/eks-blueprints

    Function isCodeStarConnection

    Settings

    Member Visibility
    \ No newline at end of file +isCodeStarConnection | @aws-quickstart/eks-blueprints

    Function isCodeStarConnection

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/resources.getNamedResource.html b/api/functions/resources.getNamedResource.html index 2927bc39f..2946651ce 100644 --- a/api/functions/resources.getNamedResource.html +++ b/api/functions/resources.getNamedResource.html @@ -4,4 +4,4 @@

    Type Parameters

    • T extends IConstruct = IConstruct

    Parameters

    • resourceName: string

    Returns T

    Example

    const app = new cdk.App();
    const adminRole: iam.IRole = blueprints.getNamedResource("my-admin-role""); // note, there is no stack class here

    const clusterProvider = new blueprints.GenericClusterProvider({
        mastersRole: adminRole,
        ... other props
    });
    -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/resources.getResource.html b/api/functions/resources.getResource.html index 454a13c40..12fea21f0 100644 --- a/api/functions/resources.getResource.html +++ b/api/functions/resources.getResource.html @@ -4,4 +4,4 @@

    Type Parameters

    • T extends IResource = IResource

    Parameters

    Returns T

    Example

    const app = new cdk.App();
    const clusterProvider = new blueprints.GenericClusterProvider({
      mastersRole: blueprints.getResource(context => { // will generate a unique name for resource. 
           return new iam.Role(context.scope, 'AdminRole', { assumedBy: new AccountRootPrincipal()});
       }),
       ... other props
    });
    -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.applyYamlFromDir.html b/api/functions/utils.applyYamlFromDir.html index 15056f4bd..e4ed7ec80 100644 --- a/api/functions/utils.applyYamlFromDir.html +++ b/api/functions/utils.applyYamlFromDir.html @@ -1,3 +1,3 @@ applyYamlFromDir | @aws-quickstart/eks-blueprints

    Function applyYamlFromDir

    • applyYamlFromDir(dir, cluster, namespaceManifest): void

    • Applies all manifests from a directory. Note: The manifests are not checked, so user must ensure the manifests have the correct namespaces.

      -

      Parameters

      • dir: string
      • cluster: ICluster
      • namespaceManifest: KubernetesManifest

      Returns void

    Settings

    Member Visibility
    \ No newline at end of file +

    Parameters

    • dir: string
    • cluster: ICluster
    • namespaceManifest: KubernetesManifest

    Returns void

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.atob.html b/api/functions/utils.atob.html index 1ec209877..dd81f2bc9 100644 --- a/api/functions/utils.atob.html +++ b/api/functions/utils.atob.html @@ -1,2 +1,2 @@ atob | @aws-quickstart/eks-blueprints

    Function atob

    Settings

    Member Visibility
    \ No newline at end of file +

    Parameters

    • b64Encoded: string

    Returns string

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.btoa.html b/api/functions/utils.btoa.html index 929d9e3c3..d533fc3c8 100644 --- a/api/functions/utils.btoa.html +++ b/api/functions/utils.btoa.html @@ -1,2 +1,2 @@ btoa | @aws-quickstart/eks-blueprints

    Function btoa

    Settings

    Member Visibility
    \ No newline at end of file +

    Parameters

    • str: string

    Returns string

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.changeTextBetweenTokens.html b/api/functions/utils.changeTextBetweenTokens.html index a88a21cd9..97eeff2e6 100644 --- a/api/functions/utils.changeTextBetweenTokens.html +++ b/api/functions/utils.changeTextBetweenTokens.html @@ -1,3 +1,3 @@ changeTextBetweenTokens | @aws-quickstart/eks-blueprints

    Function changeTextBetweenTokens

    • changeTextBetweenTokens(str, openToken, closeToken, keep): string

    • Removes either text between given tokens or just the tokens themselves. Example use case: YAML manipulation similar to Helm: openToken = "{{ if ... }}", closeToken = "{{ end }}""

      -

      Parameters

      • str: string
      • openToken: string
      • closeToken: string
      • keep: boolean

      Returns string

    Settings

    Member Visibility
    \ No newline at end of file +

    Parameters

    • str: string
    • openToken: string
    • closeToken: string
    • keep: boolean

    Returns string

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.cloneDeep.html b/api/functions/utils.cloneDeep.html index 268a3e296..f79596537 100644 --- a/api/functions/utils.cloneDeep.html +++ b/api/functions/utils.cloneDeep.html @@ -1,3 +1,3 @@ cloneDeep | @aws-quickstart/eks-blueprints

    Function cloneDeep

    • cloneDeep<T>(source, resolveFn?): T

    • Creates a deep clone of an object, retaining types.

      Type Parameters

      • T

      Parameters

      • source: T
      • OptionalresolveFn: ((arg: any) => any)

        if passed, this function can perform transformation (e.g. resolve proxies)

        -
          • (arg): any

          • Parameters

            • arg: any

            Returns any

      Returns T

    Settings

    Member Visibility
    \ No newline at end of file +

    Returns T

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.conflictsWith.html b/api/functions/utils.conflictsWith.html index c2bbf9de9..58ae5ce64 100644 --- a/api/functions/utils.conflictsWith.html +++ b/api/functions/utils.conflictsWith.html @@ -1,4 +1,4 @@ conflictsWith | @aws-quickstart/eks-blueprints

    Function conflictsWith

    • conflictsWith(...addOns): ((target: Object, key: string | symbol, descriptor: PropertyDescriptor) => PropertyDescriptor)

    • Decorator function that accepts a list of AddOns and throws error if those addons are scheduled to be added as well As they should not be deployed with

      -

      Parameters

      • Rest...addOns: string[]

      Returns ((target: Object, key: string | symbol, descriptor: PropertyDescriptor) => PropertyDescriptor)

        • (target, key, descriptor): PropertyDescriptor

        • Parameters

          • target: Object
          • key: string | symbol
          • descriptor: PropertyDescriptor

          Returns PropertyDescriptor

    Settings

    Member Visibility
    \ No newline at end of file +

    Parameters

    • Rest...addOns: string[]

    Returns ((target: Object, key: string | symbol, descriptor: PropertyDescriptor) => PropertyDescriptor)

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.createNamespace.html b/api/functions/utils.createNamespace.html index 941f7d70b..4f77a09bc 100644 --- a/api/functions/utils.createNamespace.html +++ b/api/functions/utils.createNamespace.html @@ -1,4 +1,4 @@ createNamespace | @aws-quickstart/eks-blueprints

    Function createNamespace

    • createNamespace(name, cluster, overwrite?, prune?, annotations?, labels?): KubernetesManifest

    • Creates namespace (a prerequisite for serviceaccount and helm chart execution for many add-ons).

      Parameters

      • name: string
      • cluster: ICluster
      • Optionaloverwrite: boolean
      • Optionalprune: boolean
      • Optionalannotations: Values
      • Optionallabels: Values

      Returns KubernetesManifest

      KubernetesManifest

      -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.createServiceAccount.html b/api/functions/utils.createServiceAccount.html index e16459710..80f53f969 100644 --- a/api/functions/utils.createServiceAccount.html +++ b/api/functions/utils.createServiceAccount.html @@ -1,3 +1,3 @@ createServiceAccount | @aws-quickstart/eks-blueprints

    Function createServiceAccount

    • createServiceAccount(cluster, name, namespace, policyDocument): ServiceAccount

    • Creates a service account that can access secrets

      Parameters

      • cluster: ICluster
      • name: string
      • namespace: string
      • policyDocument: PolicyDocument

      Returns ServiceAccount

      sa

      -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.createServiceAccountWithPolicy.html b/api/functions/utils.createServiceAccountWithPolicy.html index 97d0a7f72..12c35dd63 100644 --- a/api/functions/utils.createServiceAccountWithPolicy.html +++ b/api/functions/utils.createServiceAccountWithPolicy.html @@ -1 +1 @@ -createServiceAccountWithPolicy | @aws-quickstart/eks-blueprints

    Function createServiceAccountWithPolicy

    • createServiceAccountWithPolicy(cluster, name, namespace, ...policies): ServiceAccount

    • Parameters

      • cluster: ICluster
      • name: string
      • namespace: string
      • Rest...policies: IManagedPolicy[]

      Returns ServiceAccount

    Settings

    Member Visibility
    \ No newline at end of file +createServiceAccountWithPolicy | @aws-quickstart/eks-blueprints

    Function createServiceAccountWithPolicy

    • createServiceAccountWithPolicy(cluster, name, namespace, ...policies): ServiceAccount

    • Parameters

      • cluster: ICluster
      • name: string
      • namespace: string
      • Rest...policies: IManagedPolicy[]

      Returns ServiceAccount

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.dependable.html b/api/functions/utils.dependable.html index bfcf5b2fb..3a175519c 100644 --- a/api/functions/utils.dependable.html +++ b/api/functions/utils.dependable.html @@ -1,4 +1,4 @@ dependable | @aws-quickstart/eks-blueprints

    Function dependable

    • dependable(...addOns): ((target: any, key: string | symbol, descriptor: PropertyDescriptor) => PropertyDescriptor)

    • Decorator function that accepts a list of AddOns and ensures addons are scheduled to be added as well as add them as dependencies

      -

      Parameters

      • Rest...addOns: string[]

      Returns ((target: any, key: string | symbol, descriptor: PropertyDescriptor) => PropertyDescriptor)

        • (target, key, descriptor): PropertyDescriptor

        • Parameters

          • target: any
          • key: string | symbol
          • descriptor: PropertyDescriptor

          Returns PropertyDescriptor

    Settings

    Member Visibility
    \ No newline at end of file +

    Parameters

    • Rest...addOns: string[]

    Returns ((target: any, key: string | symbol, descriptor: PropertyDescriptor) => PropertyDescriptor)

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.deployBeforeCapacity.html b/api/functions/utils.deployBeforeCapacity.html index 2d08f632b..e883772f3 100644 --- a/api/functions/utils.deployBeforeCapacity.html +++ b/api/functions/utils.deployBeforeCapacity.html @@ -2,4 +2,4 @@ Useful for control plane add-ons, such as VPC-CNI that must be provisioned before EC2 (or Fargate) capacity is added.

    Parameters

    • construct: Construct

      identifies construct (such as core add-on) that should be provisioned before capacity

    • clusterInfo: ClusterInfo

      cluster provisioning context

      -

    Returns void

    Settings

    Member Visibility
    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.escapeDots.html b/api/functions/utils.escapeDots.html index 1c79d2afe..6505acf49 100644 --- a/api/functions/utils.escapeDots.html +++ b/api/functions/utils.escapeDots.html @@ -1,2 +1,2 @@ escapeDots | @aws-quickstart/eks-blueprints

    Function escapeDots

    Settings

    Member Visibility
    \ No newline at end of file +

    Parameters

    • str: string

    Returns string

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.getAddOnNameOrId.html b/api/functions/utils.getAddOnNameOrId.html index 8060fd6a6..07c4c25b9 100644 --- a/api/functions/utils.getAddOnNameOrId.html +++ b/api/functions/utils.getAddOnNameOrId.html @@ -1,3 +1,3 @@ getAddOnNameOrId | @aws-quickstart/eks-blueprints

    Function getAddOnNameOrId

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.getSecretValue.html b/api/functions/utils.getSecretValue.html index 6008addd8..bf3bf5956 100644 --- a/api/functions/utils.getSecretValue.html +++ b/api/functions/utils.getSecretValue.html @@ -1,3 +1,3 @@ getSecretValue | @aws-quickstart/eks-blueprints

    Function getSecretValue

    • getSecretValue(secretName, region): Promise<string>

    • Gets secret value from AWS Secret Manager. Requires access rights to the secret, specified by the secretName parameter.

      Parameters

      • secretName: string

        name of the secret to retrieve

        -
      • region: string

      Returns Promise<string>

    Settings

    Member Visibility
    \ No newline at end of file +
  • region: string

    • Returns Promise<string>

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.isOrderedAddOn.html b/api/functions/utils.isOrderedAddOn.html index cb8d67bb4..40456891e 100644 --- a/api/functions/utils.isOrderedAddOn.html +++ b/api/functions/utils.isOrderedAddOn.html @@ -1 +1 @@ -isOrderedAddOn | @aws-quickstart/eks-blueprints

    Function isOrderedAddOn

    Settings

    Member Visibility
    \ No newline at end of file +isOrderedAddOn | @aws-quickstart/eks-blueprints

    Function isOrderedAddOn

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.isSupportedArchitecture.html b/api/functions/utils.isSupportedArchitecture.html index 92b87357f..46caadedf 100644 --- a/api/functions/utils.isSupportedArchitecture.html +++ b/api/functions/utils.isSupportedArchitecture.html @@ -1,4 +1,4 @@ isSupportedArchitecture | @aws-quickstart/eks-blueprints

    Function isSupportedArchitecture

    • isSupportedArchitecture(addOnName, arch): boolean | undefined

    • Returns true of false depending on if the passed addon is supported by the passed architecture

      Parameters

      Returns boolean | undefined

      boolean

      -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.kebabToCamel.html b/api/functions/utils.kebabToCamel.html index 4260d7ec7..1e5876b5f 100644 --- a/api/functions/utils.kebabToCamel.html +++ b/api/functions/utils.kebabToCamel.html @@ -1,2 +1,2 @@ kebabToCamel | @aws-quickstart/eks-blueprints

    Function kebabToCamel

    • kebabToCamel(str): string

    • Convert kebab case string to camel case

      -

      Parameters

      • str: string

      Returns string

    Settings

    Member Visibility
    \ No newline at end of file +

    Parameters

    • str: string

    Returns string

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.loadExternalYaml.html b/api/functions/utils.loadExternalYaml.html index 7fc1a987d..3833d8715 100644 --- a/api/functions/utils.loadExternalYaml.html +++ b/api/functions/utils.loadExternalYaml.html @@ -3,4 +3,4 @@ not validated, so user must ensure the URL contains a valid manifest.

    Parameters

    • url: string

      YAML document URL

    Returns any

    a list of parsed YAML documents

    -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.loadMultiResourceYaml.html b/api/functions/utils.loadMultiResourceYaml.html index f587be0eb..81530e596 100644 --- a/api/functions/utils.loadMultiResourceYaml.html +++ b/api/functions/utils.loadMultiResourceYaml.html @@ -2,4 +2,4 @@ multiple YAML documents separated by --- as expected in a Kubernetes manifest file

    Parameters

    • path: string

      YAML document path

    Returns any

    a list of parsed YAML documents

    -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.loadYaml.html b/api/functions/utils.loadYaml.html index 32c3fbada..8ad719d13 100644 --- a/api/functions/utils.loadYaml.html +++ b/api/functions/utils.loadYaml.html @@ -1,4 +1,4 @@ loadYaml | @aws-quickstart/eks-blueprints

    Function loadYaml

    • loadYaml(document): any

    • Parses the sting document into a single YAML document

      Parameters

      • document: string

        document

      Returns any

      yaml document

      -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.podIdentityAssociation.html b/api/functions/utils.podIdentityAssociation.html index 3734ea9c4..135c0e352 100644 --- a/api/functions/utils.podIdentityAssociation.html +++ b/api/functions/utils.podIdentityAssociation.html @@ -1,3 +1,3 @@ podIdentityAssociation | @aws-quickstart/eks-blueprints

    Function podIdentityAssociation

    • podIdentityAssociation(cluster, name, namespace, policyDocument): CfnPodIdentityAssociation

    • Creates IAM role and EKS Pod Identity association

      Parameters

      • cluster: ICluster
      • name: string
      • namespace: string
      • policyDocument: PolicyDocument

      Returns CfnPodIdentityAssociation

      podIdentityAssociation

      -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.readYamlDocument.html b/api/functions/utils.readYamlDocument.html index bef87175a..ce062d965 100644 --- a/api/functions/utils.readYamlDocument.html +++ b/api/functions/utils.readYamlDocument.html @@ -1,4 +1,4 @@ readYamlDocument | @aws-quickstart/eks-blueprints

    Function readYamlDocument

    • readYamlDocument(path): string

    • Reads the YAML document from a local path.

      Parameters

      • path: string

        YAML document path

      Returns string

      YAML document string

      -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.resolveTarget.html b/api/functions/utils.resolveTarget.html index 3a7aeb378..3fe1764ac 100644 --- a/api/functions/utils.resolveTarget.html +++ b/api/functions/utils.resolveTarget.html @@ -1,4 +1,4 @@ resolveTarget | @aws-quickstart/eks-blueprints

    Function resolveTarget

    • resolveTarget(value, arg): any

    • Function resolves the proxy with the target, that enables lazy loading use cases.

      Parameters

      • value: any

        potential proxy to resolve

      • arg: any

        represents the argument that should be passed to the resolution function (sourceFunction).

        -

      Returns any

    Settings

    Member Visibility
    \ No newline at end of file +

    Returns any

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.serializeYaml.html b/api/functions/utils.serializeYaml.html index 05725a91d..2c2ae1d45 100644 --- a/api/functions/utils.serializeYaml.html +++ b/api/functions/utils.serializeYaml.html @@ -1,4 +1,4 @@ serializeYaml | @aws-quickstart/eks-blueprints

    Function serializeYaml

    • serializeYaml(document): string

    • Serializes object as a YAML document

      Parameters

      • document: any

        document

      Returns string

      yaml document

      -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.setPath.html b/api/functions/utils.setPath.html index 050a56679..061ef4d65 100644 --- a/api/functions/utils.setPath.html +++ b/api/functions/utils.setPath.html @@ -1 +1 @@ -setPath | @aws-quickstart/eks-blueprints

    Function setPath

    Settings

    Member Visibility
    \ No newline at end of file +setPath | @aws-quickstart/eks-blueprints

    Function setPath

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.supportsALL.html b/api/functions/utils.supportsALL.html index ad230a7e4..81fae4ee4 100644 --- a/api/functions/utils.supportsALL.html +++ b/api/functions/utils.supportsALL.html @@ -1 +1 @@ -supportsALL | @aws-quickstart/eks-blueprints

    Function supportsALL

    Settings

    Member Visibility
    \ No newline at end of file +supportsALL | @aws-quickstart/eks-blueprints

    Function supportsALL

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.supportsARM.html b/api/functions/utils.supportsARM.html index 262596b88..22aa93e04 100644 --- a/api/functions/utils.supportsARM.html +++ b/api/functions/utils.supportsARM.html @@ -1 +1 @@ -supportsARM | @aws-quickstart/eks-blueprints

    Function supportsARM

    Settings

    Member Visibility
    \ No newline at end of file +supportsARM | @aws-quickstart/eks-blueprints

    Function supportsARM

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.supportsX86.html b/api/functions/utils.supportsX86.html index f4d6c41b3..c66db3abb 100644 --- a/api/functions/utils.supportsX86.html +++ b/api/functions/utils.supportsX86.html @@ -1,2 +1,2 @@ supportsX86 | @aws-quickstart/eks-blueprints

    Function supportsX86

    • supportsX86(constructor): void

    • Decorator function that adds this metatdata to globalmap.

      -

      Parameters

      • constructor: Function

      Returns void

    Settings

    Member Visibility
    \ No newline at end of file +

    Parameters

    • constructor: Function

    Returns void

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.tagAsg.html b/api/functions/utils.tagAsg.html index 941dc1008..844073d34 100644 --- a/api/functions/utils.tagAsg.html +++ b/api/functions/utils.tagAsg.html @@ -1,2 +1,2 @@ tagAsg | @aws-quickstart/eks-blueprints

    Function tagAsg

    • tagAsg(scope, autoScalingGroup, tags): void

    • Creates the node termination tag for the ASG

      -

      Parameters

      • scope: Construct
      • autoScalingGroup: string
      • tags: Tag[]

      Returns void

    Settings

    Member Visibility
    \ No newline at end of file +

    Parameters

    • scope: Construct
    • autoScalingGroup: string
    • tags: Tag[]

    Returns void

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.tagSecurityGroup.html b/api/functions/utils.tagSecurityGroup.html index 80eb5e90a..2e590b368 100644 --- a/api/functions/utils.tagSecurityGroup.html +++ b/api/functions/utils.tagSecurityGroup.html @@ -3,4 +3,4 @@
  • securityGroupId: string

    Security Group Resource ID

  • key: string

    Tag Key

  • value: string

    Tag Value

    -

    • Returns void

    Settings

    Member Visibility
    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.tagSubnets.html b/api/functions/utils.tagSubnets.html index 7bece4aa1..96b40d950 100644 --- a/api/functions/utils.tagSubnets.html +++ b/api/functions/utils.tagSubnets.html @@ -3,4 +3,4 @@
  • subnets: ISubnet[]

    a list of subnets

  • key: string

    Tag Key

  • value: string

    Tag Value

    -

    • Returns void

    Settings

    Member Visibility
    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.validateConstraints.html b/api/functions/utils.validateConstraints.html index 960dcd452..cdb9a4faa 100644 --- a/api/functions/utils.validateConstraints.html +++ b/api/functions/utils.validateConstraints.html @@ -3,4 +3,4 @@
  • context: string

    Object type name for error context purposes.

  • Rest...object: any

    The given object type, an array of or only a single object, to be validated.

    • Returns void

    throws a Zod Error if validations are broken.

    -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.validateSecret.html b/api/functions/utils.validateSecret.html index 1a87f0338..02102a758 100644 --- a/api/functions/utils.validateSecret.html +++ b/api/functions/utils.validateSecret.html @@ -1,3 +1,3 @@ validateSecret | @aws-quickstart/eks-blueprints

    Function validateSecret

    • validateSecret(secretName, region): Promise<string>

    • Throws an error if secret is undefined in the target region.

      Parameters

      • secretName: string
      • region: string

      Returns Promise<string>

      ARN of the secret if exists.

      -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.validateSupportedArchitecture.html b/api/functions/utils.validateSupportedArchitecture.html index 5672f2ec2..deaf54b15 100644 --- a/api/functions/utils.validateSupportedArchitecture.html +++ b/api/functions/utils.validateSupportedArchitecture.html @@ -1 +1 @@ -validateSupportedArchitecture | @aws-quickstart/eks-blueprints

    Function validateSupportedArchitecture

    Settings

    Member Visibility
    \ No newline at end of file +validateSupportedArchitecture | @aws-quickstart/eks-blueprints

    Function validateSupportedArchitecture

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.valueFromContext.html b/api/functions/utils.valueFromContext.html index 5fe3d2e6e..8a99d1384 100644 --- a/api/functions/utils.valueFromContext.html +++ b/api/functions/utils.valueFromContext.html @@ -1,2 +1,2 @@ valueFromContext | @aws-quickstart/eks-blueprints

    Function valueFromContext

    • valueFromContext(construct, key, defaultValue): any

    • Looks up default value from context (cdk.json, cdk.context.json and ~/.cdk.json)

      -

      Parameters

      • construct: Construct
      • key: string
      • defaultValue: any

      Returns any

    Settings

    Member Visibility
    \ No newline at end of file +

    Parameters

    • construct: Construct
    • key: string
    • defaultValue: any

    Returns any

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/functions/utils.withUsageTracking.html b/api/functions/utils.withUsageTracking.html index 6a4c4dcac..83afcb6fa 100644 --- a/api/functions/utils.withUsageTracking.html +++ b/api/functions/utils.withUsageTracking.html @@ -1,2 +1,2 @@ withUsageTracking | @aws-quickstart/eks-blueprints

    Function withUsageTracking

    • withUsageTracking(usageIdentifier, stackProps?): StackProps

    • Adds usage tracking info to the stack props

      -

      Parameters

      • usageIdentifier: string
      • OptionalstackProps: StackProps

      Returns StackProps

    Settings

    Member Visibility
    \ No newline at end of file +

    Parameters

    • usageIdentifier: string
    • OptionalstackProps: StackProps

    Returns StackProps

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/interfaces/ApplicationRepository.html b/api/interfaces/ApplicationRepository.html index d9f58b184..5de7d9611 100644 --- a/api/interfaces/ApplicationRepository.html +++ b/api/interfaces/ApplicationRepository.html @@ -1,5 +1,5 @@ ApplicationRepository | @aws-quickstart/eks-blueprints

    Interface ApplicationRepository

    Data type defining an application repository (git).

    -
    interface ApplicationRepository {
        credentialsSecretName?: string;
        credentialsType?: "USERNAME" | "TOKEN" | "SSH";
        name?: string;
        path?: string;
        repoUrl: string;
        targetRevision?: string;
    }

    Hierarchy (view full)

    Properties

    credentialsSecretName? +
    interface ApplicationRepository {
        credentialsSecretName?: string;
        credentialsType?: "USERNAME" | "TOKEN" | "SSH";
        name?: string;
        path?: string;
        repoUrl: string;
        targetRevision?: string;
    }

    Hierarchy (view full)

    Properties

    credentialsSecretName? credentialsType? name? path? @@ -7,15 +7,15 @@ targetRevision?

    Properties

    OptionalcredentialsSecretName

    credentialsSecretName?: string

    Secret from AWS Secrets Manager to import credentials to access the specified git repository. The secret must exist in the same region and account where the stack will run.

    -

    OptionalcredentialsType

    credentialsType?: "USERNAME" | "TOKEN" | "SSH"

    Depending on credentials type the arn should either point to an SSH key (plain text value) +

    OptionalcredentialsType

    credentialsType?: "USERNAME" | "TOKEN" | "SSH"

    Depending on credentials type the arn should either point to an SSH key (plain text value) or a json file with username/password attributes. For TOKEN type username can be any non-empty username and token value as password.

    -

    Optionalname

    name?: string

    Optional name for the bootstrap application

    -

    Optionalpath

    path?: string

    Path within the repository

    -

    repoUrl

    repoUrl: string

    Expected to support helm style repo at the moment

    -

    OptionaltargetRevision

    targetRevision?: string

    Optional target revision for the repository. +

    Optionalname

    name?: string

    Optional name for the bootstrap application

    +

    Optionalpath

    path?: string

    Path within the repository

    +

    repoUrl

    repoUrl: string

    Expected to support helm style repo at the moment

    +

    OptionaltargetRevision

    targetRevision?: string

    Optional target revision for the repository. TargetRevision defines the revision of the source to sync the application to. In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD. In case of Helm, this is a semver tag for the Chart's version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/AsyncStackBuilder.html b/api/interfaces/AsyncStackBuilder.html index cf87b71a4..fa8226ce1 100644 --- a/api/interfaces/AsyncStackBuilder.html +++ b/api/interfaces/AsyncStackBuilder.html @@ -1,4 +1,4 @@ AsyncStackBuilder | @aws-quickstart/eks-blueprints

    Interface AsyncStackBuilder

    Async extension for a stack builder to allow stacks produced asynchronously.

    -
    interface AsyncStackBuilder {
        build(scope: Construct, id: string, stackProps?: StackProps): Stack;
        buildAsync(scope: Construct, id: string, stackProps?: StackProps): Promise<Stack>;
    }

    Hierarchy (view full)

    Implemented by

    Methods

    build +
    interface AsyncStackBuilder {
        build(scope: Construct, id: string, stackProps?: StackProps): Stack;
        buildAsync(scope: Construct, id: string, stackProps?: StackProps): Promise<Stack>;
    }

    Hierarchy (view full)

    Implemented by

    Methods

    build buildAsync -

    Methods

    build

    buildAsync

    • buildAsync(scope, id, stackProps?): Promise<Stack>

    • Parameters

      • scope: Construct
      • id: string
      • OptionalstackProps: StackProps

      Returns Promise<Stack>

    Settings

    Member Visibility

    On This Page

    Methods
    \ No newline at end of file +

    Methods

    build

    buildAsync

    • buildAsync(scope, id, stackProps?): Promise<Stack>

    • Parameters

      • scope: Construct
      • id: string
      • OptionalstackProps: StackProps

      Returns Promise<Stack>

    Settings

    Member Visibility

    On This Page

    Methods
    \ No newline at end of file diff --git a/api/interfaces/BlockDeviceMapping.html b/api/interfaces/BlockDeviceMapping.html index 9bf77ed3b..1f503cc92 100644 --- a/api/interfaces/BlockDeviceMapping.html +++ b/api/interfaces/BlockDeviceMapping.html @@ -1,5 +1,5 @@ -BlockDeviceMapping | @aws-quickstart/eks-blueprints

    Interface BlockDeviceMapping

    interface BlockDeviceMapping {
        deviceName?: string;
        ebs?: EbsVolumeMapping;
        noDevice?: string;
        virtualName?: string;
    }

    Properties

    deviceName? +BlockDeviceMapping | @aws-quickstart/eks-blueprints

    Interface BlockDeviceMapping

    interface BlockDeviceMapping {
        deviceName?: string;
        ebs?: EbsVolumeMapping;
        noDevice?: string;
        virtualName?: string;
    }

    Properties

    deviceName? ebs? noDevice? virtualName? -

    Properties

    OptionaldeviceName

    deviceName?: string

    Optionalebs

    ebs?: EbsVolumeMapping

    OptionalnoDevice

    noDevice?: string

    OptionalvirtualName

    virtualName?: string

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Properties

    OptionaldeviceName

    deviceName?: string

    Optionalebs

    ebs?: EbsVolumeMapping

    OptionalnoDevice

    noDevice?: string

    OptionalvirtualName

    virtualName?: string

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/ClusterAddOn.html b/api/interfaces/ClusterAddOn.html index 15fa8a797..4e40fbaca 100644 --- a/api/interfaces/ClusterAddOn.html +++ b/api/interfaces/ClusterAddOn.html @@ -3,7 +3,7 @@ are resolved before the Teams setup() and postDeploy() methods are invoked. If void is returned, then no dependency features apply.

    Param: clusterInfo

    Returns

    Promise<cdk.Construct> | void

    -
    interface ClusterAddOn {
        id?: string;
        deploy(clusterInfo: ClusterInfo): void | Promise<Construct>;
    }

    Implemented by

    Properties

    id? +
    interface ClusterAddOn {
        id?: string;
        deploy(clusterInfo: ClusterInfo): void | Promise<Construct>;
    }

    Implemented by

    Properties

    id?

    Methods

    deploy

    Properties

    Optionalid

    id?: string

    Optional identifier of the addon. This is needed for add-ons that can be added multiple times to the blueprint.

    -

    Methods

    deploy

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    \ No newline at end of file +

    Methods

    deploy

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    \ No newline at end of file diff --git a/api/interfaces/ClusterPostDeploy.html b/api/interfaces/ClusterPostDeploy.html index 5b992d205..b9b36ed72 100644 --- a/api/interfaces/ClusterPostDeploy.html +++ b/api/interfaces/ClusterPostDeploy.html @@ -1,5 +1,5 @@ ClusterPostDeploy | @aws-quickstart/eks-blueprints

    Interface ClusterPostDeploy

    Optional interface to allow cluster bootstrapping after provisioning of add-ons and teams is complete. Can be leveraged to bootstrap workloads, perform cluster checks. ClusterAddOn implementation may implement this interface in order to get post deployment hook point.

    -
    interface ClusterPostDeploy {
        postDeploy(clusterInfo: ClusterInfo, teams: Team[]): void;
    }

    Implemented by

    Methods

    postDeploy -

    Methods

    postDeploy

    Settings

    Member Visibility

    On This Page

    Methods
    \ No newline at end of file +
    interface ClusterPostDeploy {
        postDeploy(clusterInfo: ClusterInfo, teams: Team[]): void;
    }

    Implemented by

    Methods

    postDeploy +

    Methods

    postDeploy

    Settings

    Member Visibility

    On This Page

    Methods
    \ No newline at end of file diff --git a/api/interfaces/ClusterProvider.html b/api/interfaces/ClusterProvider.html index 918f0c24f..ddcba20b6 100644 --- a/api/interfaces/ClusterProvider.html +++ b/api/interfaces/ClusterProvider.html @@ -1,3 +1,3 @@ ClusterProvider | @aws-quickstart/eks-blueprints

    Interface ClusterProvider

    ClusterProvider is the interface to which all Cluster Providers should conform.

    -
    interface ClusterProvider {
        createCluster(scope: Construct, vpc: IVpc, secretsEncryptionKey?: IKey, kubernetesVersion?: KubernetesVersion, clusterLogging?: ControlPlaneLogType[]): ClusterInfo;
    }

    Implemented by

    Methods

    createCluster -

    Methods

    createCluster

    Settings

    Member Visibility

    On This Page

    Methods
    \ No newline at end of file +
    interface ClusterProvider {
        createCluster(scope: Construct, vpc: IVpc, secretsEncryptionKey?: IKey, kubernetesVersion?: KubernetesVersion, clusterLogging?: ControlPlaneLogType[]): ClusterInfo;
    }

    Implemented by

    Methods

    createCluster +

    Methods

    createCluster

    Settings

    Member Visibility

    On This Page

    Methods
    \ No newline at end of file diff --git a/api/interfaces/EbsVolumeMapping.html b/api/interfaces/EbsVolumeMapping.html index c9ed476ee..36d851ec3 100644 --- a/api/interfaces/EbsVolumeMapping.html +++ b/api/interfaces/EbsVolumeMapping.html @@ -1,4 +1,4 @@ -EbsVolumeMapping | @aws-quickstart/eks-blueprints

    Interface EbsVolumeMapping

    interface EbsVolumeMapping {
        deleteOnTermination?: boolean;
        encrypted?: boolean;
        iops?: number;
        kmsKeyId?: string;
        outpostArn?: string;
        snapshotId?: string;
        throughput?: number;
        volumeSize?: string;
        volumeType?: EbsDeviceVolumeType;
    }

    Properties

    deleteOnTermination? +EbsVolumeMapping | @aws-quickstart/eks-blueprints

    Interface EbsVolumeMapping

    interface EbsVolumeMapping {
        deleteOnTermination?: boolean;
        encrypted?: boolean;
        iops?: number;
        kmsKeyId?: string;
        outpostArn?: string;
        snapshotId?: string;
        throughput?: number;
        volumeSize?: string;
        volumeType?: EbsDeviceVolumeType;
    }

    Properties

    deleteOnTermination? encrypted? iops? kmsKeyId? @@ -7,4 +7,4 @@ throughput? volumeSize? volumeType? -

    Properties

    OptionaldeleteOnTermination

    deleteOnTermination?: boolean

    Optionalencrypted

    encrypted?: boolean

    Optionaliops

    iops?: number

    OptionalkmsKeyId

    kmsKeyId?: string

    OptionaloutpostArn

    outpostArn?: string

    OptionalsnapshotId

    snapshotId?: string

    Optionalthroughput

    throughput?: number

    OptionalvolumeSize

    volumeSize?: string

    OptionalvolumeType

    volumeType?: EbsDeviceVolumeType

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Properties

    OptionaldeleteOnTermination

    deleteOnTermination?: boolean

    Optionalencrypted

    encrypted?: boolean

    Optionaliops

    iops?: number

    OptionalkmsKeyId

    kmsKeyId?: string

    OptionaloutpostArn

    outpostArn?: string

    OptionalsnapshotId

    snapshotId?: string

    Optionalthroughput

    throughput?: number

    OptionalvolumeSize

    volumeSize?: string

    OptionalvolumeType

    volumeType?: EbsDeviceVolumeType

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/GitOpsApplication.html b/api/interfaces/GitOpsApplication.html index 8c5ad8951..e573eb23d 100644 --- a/api/interfaces/GitOpsApplication.html +++ b/api/interfaces/GitOpsApplication.html @@ -1,6 +1,6 @@ GitOpsApplication | @aws-quickstart/eks-blueprints

    Interface GitOpsApplication

    Defines a GitOps generic application by combining a reference to a git repo and target namespace where it must be deployed.

    -
    interface GitOpsApplication {
        name: string;
        namespace: undefined | string;
        repository?: GitRepositoryReference;
    }

    Hierarchy (view full)

    Properties

    name +
    interface GitOpsApplication {
        name: string;
        namespace: undefined | string;
        repository?: GitRepositoryReference;
    }

    Hierarchy (view full)

    Properties

    name namespace repository? -

    Properties

    name

    name: string

    namespace

    namespace: undefined | string

    Optionalrepository

    repository?: GitRepositoryReference

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Properties

    name

    name: string

    namespace

    namespace: undefined | string

    Optionalrepository

    repository?: GitRepositoryReference

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/GitOpsApplicationDeployment.html b/api/interfaces/GitOpsApplicationDeployment.html index 93a4e473a..9f28a8a8b 100644 --- a/api/interfaces/GitOpsApplicationDeployment.html +++ b/api/interfaces/GitOpsApplicationDeployment.html @@ -1,7 +1,7 @@ GitOpsApplicationDeployment | @aws-quickstart/eks-blueprints

    Interface GitOpsApplicationDeployment

    Defines GitOps application deployment that combines GitOps application with a particular set of values passed from the IaC code to the GitOps engine (e.g. ArgoCD).

    -
    interface GitOpsApplicationDeployment {
        name: string;
        namespace: undefined | string;
        repository?: GitRepositoryReference;
        values: Values;
    }

    Hierarchy (view full)

    Properties

    name +
    interface GitOpsApplicationDeployment {
        name: string;
        namespace: undefined | string;
        repository?: GitRepositoryReference;
        values: Values;
    }

    Hierarchy (view full)

    Properties

    name namespace repository? values -

    Properties

    name

    name: string

    namespace

    namespace: undefined | string

    Optionalrepository

    repository?: GitRepositoryReference

    values

    values: Values

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Properties

    name

    name: string

    namespace

    namespace: undefined | string

    Optionalrepository

    repository?: GitRepositoryReference

    values

    values: Values

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/GitRepositoryReference.html b/api/interfaces/GitRepositoryReference.html index df0831a78..88eda54a7 100644 --- a/api/interfaces/GitRepositoryReference.html +++ b/api/interfaces/GitRepositoryReference.html @@ -1,15 +1,15 @@ GitRepositoryReference | @aws-quickstart/eks-blueprints

    Interface GitRepositoryReference

    Interface that includes a reference to a Git repository for reuse, without credentials and other access information.

    -
    interface GitRepositoryReference {
        name?: string;
        path?: string;
        repoUrl: string;
        targetRevision?: string;
    }

    Hierarchy (view full)

    Properties

    name? +
    interface GitRepositoryReference {
        name?: string;
        path?: string;
        repoUrl: string;
        targetRevision?: string;
    }

    Hierarchy (view full)

    Properties

    name? path? repoUrl targetRevision?

    Properties

    Optionalname

    name?: string

    Optional name for the bootstrap application

    -

    Optionalpath

    path?: string

    Path within the repository

    -

    repoUrl

    repoUrl: string

    Expected to support helm style repo at the moment

    -

    OptionaltargetRevision

    targetRevision?: string

    Optional target revision for the repository. +

    Optionalpath

    path?: string

    Path within the repository

    +

    repoUrl

    repoUrl: string

    Expected to support helm style repo at the moment

    +

    OptionaltargetRevision

    targetRevision?: string

    Optional target revision for the repository. TargetRevision defines the revision of the source to sync the application to. In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD. In case of Helm, this is a semver tag for the Chart's version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/HelmRepository.html b/api/interfaces/HelmRepository.html index f59ba30cf..de21eb387 100644 --- a/api/interfaces/HelmRepository.html +++ b/api/interfaces/HelmRepository.html @@ -1,6 +1,6 @@ HelmRepository | @aws-quickstart/eks-blueprints

    Interface HelmRepository

    Data type defining helm repositories for GitOps bootstrapping.

    -
    interface HelmRepository {
        name: string;
        password?: string;
        repoUrl: string;
        username?: string;
    }

    Properties

    name +
    interface HelmRepository {
        name: string;
        password?: string;
        repoUrl: string;
        username?: string;
    }

    Properties

    name password? repoUrl username? -

    Properties

    name

    name: string

    Optionalpassword

    password?: string

    repoUrl

    repoUrl: string

    Optionalusername

    username?: string

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Properties

    name

    name: string

    Optionalpassword

    password?: string

    repoUrl

    repoUrl: string

    Optionalusername

    username?: string

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/NestedStackBuilder.html b/api/interfaces/NestedStackBuilder.html index 68cd29a46..0d51786cf 100644 --- a/api/interfaces/NestedStackBuilder.html +++ b/api/interfaces/NestedStackBuilder.html @@ -1,3 +1,3 @@ NestedStackBuilder | @aws-quickstart/eks-blueprints

    Interface NestedStackBuilder

    Builder that can generated a nested stack to be deployed with the blueprint.

    -
    interface NestedStackBuilder {
        build(scope: Construct, id: string, stackProps?: NestedStackProps): NestedStack;
    }

    Methods

    build -

    Methods

    build

    • build(scope, id, stackProps?): NestedStack

    • Parameters

      • scope: Construct
      • id: string
      • OptionalstackProps: NestedStackProps

      Returns NestedStack

    Settings

    Member Visibility

    On This Page

    Methods
    \ No newline at end of file +
    interface NestedStackBuilder {
        build(scope: Construct, id: string, stackProps?: NestedStackProps): NestedStack;
    }

    Methods

    build +

    Methods

    build

    • build(scope, id, stackProps?): NestedStack

    • Parameters

      • scope: Construct
      • id: string
      • OptionalstackProps: NestedStackProps

      Returns NestedStack

    Settings

    Member Visibility

    On This Page

    Methods
    \ No newline at end of file diff --git a/api/interfaces/ResourceProvider.html b/api/interfaces/ResourceProvider.html index 27803910f..1f0bfd23c 100644 --- a/api/interfaces/ResourceProvider.html +++ b/api/interfaces/ResourceProvider.html @@ -1,3 +1,3 @@ ResourceProvider | @aws-quickstart/eks-blueprints

    Interface ResourceProvider<T>

    Generic resource provider interface.

    -
    interface ResourceProvider<T> {
        provide(context: ResourceContext): T;
    }

    Type Parameters

    • T extends IConstruct = IConstruct

    Implemented by

    Methods

    provide -

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Methods
    \ No newline at end of file +
    interface ResourceProvider<T> {
        provide(context: ResourceContext): T;
    }

    Type Parameters

    • T extends IConstruct = IConstruct

    Implemented by

    Methods

    provide +

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Methods
    \ No newline at end of file diff --git a/api/interfaces/StackBuilder.html b/api/interfaces/StackBuilder.html index e00cfb950..70eb7aa62 100644 --- a/api/interfaces/StackBuilder.html +++ b/api/interfaces/StackBuilder.html @@ -1,3 +1,3 @@ StackBuilder | @aws-quickstart/eks-blueprints

    Interface StackBuilder

    Generic builder interface that can produce a stack.

    -
    interface StackBuilder {
        build(scope: Construct, id: string, stackProps?: StackProps): Stack;
    }

    Hierarchy (view full)

    Implemented by

    Methods

    build -

    Methods

    build

    • build(scope, id, stackProps?): Stack

    • Parameters

      • scope: Construct
      • id: string
      • OptionalstackProps: StackProps

      Returns Stack

    Settings

    Member Visibility

    On This Page

    Methods
    \ No newline at end of file +
    interface StackBuilder {
        build(scope: Construct, id: string, stackProps?: StackProps): Stack;
    }

    Hierarchy (view full)

    Implemented by

    Methods

    build +

    Methods

    build

    • build(scope, id, stackProps?): Stack

    • Parameters

      • scope: Construct
      • id: string
      • OptionalstackProps: StackProps

      Returns Stack

    Settings

    Member Visibility

    On This Page

    Methods
    \ No newline at end of file diff --git a/api/interfaces/Team.html b/api/interfaces/Team.html index 136cb10d5..c2da4a240 100644 --- a/api/interfaces/Team.html +++ b/api/interfaces/Team.html @@ -1,7 +1,7 @@ Team | @aws-quickstart/eks-blueprints

    Interface Team

    Interface for a team.

    -
    interface Team {
        name: string;
        setup(clusterInfo: ClusterInfo): void;
    }

    Implemented by

    Properties

    name +
    interface Team {
        name: string;
        setup(clusterInfo: ClusterInfo): void;
    }

    Implemented by

    Properties

    name

    Methods

    setup

    Properties

    name

    name: string

    Team name, expected to be unique

    -

    Methods

    setup

    Methods

    setup

    • setup(clusterInfo): void

    • Setup method is invoked in the lifecycle of cluster provisioning after add-ons are provisioned but before and post deployment hooks.

      -

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    \ No newline at end of file diff --git a/api/interfaces/addons.AWSPrivateCAIssuerAddonProps.html b/api/interfaces/addons.AWSPrivateCAIssuerAddonProps.html index d4ec3fb7b..74d0251bf 100644 --- a/api/interfaces/addons.AWSPrivateCAIssuerAddonProps.html +++ b/api/interfaces/addons.AWSPrivateCAIssuerAddonProps.html @@ -1,5 +1,5 @@ AWSPrivateCAIssuerAddonProps | @aws-quickstart/eks-blueprints

    Interface AWSPrivateCAIssuerAddonProps

    User provided options for the Helm Chart

    -
    interface AWSPrivateCAIssuerAddonProps {
        chart?: string;
        dependencyMode?: boolean;
        iamPolicies?: string[];
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        serviceAccountName?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface AWSPrivateCAIssuerAddonProps {
        chart?: string;
        dependencyMode?: boolean;
        iamPolicies?: string[];
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        serviceAccountName?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? dependencyMode? iamPolicies? name? @@ -11,7 +11,7 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -19,15 +19,15 @@

    Default

    true
    -

    OptionaliamPolicies

    iamPolicies?: string[]

    An array of Managed IAM Policies which Service Account needs for IRSA Eg: irsaRoles:["AWSCertificateManagerPrivateCAFullAccess"]. If not empty +

    OptionaliamPolicies

    iamPolicies?: string[]

    An array of Managed IAM Policies which Service Account needs for IRSA Eg: irsaRoles:["AWSCertificateManagerPrivateCAFullAccess"]. If not empty Service Account will be Created by CDK with IAM Roles Mapped (IRSA). In case if its empty, Service Account will be created with default IAM Policy AWSCertificateManagerPrivateCAFullAccess

    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalserviceAccountName

    serviceAccountName?: string

    The name of the service account to use. If createServiceAccount is true, a serviceAccountName is generated.

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalserviceAccountName

    serviceAccountName?: string

    The name of the service account to use. If createServiceAccount is true, a serviceAccountName is generated.

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.AckAddOnProps.html b/api/interfaces/addons.AckAddOnProps.html index 787e68bec..0553f45da 100644 --- a/api/interfaces/addons.AckAddOnProps.html +++ b/api/interfaces/addons.AckAddOnProps.html @@ -1,5 +1,5 @@ AckAddOnProps | @aws-quickstart/eks-blueprints

    Interface AckAddOnProps

    User provided option for the Helm Chart

    -
    interface AckAddOnProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        id?: string;
        inlinePolicyStatements?: PolicyStatement[];
        managedPolicyName?: string;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        saName?: string;
        serviceName: AckServiceName;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface AckAddOnProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        id?: string;
        inlinePolicyStatements?: PolicyStatement[];
        managedPolicyName?: string;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        saName?: string;
        serviceName: AckServiceName;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? createNamespace? dependencyMode? id? @@ -15,8 +15,8 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK. This should be done only for the first time.

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK. This should be done only for the first time.

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -24,26 +24,26 @@

    Default

    true
    -

    Optionalid

    id?: string

    Required identified, must be unique within the parent stack scope.

    -

    OptionalinlinePolicyStatements

    inlinePolicyStatements?: PolicyStatement[]

    Inline IAM Policy for the ack controller

    +

    Optionalid

    id?: string

    Required identified, must be unique within the parent stack scope.

    +

    OptionalinlinePolicyStatements

    inlinePolicyStatements?: PolicyStatement[]

    Inline IAM Policy for the ack controller

    Default

    undefined
    -

    OptionalmanagedPolicyName

    managedPolicyName?: string

    Managed IAM Policy of the ack controller

    +

    OptionalmanagedPolicyName

    managedPolicyName?: string

    Managed IAM Policy of the ack controller

    Default

    IAMFullAccess
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalsaName

    saName?: string

    To create Service Account

    -

    serviceName

    serviceName: AckServiceName

    Default Service Name

    +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalsaName

    saName?: string

    To create Service Account

    +

    serviceName

    serviceName: AckServiceName

    Default Service Name

    Default

    iam
    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.AckChartMapping.html b/api/interfaces/addons.AckChartMapping.html index 6f0d6444c..5d6698d6f 100644 --- a/api/interfaces/addons.AckChartMapping.html +++ b/api/interfaces/addons.AckChartMapping.html @@ -1,6 +1,6 @@ AckChartMapping | @aws-quickstart/eks-blueprints

    Interface AckChartMapping

    Chart Mapping for fields such as chart, version, managed IAM policy.

    -
    interface AckChartMapping {
        chart: string;
        inlinePolicyStatements?: PolicyStatement[];
        managedPolicyName?: string;
        version: string;
    }

    Properties

    chart +
    interface AckChartMapping {
        chart: string;
        inlinePolicyStatements?: PolicyStatement[];
        managedPolicyName?: string;
        version: string;
    }

    Properties

    chart inlinePolicyStatements? managedPolicyName? version -

    Properties

    chart

    chart: string

    OptionalinlinePolicyStatements

    inlinePolicyStatements?: PolicyStatement[]

    OptionalmanagedPolicyName

    managedPolicyName?: string

    version

    version: string

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Properties

    chart

    chart: string

    OptionalinlinePolicyStatements

    inlinePolicyStatements?: PolicyStatement[]

    OptionalmanagedPolicyName

    managedPolicyName?: string

    version

    version: string

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.AirflowAddOnProps.html b/api/interfaces/addons.AirflowAddOnProps.html index 29c0fbd9c..4d2ac7cd1 100644 --- a/api/interfaces/addons.AirflowAddOnProps.html +++ b/api/interfaces/addons.AirflowAddOnProps.html @@ -1,5 +1,5 @@ AirflowAddOnProps | @aws-quickstart/eks-blueprints

    Interface AirflowAddOnProps

    User provided options for the Helm Chart

    -
    interface AirflowAddOnProps {
        certificateResourceName?: string;
        chart?: string;
        dependencyMode?: boolean;
        efsFileSystem?: string;
        enableAlb?: boolean;
        enableEfs?: boolean;
        enableLogging?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        s3Bucket?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    certificateResourceName? +
    interface AirflowAddOnProps {
        certificateResourceName?: string;
        chart?: string;
        dependencyMode?: boolean;
        efsFileSystem?: string;
        enableAlb?: boolean;
        enableEfs?: boolean;
        enableLogging?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        s3Bucket?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    certificateResourceName? chart? dependencyMode? efsFileSystem? @@ -16,8 +16,8 @@ version?

    Properties

    OptionalcertificateResourceName

    certificateResourceName?: string

    Name of the certificateResourceName to be used for certificate look up.

    See

    ImportCertificateProvider and CreateCertificateProvider for examples of certificate providers.

    -

    Optionalchart

    chart?: string

    Chart name

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    Optionalchart

    chart?: string

    Chart name

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -25,22 +25,22 @@

    Default

    true
    -

    OptionalefsFileSystem

    efsFileSystem?: string

    Names of the EFS File System provider named resources (@see CreateEfsFileSystemProvider,

    +

    OptionalefsFileSystem

    efsFileSystem?: string

    Names of the EFS File System provider named resources (@see CreateEfsFileSystemProvider,

    See

    LookupEfsFileSystemProvider). EFS File System provider is registered as named resource providers with the EksBlueprintProps. This is required if EFS is enabled

    -

    OptionalenableAlb

    enableAlb?: boolean

    Enable Load Balancer for Ingress - default is false

    -

    OptionalenableEfs

    enableEfs?: boolean

    Enable EFS for persistent storage of DAGs - default is false

    -

    OptionalenableLogging

    enableLogging?: boolean

    Enable Logging with S3 - default is false

    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    Optionals3Bucket

    s3Bucket?: string

    Names of the S3 Bucket provider named resources (@see CreateS3BucketProvider,

    +

    OptionalenableAlb

    enableAlb?: boolean

    Enable Load Balancer for Ingress - default is false

    +

    OptionalenableEfs

    enableEfs?: boolean

    Enable EFS for persistent storage of DAGs - default is false

    +

    OptionalenableLogging

    enableLogging?: boolean

    Enable Logging with S3 - default is false

    +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    Optionals3Bucket

    s3Bucket?: string

    Names of the S3 Bucket provider named resources (@see CreateS3BucketProvider,

    See

    ImportS3BucketProvider). S3 Bucket provider is registered as named resource providers with the EksBlueprintProps.

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.AmpAddOnProps.html b/api/interfaces/addons.AmpAddOnProps.html index 744820cad..dfea49fa3 100644 --- a/api/interfaces/addons.AmpAddOnProps.html +++ b/api/interfaces/addons.AmpAddOnProps.html @@ -1,5 +1,5 @@ AmpAddOnProps | @aws-quickstart/eks-blueprints

    Interface AmpAddOnProps

    Configuration options for add-on.

    -
    interface AmpAddOnProps {
        ampPrometheusEndpoint: string;
        ampRules?: AmpRules;
        deploymentMode?: DeploymentMode;
        enableAPIServerJob?: boolean;
        name?: string;
        namespace?: string;
        openTelemetryCollector?: OpenTelemetryCollector;
    }

    Properties

    ampPrometheusEndpoint +
    interface AmpAddOnProps {
        ampPrometheusEndpoint: string;
        ampRules?: AmpRules;
        deploymentMode?: DeploymentMode;
        enableAPIServerJob?: boolean;
        name?: string;
        namespace?: string;
        openTelemetryCollector?: OpenTelemetryCollector;
    }

    Properties

    ampPrometheusEndpoint ampRules? deploymentMode? enableAPIServerJob? @@ -8,25 +8,25 @@ openTelemetryCollector?

    Properties

    ampPrometheusEndpoint

    ampPrometheusEndpoint: string

    Remote Write URL of the AMP Workspace to be used for setting up remote write. Format : https://aps-workspaces..amazonaws.com/workspaces//",

    -

    OptionalampRules

    ampRules?: AmpRules

    AMP rules providing AMP workspace ARN and paths to files encoding recording and/or alerting rules following the same format as a rules file in standalone Prometheus. +

    OptionalampRules

    ampRules?: AmpRules

    AMP rules providing AMP workspace ARN and paths to files encoding recording and/or alerting rules following the same format as a rules file in standalone Prometheus. This parameter is optional and if not provided, no rules will be applied.

    -

    OptionaldeploymentMode

    deploymentMode?: DeploymentMode

    Modes supported : deployment, daemonset, statefulSet, and sidecar

    +

    OptionaldeploymentMode

    deploymentMode?: DeploymentMode

    Modes supported : deployment, daemonset, statefulSet, and sidecar

    Default

    deployment
    -

    OptionalenableAPIServerJob

    enableAPIServerJob?: boolean

    Enable "apiserver" job in the Prometheus configuration of the default OpenTelemetryCollector.

    +

    OptionalenableAPIServerJob

    enableAPIServerJob?: boolean

    Enable "apiserver" job in the Prometheus configuration of the default OpenTelemetryCollector.

    Default

    false
    -

    Optionalname

    name?: string

    Name for deployment of the ADOT Collector for AMP.

    +

    Optionalname

    name?: string

    Name for deployment of the ADOT Collector for AMP.

    Default

    'adot-collector-amp'
    -

    Optionalnamespace

    namespace?: string

    Namespace to deploy the ADOT Collector for AMP.

    +

    Optionalnamespace

    namespace?: string

    Namespace to deploy the ADOT Collector for AMP.

    Default

    default
    -

    OptionalopenTelemetryCollector

    openTelemetryCollector?: OpenTelemetryCollector

    An alternative OpenTelemetryCollector if you need further customisation. +

    OptionalopenTelemetryCollector

    openTelemetryCollector?: OpenTelemetryCollector

    An alternative OpenTelemetryCollector if you need further customisation. If you need to configure rules, please do not use the rule_files field like in standalone Prometheus, but rather use the ampRules parameter. If not provided, the default will be used.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.AmpRules.html b/api/interfaces/addons.AmpRules.html index db87df2d6..a798c9609 100644 --- a/api/interfaces/addons.AmpRules.html +++ b/api/interfaces/addons.AmpRules.html @@ -2,8 +2,8 @@ (AMP) and creates an AMP worpsace to receive OTLP metrics from the application and Prometheus metrics scraped from pods on the cluster and remote writes the metrics to AMP remote write endpoint of the created or passed AMP workspace.

    -
    interface AmpRules {
        ampWorkspaceArn: string;
        ruleFilePaths: string[];
    }

    Properties

    ampWorkspaceArn +
    interface AmpRules {
        ampWorkspaceArn: string;
        ruleFilePaths: string[];
    }

    Properties

    ampWorkspaceArn ruleFilePaths

    Properties

    ampWorkspaceArn

    ampWorkspaceArn: string

    AMP workspace ARN.

    -

    ruleFilePaths

    ruleFilePaths: string[]

    Paths of the files listing the AMP rules.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    ruleFilePaths

    ruleFilePaths: string[]

    Paths of the files listing the AMP rules.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.AppMeshAddOnProps.html b/api/interfaces/addons.AppMeshAddOnProps.html index 6fbb45505..db585899f 100644 --- a/api/interfaces/addons.AppMeshAddOnProps.html +++ b/api/interfaces/addons.AppMeshAddOnProps.html @@ -1,5 +1,5 @@ AppMeshAddOnProps | @aws-quickstart/eks-blueprints

    Interface AppMeshAddOnProps

    Configuration options for the add-on.

    -
    interface AppMeshAddOnProps {
        chart?: string;
        dependencyMode?: boolean;
        enableTracing?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        tracingAddress?: string;
        tracingPort?: string;
        tracingProvider?: "x-ray" | "jaeger" | "datadog";
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface AppMeshAddOnProps {
        chart?: string;
        dependencyMode?: boolean;
        enableTracing?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        tracingAddress?: string;
        tracingPort?: string;
        tracingProvider?: "x-ray" | "jaeger" | "datadog";
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? dependencyMode? enableTracing? name? @@ -13,7 +13,7 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -21,19 +21,19 @@

    Default

    true
    -

    OptionalenableTracing

    enableTracing?: boolean

    If set to true, will enable tracing through App Mesh sidecars, such as X-Ray distributed tracing. +

    OptionalenableTracing

    enableTracing?: boolean

    If set to true, will enable tracing through App Mesh sidecars, such as X-Ray distributed tracing. Note: support for X-Ray tracing does not depend on the XRay Daemon AddOn installed.

    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    OptionaltracingAddress

    tracingAddress?: string

    Used for Datadog or Jaeger tracing. Example values: datadog.appmesh-system. +

    OptionaltracingAddress

    tracingAddress?: string

    Used for Datadog or Jaeger tracing. Example values: datadog.appmesh-system. Refer to https://aws.github.io/aws-app-mesh-controller-for-k8s/guide/tracing/ for more information. Ignored for X-Ray.

    -

    OptionaltracingPort

    tracingPort?: string

    Jaeger or Datadog agent port (ignored for X-Ray)

    -

    OptionaltracingProvider

    tracingProvider?: "x-ray" | "jaeger" | "datadog"

    Tracing provider. Supported values are x-ray, jaeger, datadog

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    OptionaltracingPort

    tracingPort?: string

    Jaeger or Datadog agent port (ignored for X-Ray)

    +

    OptionaltracingProvider

    tracingProvider?: "x-ray" | "jaeger" | "datadog"

    Tracing provider. Supported values are x-ray, jaeger, datadog

    +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.ArgoCDAddOnProps.html b/api/interfaces/addons.ArgoCDAddOnProps.html index d6574ad93..81fe9db2b 100644 --- a/api/interfaces/addons.ArgoCDAddOnProps.html +++ b/api/interfaces/addons.ArgoCDAddOnProps.html @@ -1,5 +1,5 @@ ArgoCDAddOnProps | @aws-quickstart/eks-blueprints

    Interface ArgoCDAddOnProps

    Configuration options for add-on.

    -
    interface ArgoCDAddOnProps {
        adminPasswordSecretName?: string;
        bootstrapRepo?: ApplicationRepository;
        bootstrapValues?: Values;
        chart?: string;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
        workloadApplications?: GitOpsApplicationDeployment[];
    }

    Hierarchy (view full)

    Properties

    adminPasswordSecretName? +
    interface ArgoCDAddOnProps {
        adminPasswordSecretName?: string;
        bootstrapRepo?: ApplicationRepository;
        bootstrapValues?: Values;
        chart?: string;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
        workloadApplications?: GitOpsApplicationDeployment[];
    }

    Hierarchy (view full)

    Properties

    adminPasswordSecretName? bootstrapRepo? bootstrapValues? chart? @@ -16,15 +16,15 @@ This allows to control admin password across the enterprise. Password will be retrieved and stored as a non-reversible bcrypt hash. Note: at present, change of password may require manual restart of argocd server.

    -

    OptionalbootstrapRepo

    bootstrapRepo?: ApplicationRepository

    If provided, the addon will bootstrap the app or apps in the provided repository. +

    OptionalbootstrapRepo

    bootstrapRepo?: ApplicationRepository

    If provided, the addon will bootstrap the app or apps in the provided repository. In general, the repo is expected to have the app of apps, which can enable to bootstrap all workloads, after the infrastructure and team provisioning is complete. When GitOps mode is enabled via ArgoGitOpsFactory for deploying the AddOns, this bootstrap repository will be used for provisioning all HelmAddOn based AddOns.

    -

    OptionalbootstrapValues

    bootstrapValues?: Values

    Optional values for the bootstrap application. These may contain values such as domain named provisioned by other add-ons, certificate, and other parameters to pass +

    OptionalbootstrapValues

    bootstrapValues?: Values

    Optional values for the bootstrap application. These may contain values such as domain named provisioned by other add-ons, certificate, and other parameters to pass to the applications.

    -

    Optionalchart

    chart?: string

    Chart name

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    Optionalchart

    chart?: string

    Chart name

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -32,20 +32,20 @@

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where add-on will be deployed.

    +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where add-on will be deployed.

    Default

    argocd
    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Values to pass to the chart as per https://github.com/argoproj/argo-helm/blob/master/charts/argo-cd/values.yaml.

    -

    Optionalversion

    version?: string

    Helm chart version to use to install.

    +

    Optionalvalues

    values?: Values

    Values to pass to the chart as per https://github.com/argoproj/argo-helm/blob/master/charts/argo-cd/values.yaml.

    +

    Optionalversion

    version?: string

    Helm chart version to use to install.

    Default

    5.51.6
    -

    OptionalworkloadApplications

    workloadApplications?: GitOpsApplicationDeployment[]

    Additional GitOps applications and repositories. If there is a split between infra and application repositories then +

    OptionalworkloadApplications

    workloadApplications?: GitOpsApplicationDeployment[]

    Additional GitOps applications and repositories. If there is a split between infra and application repositories then bootstrap repo is expected to be leveraged for infrastructure and application deployments will contain additional applications.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.AwsForFluentBitAddOnProps.html b/api/interfaces/addons.AwsForFluentBitAddOnProps.html index 5bc54e534..69ba070bb 100644 --- a/api/interfaces/addons.AwsForFluentBitAddOnProps.html +++ b/api/interfaces/addons.AwsForFluentBitAddOnProps.html @@ -1,5 +1,5 @@ AwsForFluentBitAddOnProps | @aws-quickstart/eks-blueprints

    Interface AwsForFluentBitAddOnProps

    Configuration options for the FluentBit add-on.

    -
    interface AwsForFluentBitAddOnProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        iamPolicies?: PolicyStatement[];
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface AwsForFluentBitAddOnProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        iamPolicies?: PolicyStatement[];
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? createNamespace? dependencyMode? iamPolicies? @@ -11,8 +11,8 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionalcreateNamespace

    createNamespace?: boolean

    Create Namespace with the provided one (will not if namespace is kube-system)

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionalcreateNamespace

    createNamespace?: boolean

    Create Namespace with the provided one (will not if namespace is kube-system)

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -20,13 +20,13 @@

    Default

    true
    -

    OptionaliamPolicies

    iamPolicies?: PolicyStatement[]

    Iam policies for the add-on.

    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    OptionaliamPolicies

    iamPolicies?: PolicyStatement[]

    Iam policies for the add-on.

    +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.AwsLoadBalancerControllerProps.html b/api/interfaces/addons.AwsLoadBalancerControllerProps.html index 66712d99b..f4b91b0a7 100644 --- a/api/interfaces/addons.AwsLoadBalancerControllerProps.html +++ b/api/interfaces/addons.AwsLoadBalancerControllerProps.html @@ -1,5 +1,5 @@ AwsLoadBalancerControllerProps | @aws-quickstart/eks-blueprints

    Interface AwsLoadBalancerControllerProps

    Configuration options for the add-on.

    -
    interface AwsLoadBalancerControllerProps {
        chart?: string;
        createIngressClassResource?: boolean;
        dependencyMode?: boolean;
        enableServiceMutatorWebhook?: boolean;
        enableShield?: boolean;
        enableWaf?: boolean;
        enableWafv2?: boolean;
        ingressClass?: string;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface AwsLoadBalancerControllerProps {
        chart?: string;
        createIngressClassResource?: boolean;
        dependencyMode?: boolean;
        enableServiceMutatorWebhook?: boolean;
        enableShield?: boolean;
        enableWaf?: boolean;
        enableWafv2?: boolean;
        ingressClass?: string;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? createIngressClassResource? dependencyMode? enableServiceMutatorWebhook? @@ -15,8 +15,8 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionalcreateIngressClassResource

    createIngressClassResource?: boolean

    Create the ingressClass to be used by the ALB controller

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionalcreateIngressClassResource

    createIngressClassResource?: boolean

    Create the ingressClass to be used by the ALB controller

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -24,21 +24,21 @@

    Default

    true
    -

    OptionalenableServiceMutatorWebhook

    enableServiceMutatorWebhook?: boolean

    If false, disable the Service Mutator webhook which makes all new services of type LoadBalancer reconciled by the lb controller.

    +

    OptionalenableServiceMutatorWebhook

    enableServiceMutatorWebhook?: boolean

    If false, disable the Service Mutator webhook which makes all new services of type LoadBalancer reconciled by the lb controller.

    Default

    false
    -

    OptionalenableShield

    enableShield?: boolean

    Enable Shield (must be false for CN partition)

    -

    OptionalenableWaf

    enableWaf?: boolean

    Enable WAF (must be false for CN partition)

    -

    OptionalenableWafv2

    enableWafv2?: boolean

    Enable WAFV2 (must be false for CN partition)

    -

    OptionalingressClass

    ingressClass?: string

    Name of ingressClass to the ALB controller will satisfy. If not provided +

    OptionalenableShield

    enableShield?: boolean

    Enable Shield (must be false for CN partition)

    +

    OptionalenableWaf

    enableWaf?: boolean

    Enable WAF (must be false for CN partition)

    +

    OptionalenableWafv2

    enableWafv2?: boolean

    Enable WAFV2 (must be false for CN partition)

    +

    OptionalingressClass

    ingressClass?: string

    Name of ingressClass to the ALB controller will satisfy. If not provided the value will be defaulted to "alb"

    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.AwsNodeTerminationHandlerProps.html b/api/interfaces/addons.AwsNodeTerminationHandlerProps.html index c8b2cf67d..fccd8249f 100644 --- a/api/interfaces/addons.AwsNodeTerminationHandlerProps.html +++ b/api/interfaces/addons.AwsNodeTerminationHandlerProps.html @@ -1,5 +1,5 @@ AwsNodeTerminationHandlerProps | @aws-quickstart/eks-blueprints

    Interface AwsNodeTerminationHandlerProps

    Configuration for the add-on

    -
    interface AwsNodeTerminationHandlerProps {
        chart?: string;
        dependencyMode?: boolean;
        mode?: Mode;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface AwsNodeTerminationHandlerProps {
        chart?: string;
        dependencyMode?: boolean;
        mode?: Mode;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? dependencyMode? mode? name? @@ -10,7 +10,7 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -18,16 +18,16 @@

    Default

    true
    -

    Optionalmode

    mode?: Mode

    Supported Modes are Mode.IMDS and Mode.QUEUE

    +

    Optionalmode

    mode?: Mode

    Supported Modes are Mode.IMDS and Mode.QUEUE

    Default

    Mode.IMDS
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.BackstageAddOnProps.html b/api/interfaces/addons.BackstageAddOnProps.html index e486030c7..26941a9b1 100644 --- a/api/interfaces/addons.BackstageAddOnProps.html +++ b/api/interfaces/addons.BackstageAddOnProps.html @@ -1,5 +1,5 @@ BackstageAddOnProps | @aws-quickstart/eks-blueprints

    Interface BackstageAddOnProps

    User provided options for the Helm Chart

    -
    interface BackstageAddOnProps {
        certificateResourceName: string;
        chart?: string;
        databaseResourceName: string;
        databaseSecretTargetName: string;
        dependencyMode?: boolean;
        imageRegistry: string;
        imageRepository: string;
        imageTag?: string;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        subdomain: string;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    certificateResourceName +
    interface BackstageAddOnProps {
        certificateResourceName: string;
        chart?: string;
        databaseResourceName: string;
        databaseSecretTargetName: string;
        dependencyMode?: boolean;
        imageRegistry: string;
        imageRepository: string;
        imageTag?: string;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        subdomain: string;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    certificateResourceName chart? databaseResourceName databaseSecretTargetName @@ -16,11 +16,11 @@ values? version?

    Properties

    certificateResourceName

    certificateResourceName: string

    The resource name of the certificate to be assigned to the Load Balancer.

    -

    Optionalchart

    chart?: string

    Chart name

    -

    databaseResourceName

    databaseResourceName: string

    The resource name of the database.

    -

    databaseSecretTargetName

    databaseSecretTargetName: string

    The name of the Kubernetes Secret which will be created by the add-on and +

    Optionalchart

    chart?: string

    Chart name

    +

    databaseResourceName

    databaseResourceName: string

    The resource name of the database.

    +

    databaseSecretTargetName

    databaseSecretTargetName: string

    The name of the Kubernetes Secret which will be created by the add-on and injected with the database credentials.

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -28,19 +28,19 @@

    Default

    true
    -

    imageRegistry

    imageRegistry: string

    The registry URL of the Backstage application's Docker image.

    -

    imageRepository

    imageRepository: string

    The repository name in the "imageRegistry".

    -

    OptionalimageTag

    imageTag?: string

    The tag of the Backstage application's Docker image.

    +

    imageRegistry

    imageRegistry: string

    The registry URL of the Backstage application's Docker image.

    +

    imageRepository

    imageRepository: string

    The repository name in the "imageRegistry".

    +

    OptionalimageTag

    imageTag?: string

    The tag of the Backstage application's Docker image.

    Default

    'latest'
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    subdomain

    subdomain: string

    The subdomain that will be assigned to the Backstage application.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    subdomain

    subdomain: string

    The subdomain that will be assigned to the Backstage application.

    +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.CalicoAddOnProps.html b/api/interfaces/addons.CalicoAddOnProps.html index a4cad48da..1fee1927c 100644 --- a/api/interfaces/addons.CalicoAddOnProps.html +++ b/api/interfaces/addons.CalicoAddOnProps.html @@ -1,5 +1,5 @@ CalicoAddOnProps | @aws-quickstart/eks-blueprints

    Interface CalicoAddOnProps

    Configuration options for the add-on.

    -

    Deprecated

    interface CalicoAddOnProps {
        chart?: string;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: any;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +

    Deprecated

    interface CalicoAddOnProps {
        chart?: string;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: any;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? dependencyMode? name? namespace? @@ -9,7 +9,7 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -17,18 +17,18 @@

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where Calico will be installed

    +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where Calico will be installed

    Default

    kube-system
    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: any

    Values for the Helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version to use to install.

    +

    Optionalvalues

    values?: any

    Values for the Helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version to use to install.

    Default

    0.3.10
    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.CalicoOperatorAddOnProps.html b/api/interfaces/addons.CalicoOperatorAddOnProps.html index 6c6bd0370..f6622bbf5 100644 --- a/api/interfaces/addons.CalicoOperatorAddOnProps.html +++ b/api/interfaces/addons.CalicoOperatorAddOnProps.html @@ -1,5 +1,5 @@ CalicoOperatorAddOnProps | @aws-quickstart/eks-blueprints

    Interface CalicoOperatorAddOnProps

    Configuration options for the add-on.

    -
    interface CalicoOperatorAddOnProps {
        chart?: string;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: any;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface CalicoOperatorAddOnProps {
        chart?: string;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: any;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? dependencyMode? name? namespace? @@ -9,7 +9,7 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -17,18 +17,18 @@

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where Calico will be installed

    +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where Calico will be installed

    Default

    kube-system
    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: any

    Values for the Helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version to use to install.

    +

    Optionalvalues

    values?: any

    Values for the Helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version to use to install.

    Default

    3.27.2
    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.CertManagerAddOnProps.html b/api/interfaces/addons.CertManagerAddOnProps.html index 745a5b1fd..a7b06b551 100644 --- a/api/interfaces/addons.CertManagerAddOnProps.html +++ b/api/interfaces/addons.CertManagerAddOnProps.html @@ -1,5 +1,5 @@ CertManagerAddOnProps | @aws-quickstart/eks-blueprints

    Interface CertManagerAddOnProps

    User provided options for the Helm Chart

    -
    interface CertManagerAddOnProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        installCRDs?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface CertManagerAddOnProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        installCRDs?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? createNamespace? dependencyMode? installCRDs? @@ -11,8 +11,8 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -20,13 +20,13 @@

    Default

    true
    -

    OptionalinstallCRDs

    installCRDs?: boolean

    To automatically install and manage the CRDs as part of your Helm release,

    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    OptionalinstallCRDs

    installCRDs?: boolean

    To automatically install and manage the CRDs as part of your Helm release,

    +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.CloudWatchAdotAddOnProps.html b/api/interfaces/addons.CloudWatchAdotAddOnProps.html index 7c7e7bfa3..2e8255854 100644 --- a/api/interfaces/addons.CloudWatchAdotAddOnProps.html +++ b/api/interfaces/addons.CloudWatchAdotAddOnProps.html @@ -1,5 +1,5 @@ CloudWatchAdotAddOnProps | @aws-quickstart/eks-blueprints

    Interface CloudWatchAdotAddOnProps

    Configuration options for CloudWatch Adot add-on.

    -
    interface CloudWatchAdotAddOnProps {
        deploymentMode?: cloudWatchDeploymentMode;
        metricsNameSelectors?: string[];
        name?: string;
        namespace?: string;
        podLabelRegex?: string;
    }

    Properties

    deploymentMode? +
    interface CloudWatchAdotAddOnProps {
        deploymentMode?: cloudWatchDeploymentMode;
        metricsNameSelectors?: string[];
        name?: string;
        namespace?: string;
        podLabelRegex?: string;
    }

    Properties

    deploymentMode? metricsNameSelectors? name? namespace? @@ -8,21 +8,21 @@

    Default

    deployment
    -

    OptionalmetricsNameSelectors

    metricsNameSelectors?: string[]

    Metrics name selectors to write to CloudWatch.

    +

    OptionalmetricsNameSelectors

    metricsNameSelectors?: string[]

    Metrics name selectors to write to CloudWatch.

    Default

    "['apiserver_request_.*', 'container_memory_.*', 'container_threads', 'otelcol_process_.*']"
    -

    Optionalname

    name?: string

    Name to deploy the ADOT Collector for CloudWatch.

    +

    Optionalname

    name?: string

    Name to deploy the ADOT Collector for CloudWatch.

    Default

    'adot-collector-cloudwatch'
    -

    Optionalnamespace

    namespace?: string

    Namespace to deploy the ADOT Collector for CloudWatch.

    +

    Optionalnamespace

    namespace?: string

    Namespace to deploy the ADOT Collector for CloudWatch.

    Default

    default
    -

    OptionalpodLabelRegex

    podLabelRegex?: string

    Labels of Pods to select your application pods emitting custom metrics. +

    OptionalpodLabelRegex

    podLabelRegex?: string

    Labels of Pods to select your application pods emitting custom metrics. Example 'frontend|downstream(.*)'

    Default

    '.*'
    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.CloudWatchLogsAddonProps.html b/api/interfaces/addons.CloudWatchLogsAddonProps.html index 61b6812ec..2200baf90 100644 --- a/api/interfaces/addons.CloudWatchLogsAddonProps.html +++ b/api/interfaces/addons.CloudWatchLogsAddonProps.html @@ -1,5 +1,5 @@ CloudWatchLogsAddonProps | @aws-quickstart/eks-blueprints

    Interface CloudWatchLogsAddonProps

    Configuration options for the FluentBit add-on.

    -
    interface CloudWatchLogsAddonProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        logGroupPrefix: string;
        logRetentionDays?: number;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        serviceAccountName?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface CloudWatchLogsAddonProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        logGroupPrefix: string;
        logRetentionDays?: number;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        serviceAccountName?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? createNamespace? dependencyMode? logGroupPrefix @@ -13,8 +13,8 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionalcreateNamespace

    createNamespace?: boolean

    Create Namespace with the provided one (will not if namespace is kube-system)

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionalcreateNamespace

    createNamespace?: boolean

    Create Namespace with the provided one (will not if namespace is kube-system)

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -22,15 +22,15 @@

    Default

    true
    -

    logGroupPrefix

    logGroupPrefix: string

    CloudWatch Log Group Name.

    -

    OptionallogRetentionDays

    logRetentionDays?: number

    CloudWatch Log retention days

    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalserviceAccountName

    serviceAccountName?: string

    Name of the service account for fluent bit.

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    logGroupPrefix

    logGroupPrefix: string

    CloudWatch Log Group Name.

    +

    OptionallogRetentionDays

    logRetentionDays?: number

    CloudWatch Log retention days

    +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalserviceAccountName

    serviceAccountName?: string

    Name of the service account for fluent bit.

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.ClusterAutoScalerAddOnProps.html b/api/interfaces/addons.ClusterAutoScalerAddOnProps.html index f8c079d76..92c2b7ab1 100644 --- a/api/interfaces/addons.ClusterAutoScalerAddOnProps.html +++ b/api/interfaces/addons.ClusterAutoScalerAddOnProps.html @@ -1,5 +1,5 @@ ClusterAutoScalerAddOnProps | @aws-quickstart/eks-blueprints

    Interface ClusterAutoScalerAddOnProps

    Configuration options for the add-on.

    -
    interface ClusterAutoScalerAddOnProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface ClusterAutoScalerAddOnProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? createNamespace? dependencyMode? name? @@ -10,8 +10,8 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionalcreateNamespace

    createNamespace?: boolean

    Create namespace

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionalcreateNamespace

    createNamespace?: boolean

    Create namespace

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -19,15 +19,15 @@

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Version of the Cluster Autoscaler

    +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Version of the Cluster Autoscaler

    Default

    auto discovered based on EKS version.
    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.ContainerInsightAddonProps.html b/api/interfaces/addons.ContainerInsightAddonProps.html index 234d8a30d..5392cd691 100644 --- a/api/interfaces/addons.ContainerInsightAddonProps.html +++ b/api/interfaces/addons.ContainerInsightAddonProps.html @@ -1,5 +1,5 @@ ContainerInsightAddonProps | @aws-quickstart/eks-blueprints

    Interface ContainerInsightAddonProps

    Deprecated

    use CloudWatch Insights add-on instead

    -
    interface ContainerInsightAddonProps {
        chart?: string;
        dependencyMode?: boolean;
        name?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: ValuesSchema;
        version?: string;
    }

    Hierarchy

    Properties

    chart? +
    interface ContainerInsightAddonProps {
        chart?: string;
        dependencyMode?: boolean;
        name?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: ValuesSchema;
        version?: string;
    }

    Hierarchy

    Properties

    chart? dependencyMode? name? release? @@ -8,7 +8,7 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -16,11 +16,11 @@

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: ValuesSchema

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: ValuesSchema

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.CsiSecretProps.html b/api/interfaces/addons.CsiSecretProps.html index befb9e35e..cffabea16 100644 --- a/api/interfaces/addons.CsiSecretProps.html +++ b/api/interfaces/addons.CsiSecretProps.html @@ -1,9 +1,9 @@ CsiSecretProps | @aws-quickstart/eks-blueprints

    Interface CsiSecretProps

    CsiSecret Props

    -
    interface CsiSecretProps {
        jmesPath?: JmesPathObject[];
        kubernetesSecret?: KubernetesSecret;
        secretProvider: SecretProvider;
    }

    Properties

    jmesPath? +
    interface CsiSecretProps {
        jmesPath?: JmesPathObject[];
        kubernetesSecret?: KubernetesSecret;
        secretProvider: SecretProvider;
    }

    Properties

    jmesPath? kubernetesSecret? secretProvider

    Properties

    OptionaljmesPath

    jmesPath?: JmesPathObject[]

    For secrets containing JSON structure, an optional JMES Path (https://jmespath.org/) object to decompose individual keys as separate secret object data.

    -

    OptionalkubernetesSecret

    kubernetesSecret?: KubernetesSecret

    Kubernetes secret for cases when CSI secret should create a standard Kubernetes Secret object.

    -

    secretProvider

    secretProvider: SecretProvider

    Implementation of the secret provider that returns a reference to an Secrets Manager entry or Blueprints Parameter.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    OptionalkubernetesSecret

    kubernetesSecret?: KubernetesSecret

    Kubernetes secret for cases when CSI secret should create a standard Kubernetes Secret object.

    +

    secretProvider

    secretProvider: SecretProvider

    Implementation of the secret provider that returns a reference to an Secrets Manager entry or Blueprints Parameter.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.CustomNetworkingConfig.html b/api/interfaces/addons.CustomNetworkingConfig.html index 9c9d58fa2..7a1ed2dff 100644 --- a/api/interfaces/addons.CustomNetworkingConfig.html +++ b/api/interfaces/addons.CustomNetworkingConfig.html @@ -1,5 +1,5 @@ -CustomNetworkingConfig | @aws-quickstart/eks-blueprints

    Interface CustomNetworkingConfig

    interface CustomNetworkingConfig {
        securityGroup?: ISecurityGroup;
        subnets?: ISubnet[];
    }

    Properties

    securityGroup? +CustomNetworkingConfig | @aws-quickstart/eks-blueprints

    Interface CustomNetworkingConfig

    interface CustomNetworkingConfig {
        securityGroup?: ISecurityGroup;
        subnets?: ISubnet[];
    }

    Properties

    securityGroup? subnets?

    Properties

    Optional ReadonlysecurityGroup

    securityGroup?: ISecurityGroup

    Security group of secondary ENI

    -

    Optional Readonlysubnets

    subnets?: ISubnet[]

    Secondary subnets of your VPC

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optional Readonlysubnets

    subnets?: ISubnet[]

    Secondary subnets of your VPC

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.EfsCsiDriverProps.html b/api/interfaces/addons.EfsCsiDriverProps.html index c758481c4..9dd79e2a0 100644 --- a/api/interfaces/addons.EfsCsiDriverProps.html +++ b/api/interfaces/addons.EfsCsiDriverProps.html @@ -1,5 +1,5 @@ EfsCsiDriverProps | @aws-quickstart/eks-blueprints

    Interface EfsCsiDriverProps

    Configuration options for the add-on.

    -
    interface EfsCsiDriverProps {
        chart?: string;
        dependencyMode?: boolean;
        kmsKeys?: Key[];
        name?: string;
        namespace?: string;
        release?: string;
        replicaCount?: number;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface EfsCsiDriverProps {
        chart?: string;
        dependencyMode?: boolean;
        kmsKeys?: Key[];
        name?: string;
        namespace?: string;
        release?: string;
        replicaCount?: number;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? dependencyMode? kmsKeys? name? @@ -11,7 +11,7 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -19,16 +19,16 @@

    Default

    true
    -

    OptionalkmsKeys

    kmsKeys?: Key[]

    List of KMS keys to be used for encryption

    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    OptionalreplicaCount

    replicaCount?: number

    Number of replicas to be deployed. If not provided, it defaults to 2. Note that the number of replicas +

    OptionalkmsKeys

    kmsKeys?: Key[]

    List of KMS keys to be used for encryption

    +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    OptionalreplicaCount

    replicaCount?: number

    Number of replicas to be deployed. If not provided, it defaults to 2. Note that the number of replicas should be less than or equal to the number of nodes in the cluster otherwise some pods will be left of pending state

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Version of the driver to deploy. Uses chart version 2.2.3 by default if this value is not provided

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Version of the driver to deploy. Uses chart version 2.2.3 by default if this value is not provided

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.ExternalDnsProps.html b/api/interfaces/addons.ExternalDnsProps.html index 95f25cfbf..a93589e88 100644 --- a/api/interfaces/addons.ExternalDnsProps.html +++ b/api/interfaces/addons.ExternalDnsProps.html @@ -1,5 +1,5 @@ ExternalDnsProps | @aws-quickstart/eks-blueprints

    Interface ExternalDnsProps

    Configuration options for the external DNS add-on.

    -
    interface ExternalDnsProps {
        chart?: string;
        dependencyMode?: boolean;
        hostedZoneResources: string[];
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        sources?: string[];
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface ExternalDnsProps {
        chart?: string;
        dependencyMode?: boolean;
        hostedZoneResources: string[];
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        sources?: string[];
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? dependencyMode? hostedZoneResources name? @@ -11,7 +11,7 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -19,15 +19,15 @@

    Default

    true
    -

    ReadonlyhostedZoneResources

    hostedZoneResources: string[]

    Names of hosted zone provider named resources (@see LookupHostedZoneProvider) for external DNS. +

    ReadonlyhostedZoneResources

    hostedZoneResources: string[]

    Names of hosted zone provider named resources (@see LookupHostedZoneProvider) for external DNS. Hosted zone providers are registered as named resource providers with the EksBlueprintProps.

    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optional Readonlysources

    sources?: string[]

    List of sources to watch when synthesizing DNS records. If empty, the default types are "service" and "ingress".

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optional Readonlysources

    sources?: string[]

    List of sources to watch when synthesizing DNS records. If empty, the default types are "service" and "ingress".

    +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.ExternalsSecretsAddOnProps.html b/api/interfaces/addons.ExternalsSecretsAddOnProps.html index 391aa302f..35b57825f 100644 --- a/api/interfaces/addons.ExternalsSecretsAddOnProps.html +++ b/api/interfaces/addons.ExternalsSecretsAddOnProps.html @@ -1,5 +1,5 @@ ExternalsSecretsAddOnProps | @aws-quickstart/eks-blueprints

    Interface ExternalsSecretsAddOnProps

    Configuration options for the ExternalsSecrets add-on.

    -
    interface ExternalsSecretsAddOnProps {
        chart?: string;
        dependencyMode?: boolean;
        iamPolicies?: PolicyStatement[];
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface ExternalsSecretsAddOnProps {
        chart?: string;
        dependencyMode?: boolean;
        iamPolicies?: PolicyStatement[];
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? dependencyMode? iamPolicies? name? @@ -10,7 +10,7 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -18,13 +18,13 @@

    Default

    true
    -

    OptionaliamPolicies

    iamPolicies?: PolicyStatement[]

    Iam policies for the add-on.

    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    OptionaliamPolicies

    iamPolicies?: PolicyStatement[]

    Iam policies for the add-on.

    +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.FalcoAddOnProps.html b/api/interfaces/addons.FalcoAddOnProps.html index db4ae66ad..c4569ed1a 100644 --- a/api/interfaces/addons.FalcoAddOnProps.html +++ b/api/interfaces/addons.FalcoAddOnProps.html @@ -1,5 +1,5 @@ FalcoAddOnProps | @aws-quickstart/eks-blueprints

    Interface FalcoAddOnProps

    User provided options for the Helm Chart

    -
    interface FalcoAddOnProps {
        auditLogsEnabled?: string;
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        falcoSidekickEnabled?: string;
        falcoSidekickWebuiEnabled?: string;
        kubernetesSupportEnabled?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    auditLogsEnabled? +
    interface FalcoAddOnProps {
        auditLogsEnabled?: string;
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        falcoSidekickEnabled?: string;
        falcoSidekickWebuiEnabled?: string;
        kubernetesSupportEnabled?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    auditLogsEnabled? chart? createNamespace? dependencyMode? @@ -14,12 +14,12 @@ values? version?

    Properties

    OptionalauditLogsEnabled

    auditLogsEnabled?: string

    Enable audit logs for Falco

    -

    Optionalchart

    chart?: string

    Chart name

    -

    OptionalcreateNamespace

    createNamespace?: boolean

    Create namespace for Falco

    +

    Optionalchart

    chart?: string

    Chart name

    +

    OptionalcreateNamespace

    createNamespace?: boolean

    Create namespace for Falco

    Default

    falco
    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -27,15 +27,15 @@

    Default

    true
    -

    OptionalfalcoSidekickEnabled

    falcoSidekickEnabled?: string

    Enable falcosidekick deployment

    -

    OptionalfalcoSidekickWebuiEnabled

    falcoSidekickWebuiEnabled?: string

    Enable falcosidekick webui which provides a simple WebUI for displaying latest events from Falco. It works as output for Falcosidekick.

    -

    OptionalkubernetesSupportEnabled

    kubernetesSupportEnabled?: boolean

    Enable Kubernetes meta data collection via a connection to the Kubernetes API server

    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    OptionalfalcoSidekickEnabled

    falcoSidekickEnabled?: string

    Enable falcosidekick deployment

    +

    OptionalfalcoSidekickWebuiEnabled

    falcoSidekickWebuiEnabled?: string

    Enable falcosidekick webui which provides a simple WebUI for displaying latest events from Falco. It works as output for Falcosidekick.

    +

    OptionalkubernetesSupportEnabled

    kubernetesSupportEnabled?: boolean

    Enable Kubernetes meta data collection via a connection to the Kubernetes API server

    +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Version of the helm chart to deploy

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Version of the helm chart to deploy

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.FluxBucketRepo.html b/api/interfaces/addons.FluxBucketRepo.html index 1de9c98b4..770fae702 100644 --- a/api/interfaces/addons.FluxBucketRepo.html +++ b/api/interfaces/addons.FluxBucketRepo.html @@ -1,5 +1,5 @@ FluxBucketRepo | @aws-quickstart/eks-blueprints

    Interface FluxBucketRepo

    Options for a FluxCD Bucket.

    -
    interface FluxBucketRepo {
        bucketName: string;
        bucketRegion: string;
        endpoint?: string;
        kustomizations?: FluxKustomizationProps[];
        name: string;
        namespace?: string;
        prefixPath?: string;
        provider?: string;
        secretRefName?: string;
        syncInterval?: string;
        values?: Values;
    }

    Properties

    bucketName +
    interface FluxBucketRepo {
        bucketName: string;
        bucketRegion: string;
        endpoint?: string;
        kustomizations?: FluxKustomizationProps[];
        name: string;
        namespace?: string;
        prefixPath?: string;
        provider?: string;
        secretRefName?: string;
        syncInterval?: string;
        values?: Values;
    }

    Properties

    bucketName bucketRegion endpoint? kustomizations? @@ -11,20 +11,20 @@ syncInterval? values?

    Properties

    bucketName

    bucketName: string

    Source S3 Bucket name

    -

    bucketRegion

    bucketRegion: string

    Source S3 Bucket region

    -

    Optionalendpoint

    endpoint?: string

    Override S3 Bucket endpoint (optional) +

    bucketRegion

    bucketRegion: string

    Source S3 Bucket region

    +

    Optionalendpoint

    endpoint?: string

    Override S3 Bucket endpoint (optional) Default s3.amazonaws.com

    -

    Optionalkustomizations

    kustomizations?: FluxKustomizationProps[]

    List of kustomizations to create from different paths in repo (optional)

    -

    name

    name: string

    Name of the FluxCD bucket resource.

    -

    Optionalnamespace

    namespace?: string

    Namespace for the FluxCD bucket source (optional) +

    Optionalkustomizations

    kustomizations?: FluxKustomizationProps[]

    List of kustomizations to create from different paths in repo (optional)

    +

    name

    name: string

    Name of the FluxCD bucket resource.

    +

    Optionalnamespace

    namespace?: string

    Namespace for the FluxCD bucket source (optional) Default is the chart namespace

    -

    OptionalprefixPath

    prefixPath?: string

    Prefix path used for server-side filtering (optional)

    -

    Optionalprovider

    provider?: string

    Override S3 Bucket provider (optional) +

    OptionalprefixPath

    prefixPath?: string

    Prefix path used for server-side filtering (optional)

    +

    Optionalprovider

    provider?: string

    Override S3 Bucket provider (optional) Default aws

    -

    OptionalsecretRefName

    secretRefName?: string

    References to a Secret containing accesskey and secretkey fields to authenticate as an IAM user (optional) +

    OptionalsecretRefName

    secretRefName?: string

    References to a Secret containing accesskey and secretkey fields to authenticate as an IAM user (optional) Default to authentication using the IAM instance profile

    -

    OptionalsyncInterval

    syncInterval?: string

    Syncronization time interval for Flux sync +

    OptionalsyncInterval

    syncInterval?: string

    Syncronization time interval for Flux sync Default 5m0s

    -

    Optionalvalues

    values?: Values

    Flux Kustomization variable substitutions (optional) +

    Optionalvalues

    values?: Values

    Flux Kustomization variable substitutions (optional) https://fluxcd.io/flux/components/kustomize/kustomizations/#post-build-variable-substitution

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.FluxCDAddOnProps.html b/api/interfaces/addons.FluxCDAddOnProps.html index cd13bbfd8..269392123 100644 --- a/api/interfaces/addons.FluxCDAddOnProps.html +++ b/api/interfaces/addons.FluxCDAddOnProps.html @@ -1,5 +1,5 @@ FluxCDAddOnProps | @aws-quickstart/eks-blueprints

    Interface FluxCDAddOnProps

    User provided options for the Helm Chart

    -
    interface FluxCDAddOnProps {
        buckets?: FluxBucketRepo[];
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repositories?: FluxGitRepo[];
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    buckets? +
    interface FluxCDAddOnProps {
        buckets?: FluxBucketRepo[];
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repositories?: FluxGitRepo[];
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    buckets? chart? createNamespace? dependencyMode? @@ -12,9 +12,9 @@ values? version?

    Properties

    Optionalbuckets

    buckets?: FluxBucketRepo[]

    List of buckets to sync from.

    -

    Optionalchart

    chart?: string

    Chart name

    -

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    Optionalchart

    chart?: string

    Chart name

    +

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -22,19 +22,19 @@

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where add-on will be deployed.

    +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where add-on will be deployed.

    Default

    flux-system
    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepositories

    repositories?: FluxGitRepo[]

    List of repositories to sync from.

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepositories

    repositories?: FluxGitRepo[]

    List of repositories to sync from.

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Values to pass to the chart as per https://github.com/argoproj/argo-helm/blob/master/charts/argo-cd/values.yaml.

    -

    Optionalversion

    version?: string

    Helm chart version to use to install.

    +

    Optionalvalues

    values?: Values

    Values to pass to the chart as per https://github.com/argoproj/argo-helm/blob/master/charts/argo-cd/values.yaml.

    +

    Optionalversion

    version?: string

    Helm chart version to use to install.

    Default

    2.13.0
    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.FluxGitRepo.html b/api/interfaces/addons.FluxGitRepo.html index 53038f3dc..7959641c3 100644 --- a/api/interfaces/addons.FluxGitRepo.html +++ b/api/interfaces/addons.FluxGitRepo.html @@ -1,6 +1,6 @@ FluxGitRepo | @aws-quickstart/eks-blueprints

    Interface FluxGitRepo

    Options for a FluxCD GitRepository path and name parameter within repository parameter do not have any affect in flux, may have an affect in argo

    -
    interface FluxGitRepo {
        kustomizations?: FluxKustomizationProps[];
        name: string;
        namespace: undefined | string;
        repository: GitRepositoryReference;
        secretRefName?: string;
        syncInterval?: string;
        values: Values;
    }

    Hierarchy

    Properties

    kustomizations? +
    interface FluxGitRepo {
        kustomizations?: FluxKustomizationProps[];
        name: string;
        namespace: undefined | string;
        repository: GitRepositoryReference;
        secretRefName?: string;
        syncInterval?: string;
        values: Values;
    }

    Hierarchy

    Properties

    kustomizations? name namespace repository @@ -8,7 +8,7 @@ syncInterval? values

    Properties

    Optionalkustomizations

    kustomizations?: FluxKustomizationProps[]

    List of kustomizations to create from different paths in repo

    -

    name

    name: string

    namespace

    namespace: undefined | string

    repository

    repository: GitRepositoryReference

    OptionalsecretRefName

    secretRefName?: string

    Flux SecretRef

    -

    OptionalsyncInterval

    syncInterval?: string

    Internal for Flux sync. +

    name

    name: string

    namespace

    namespace: undefined | string

    repository

    repository: GitRepositoryReference

    OptionalsecretRefName

    secretRefName?: string

    Flux SecretRef

    +

    OptionalsyncInterval

    syncInterval?: string

    Internal for Flux sync. Default 5m0s

    -

    values

    values: Values

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    values

    values: Values

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.FluxKustomizationProps.html b/api/interfaces/addons.FluxKustomizationProps.html index 1fbf0bc2d..9adda7aa8 100644 --- a/api/interfaces/addons.FluxKustomizationProps.html +++ b/api/interfaces/addons.FluxKustomizationProps.html @@ -1,16 +1,16 @@ -FluxKustomizationProps | @aws-quickstart/eks-blueprints

    Interface FluxKustomizationProps

    interface FluxKustomizationProps {
        kustomizationPath: string;
        kustomizationTargetNamespace?: string;
        prune?: boolean;
        syncInterval?: string;
        timeout?: string;
    }

    Properties

    kustomizationPath +FluxKustomizationProps | @aws-quickstart/eks-blueprints

    Interface FluxKustomizationProps

    interface FluxKustomizationProps {
        kustomizationPath: string;
        kustomizationTargetNamespace?: string;
        prune?: boolean;
        syncInterval?: string;
        timeout?: string;
    }

    Properties

    kustomizationPath kustomizationTargetNamespace? prune? syncInterval? timeout?

    Properties

    kustomizationPath

    kustomizationPath: string

    Flux Kustomization path within the GitRepository Do not use the path in the repository field

    -

    OptionalkustomizationTargetNamespace

    kustomizationTargetNamespace?: string

    Flux Kustomization Target Namespace. +

    OptionalkustomizationTargetNamespace

    kustomizationTargetNamespace?: string

    Flux Kustomization Target Namespace. Note: when set, this parameter will override all the objects that are part of the Kustomization, please see https://fluxcd.io/flux/components/kustomize/kustomization/#target-namespace

    -

    Optionalprune

    prune?: boolean

    Flux Kustomization Prune. +

    Optionalprune

    prune?: boolean

    Flux Kustomization Prune. Default true

    -

    OptionalsyncInterval

    syncInterval?: string

    Internal for Flux sync. +

    OptionalsyncInterval

    syncInterval?: string

    Internal for Flux sync. Default 5m0s

    -

    Optionaltimeout

    timeout?: string

    Flux Kustomization Timeout. +

    Optionaltimeout

    timeout?: string

    Flux Kustomization Timeout. Default 1m

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.GpuOperatorAddonProps.html b/api/interfaces/addons.GpuOperatorAddonProps.html index e8c1dcdc2..337993cfd 100644 --- a/api/interfaces/addons.GpuOperatorAddonProps.html +++ b/api/interfaces/addons.GpuOperatorAddonProps.html @@ -1,5 +1,5 @@ GpuOperatorAddonProps | @aws-quickstart/eks-blueprints

    Interface GpuOperatorAddonProps

    User provided options for the Helm Chart

    -
    interface GpuOperatorAddonProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: ValuesSchema;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface GpuOperatorAddonProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: ValuesSchema;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? createNamespace? dependencyMode? name? @@ -10,8 +10,8 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -19,12 +19,12 @@

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: ValuesSchema

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: ValuesSchema

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.GrafanaOperatorAddonProps.html b/api/interfaces/addons.GrafanaOperatorAddonProps.html index 4008efca3..a19c5f9a2 100644 --- a/api/interfaces/addons.GrafanaOperatorAddonProps.html +++ b/api/interfaces/addons.GrafanaOperatorAddonProps.html @@ -1,5 +1,5 @@ GrafanaOperatorAddonProps | @aws-quickstart/eks-blueprints

    Interface GrafanaOperatorAddonProps

    User provided options for the Helm Chart

    -
    interface GrafanaOperatorAddonProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface GrafanaOperatorAddonProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? createNamespace? dependencyMode? name? @@ -10,8 +10,8 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -19,12 +19,12 @@

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.IngressNginxAddOnProps.html b/api/interfaces/addons.IngressNginxAddOnProps.html index ca59e7fd4..6c29c9fdc 100644 --- a/api/interfaces/addons.IngressNginxAddOnProps.html +++ b/api/interfaces/addons.IngressNginxAddOnProps.html @@ -1,6 +1,6 @@ IngressNginxAddOnProps | @aws-quickstart/eks-blueprints

    Interface IngressNginxAddOnProps

    Properties available to configure the nginx ingress controller. Values to pass to the chart as per https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/

    -
    interface IngressNginxAddOnProps {
        backendProtocol?: string;
        certificateResourceARN?: string;
        certificateResourceName?: string;
        chart?: string;
        controllerClass?: string;
        crossZoneEnabled?: boolean;
        dependencyMode?: boolean;
        electionId?: string;
        externalDnsHostname?: string;
        forceSSLRedirect?: boolean;
        httpTargetPort?: string;
        httpsTargetPort?: string;
        idleTimeout?: string;
        ingressClassName?: string;
        internetFacing?: boolean;
        isDefaultClass?: boolean;
        loadBalancerType?: string;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        serviceType?: string;
        skipVersionValidation?: boolean;
        sslPort?: string;
        targetType?: string;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    backendProtocol? +
    interface IngressNginxAddOnProps {
        backendProtocol?: string;
        certificateResourceARN?: string;
        certificateResourceName?: string;
        chart?: string;
        controllerClass?: string;
        crossZoneEnabled?: boolean;
        dependencyMode?: boolean;
        electionId?: string;
        externalDnsHostname?: string;
        forceSSLRedirect?: boolean;
        httpTargetPort?: string;
        httpsTargetPort?: string;
        idleTimeout?: string;
        ingressClassName?: string;
        internetFacing?: boolean;
        isDefaultClass?: boolean;
        loadBalancerType?: string;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        serviceType?: string;
        skipVersionValidation?: boolean;
        sslPort?: string;
        targetType?: string;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    backendProtocol? certificateResourceARN? certificateResourceName? chart? @@ -32,16 +32,16 @@

    Default

    'http'
    -

    OptionalcertificateResourceARN

    certificateResourceARN?: string

    ARN of the AWS Certificate Manager certificate to be used for HTTPS.

    -

    OptionalcertificateResourceName

    certificateResourceName?: string

    Name of the certificate NamedResourceProvider to be used for certificate look up.

    +

    OptionalcertificateResourceARN

    certificateResourceARN?: string

    ARN of the AWS Certificate Manager certificate to be used for HTTPS.

    +

    OptionalcertificateResourceName

    certificateResourceName?: string

    Name of the certificate NamedResourceProvider to be used for certificate look up.

    See

    ImportCertificateProvider and CreateCertificateProvider for examples of certificate providers.

    -

    Optionalchart

    chart?: string

    The name of the chart within the Helm release.

    -

    OptionalcontrollerClass

    controllerClass?: string

    Specifies the controller class used for handling ingress in a cluster.

    -

    OptionalcrossZoneEnabled

    crossZoneEnabled?: boolean

    Determines whether cross-zone load balancing is enabled for the load balancer.

    +

    Optionalchart

    chart?: string

    The name of the chart within the Helm release.

    +

    OptionalcontrollerClass

    controllerClass?: string

    Specifies the controller class used for handling ingress in a cluster.

    +

    OptionalcrossZoneEnabled

    crossZoneEnabled?: boolean

    Determines whether cross-zone load balancing is enabled for the load balancer.

    Default

    true
    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -49,63 +49,63 @@

    Default

    true
    -

    OptionalelectionId

    electionId?: string

    Identifier used for leader election during the deployment of multiple ingress controllers.

    -

    OptionalexternalDnsHostname

    externalDnsHostname?: string

    Hostname to be used with external DNS services for automatic DNS configuration.

    -

    OptionalforceSSLRedirect

    forceSSLRedirect?: boolean

    Determines if SSL redirection should be forced.

    +

    OptionalelectionId

    electionId?: string

    Identifier used for leader election during the deployment of multiple ingress controllers.

    +

    OptionalexternalDnsHostname

    externalDnsHostname?: string

    Hostname to be used with external DNS services for automatic DNS configuration.

    +

    OptionalforceSSLRedirect

    forceSSLRedirect?: boolean

    Determines if SSL redirection should be forced.

    Default

    true
    -

    OptionalhttpTargetPort

    httpTargetPort?: string

    Protocol for the load balancer HTTP target port.

    +

    OptionalhttpTargetPort

    httpTargetPort?: string

    Protocol for the load balancer HTTP target port.

    Default

    'http'
    -

    OptionalhttpsTargetPort

    httpsTargetPort?: string

    Protocol for the load balancer HTTPS target port.

    +

    OptionalhttpsTargetPort

    httpsTargetPort?: string

    Protocol for the load balancer HTTPS target port.

    Default

    'https'
    -

    OptionalidleTimeout

    idleTimeout?: string

    ARN of the AWS Certificate Manager certificate to be used for HTTPS.

    +

    OptionalidleTimeout

    idleTimeout?: string

    ARN of the AWS Certificate Manager certificate to be used for HTTPS.

    Default

    "3600"
    -

    OptionalingressClassName

    ingressClassName?: string

    Specifies the class of the ingress controller. Used to differentiate between multiple ingress controllers.

    +

    OptionalingressClassName

    ingressClassName?: string

    Specifies the class of the ingress controller. Used to differentiate between multiple ingress controllers.

    Default

    'nginx'
    -

    OptionalinternetFacing

    internetFacing?: boolean

    Indicates whether the load balancer is exposed to the internet. +

    OptionalinternetFacing

    internetFacing?: boolean

    Indicates whether the load balancer is exposed to the internet. Set to false for an internal load balancer.

    Default

    true
    -

    OptionalisDefaultClass

    isDefaultClass?: boolean

    Determines if the ingress controller should be set as the default controller for handling ingress resources.

    +

    OptionalisDefaultClass

    isDefaultClass?: boolean

    Determines if the ingress controller should be set as the default controller for handling ingress resources.

    Default

    false
    -

    OptionalloadBalancerType

    loadBalancerType?: string

    Type of the load balancer.

    +

    OptionalloadBalancerType

    loadBalancerType?: string

    Type of the load balancer.

    Default

    'external'
    -

    Optionalname

    name?: string

    The name of the Kubernetes Ingress Helm release.

    -

    Optionalnamespace

    namespace?: string

    Kubernetes namespace where the ingress controller will be installed.

    +

    Optionalname

    name?: string

    The name of the Kubernetes Ingress Helm release.

    +

    Optionalnamespace

    namespace?: string

    Kubernetes namespace where the ingress controller will be installed.

    Default

    'kube-system'
    -

    Optionalrelease

    release?: string

    Unique identifier for the release.

    -

    Optionalrepository

    repository?: string

    URL of the chart repository.

    -

    OptionalserviceType

    serviceType?: string

    Kubernetes service type for the ingress controller. Supported values are 'ClusterIP', 'LoadBalancer' and 'NodePort'.

    +

    Optionalrelease

    release?: string

    Unique identifier for the release.

    +

    Optionalrepository

    repository?: string

    URL of the chart repository.

    +

    OptionalserviceType

    serviceType?: string

    Kubernetes service type for the ingress controller. Supported values are 'ClusterIP', 'LoadBalancer' and 'NodePort'.

    Default

    'LoadBalancer'
    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    OptionalsslPort

    sslPort?: string

    Protocol for the load balancer SSL port.

    +

    OptionalsslPort

    sslPort?: string

    Protocol for the load balancer SSL port.

    Default

    'https'
    -

    OptionaltargetType

    targetType?: string

    Specifies how traffic is routed to pods. Can be either 'ip' or 'instance'. +

    OptionaltargetType

    targetType?: string

    Specifies how traffic is routed to pods. Can be either 'ip' or 'instance'. 'ip' mode is more performant and requires VPC-CNI.

    Default

    'ip'
    -

    Optionalvalues

    values?: Values

    Custom values passed to the Helm chart.

    -

    Optionalversion

    version?: string

    Specific version of the chart to be deployed.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Custom values passed to the Helm chart.

    +

    Optionalversion

    version?: string

    Specific version of the chart to be deployed.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.IstioBaseAddOnProps.html b/api/interfaces/addons.IstioBaseAddOnProps.html index 3c623f513..b02637641 100644 --- a/api/interfaces/addons.IstioBaseAddOnProps.html +++ b/api/interfaces/addons.IstioBaseAddOnProps.html @@ -1,5 +1,5 @@ IstioBaseAddOnProps | @aws-quickstart/eks-blueprints

    Interface IstioBaseAddOnProps

    Configuration options for the add-on.

    -
    interface IstioBaseAddOnProps {
        chart?: string;
        configValidation?: boolean;
        dependencyMode?: boolean;
        enableAnalysis?: boolean;
        enableIstioConfigCRDs?: boolean;
        externalIstiod?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        remotePilotAddress?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        validationURL?: string;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface IstioBaseAddOnProps {
        chart?: string;
        configValidation?: boolean;
        dependencyMode?: boolean;
        enableAnalysis?: boolean;
        enableIstioConfigCRDs?: boolean;
        externalIstiod?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        remotePilotAddress?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        validationURL?: string;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? configValidation? dependencyMode? enableAnalysis? @@ -15,11 +15,11 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionalconfigValidation

    configValidation?: boolean

    Enable the istio base config validation.

    +

    OptionalconfigValidation

    configValidation?: boolean

    Enable the istio base config validation.

    Default

    true
    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -27,33 +27,33 @@

    Default

    true
    -

    OptionalenableAnalysis

    enableAnalysis?: boolean

    Enable istioctl analysis which provides rich analysis of Istio configuration state in order to identity invalid or suboptimal configurations.

    +

    OptionalenableAnalysis

    enableAnalysis?: boolean

    Enable istioctl analysis which provides rich analysis of Istio configuration state in order to identity invalid or suboptimal configurations.

    Default

    false
    -

    OptionalenableIstioConfigCRDs

    enableIstioConfigCRDs?: boolean

    For istioctl usage to disable istio config crds in base.

    +

    OptionalenableIstioConfigCRDs

    enableIstioConfigCRDs?: boolean

    For istioctl usage to disable istio config crds in base.

    Default

    true
    -

    OptionalexternalIstiod

    externalIstiod?: boolean

    If this is set to true, one Istiod will control remote clusters including CA.

    +

    OptionalexternalIstiod

    externalIstiod?: boolean

    If this is set to true, one Istiod will control remote clusters including CA.

    Default

    false
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    OptionalremotePilotAddress

    remotePilotAddress?: string

    The address or hostname of the remote pilot

    +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    OptionalremotePilotAddress

    remotePilotAddress?: string

    The address or hostname of the remote pilot

    Default

    null
    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    OptionalvalidationURL

    validationURL?: string

    Validation webhook configuration url +

    OptionalvalidationURL

    validationURL?: string

    Validation webhook configuration url For example: https://:15017$remotePilotAddress/validate

    Default

    null
    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.IstioCniAddonProps.html b/api/interfaces/addons.IstioCniAddonProps.html index e502934f4..ffdec8e47 100644 --- a/api/interfaces/addons.IstioCniAddonProps.html +++ b/api/interfaces/addons.IstioCniAddonProps.html @@ -1,5 +1,5 @@ IstioCniAddonProps | @aws-quickstart/eks-blueprints

    Interface IstioCniAddonProps

    User provided option for the Helm Chart

    -
    interface IstioCniAddonProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface IstioCniAddonProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? createNamespace? dependencyMode? name? @@ -10,8 +10,8 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -19,12 +19,12 @@

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.IstioControlPlaneAddOnProps.html b/api/interfaces/addons.IstioControlPlaneAddOnProps.html index 1db25cdd3..dce3c1a00 100644 --- a/api/interfaces/addons.IstioControlPlaneAddOnProps.html +++ b/api/interfaces/addons.IstioControlPlaneAddOnProps.html @@ -1,4 +1,4 @@ -IstioControlPlaneAddOnProps | @aws-quickstart/eks-blueprints

    Interface IstioControlPlaneAddOnProps

    interface IstioControlPlaneAddOnProps {
        chart?: string;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: ValuesSchema;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +IstioControlPlaneAddOnProps | @aws-quickstart/eks-blueprints

    Interface IstioControlPlaneAddOnProps

    interface IstioControlPlaneAddOnProps {
        chart?: string;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: ValuesSchema;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? dependencyMode? name? namespace? @@ -8,7 +8,7 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -16,12 +16,12 @@

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: ValuesSchema

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: ValuesSchema

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.IstioIngressGatewayAddonProps.html b/api/interfaces/addons.IstioIngressGatewayAddonProps.html index d65b86026..da0fb1a0e 100644 --- a/api/interfaces/addons.IstioIngressGatewayAddonProps.html +++ b/api/interfaces/addons.IstioIngressGatewayAddonProps.html @@ -1,5 +1,5 @@ IstioIngressGatewayAddonProps | @aws-quickstart/eks-blueprints

    Interface IstioIngressGatewayAddonProps

    User provided option for the Helm Chart

    -
    interface IstioIngressGatewayAddonProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface IstioIngressGatewayAddonProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? createNamespace? dependencyMode? name? @@ -10,8 +10,8 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -19,12 +19,12 @@

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.JmesPathObject.html b/api/interfaces/addons.JmesPathObject.html index 53237c05a..5a9ab9fe9 100644 --- a/api/interfaces/addons.JmesPathObject.html +++ b/api/interfaces/addons.JmesPathObject.html @@ -1,3 +1,3 @@ -JmesPathObject | @aws-quickstart/eks-blueprints

    Interface JmesPathObject

    interface JmesPathObject {
        objectAlias: string;
        path: string;
    }

    Properties

    objectAlias +JmesPathObject | @aws-quickstart/eks-blueprints

    Interface JmesPathObject

    interface JmesPathObject {
        objectAlias: string;
        path: string;
    }

    Properties

    objectAlias path -

    Properties

    objectAlias

    objectAlias: string

    path

    path: string

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Properties

    objectAlias

    objectAlias: string

    path

    path: string

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.JupyterHubAddOnProps.html b/api/interfaces/addons.JupyterHubAddOnProps.html index 89609f3ce..1bffcd49b 100644 --- a/api/interfaces/addons.JupyterHubAddOnProps.html +++ b/api/interfaces/addons.JupyterHubAddOnProps.html @@ -1,5 +1,5 @@ JupyterHubAddOnProps | @aws-quickstart/eks-blueprints

    Interface JupyterHubAddOnProps

    Configuration options for the add-on.

    -
    interface JupyterHubAddOnProps {
        certificateResourceName?: string;
        chart?: string;
        dependencyMode?: boolean;
        ebsConfig?: {
            capacity: string;
            storageClass: string;
        };
        efsConfig?: {
            capacity: string;
            pvcName: string;
            removalPolicy: RemovalPolicy;
        };
        ingressAnnotations?: {
            [key: string]: string;
        };
        ingressHosts?: string[];
        name?: string;
        namespace?: string;
        notebookStack?: string;
        oidcConfig?: {
            authUrl: string;
            callbackUrl: string;
            clientId: string;
            clientSecret: string;
            scope?: string[];
            tokenUrl: string;
            userDataUrl: string;
            usernameKey?: string;
        };
        release?: string;
        repository?: string;
        serviceType: JupyterHubServiceType;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    certificateResourceName? +
    interface JupyterHubAddOnProps {
        certificateResourceName?: string;
        chart?: string;
        dependencyMode?: boolean;
        ebsConfig?: {
            capacity: string;
            storageClass: string;
        };
        efsConfig?: {
            capacity: string;
            pvcName: string;
            removalPolicy: RemovalPolicy;
        };
        ingressAnnotations?: {
            [key: string]: string;
        };
        ingressHosts?: string[];
        name?: string;
        namespace?: string;
        notebookStack?: string;
        oidcConfig?: {
            authUrl: string;
            callbackUrl: string;
            clientId: string;
            clientSecret: string;
            scope?: string[];
            tokenUrl: string;
            userDataUrl: string;
            usernameKey?: string;
        };
        release?: string;
        repository?: string;
        serviceType: JupyterHubServiceType;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    certificateResourceName? chart? dependencyMode? ebsConfig? @@ -18,8 +18,8 @@ version?

    Properties

    OptionalcertificateResourceName

    certificateResourceName?: string

    Name of the certificate NamedResourceProvider to be used for certificate look up.

    See

    ImportCertificateProvider and CreateCertificateProvider for examples of certificate providers.

    -

    Optionalchart

    chart?: string

    Chart name

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    Optionalchart

    chart?: string

    Chart name

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -27,22 +27,22 @@

    Default

    true
    -

    OptionalebsConfig

    ebsConfig?: {
        capacity: string;
        storageClass: string;
    }

    Configurations necessary to use EBS as Persistent Volume

    -

    OptionalefsConfig

    efsConfig?: {
        capacity: string;
        pvcName: string;
        removalPolicy: RemovalPolicy;
    }

    Configuration necessary to use EFS as Persistent Volume

    -

    OptionalingressAnnotations

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

    Ingress annotations - only apply if Ingress is enabled, otherwise throws an error

    -

    OptionalingressHosts

    ingressHosts?: string[]

    Ingress host - only if Ingress is enabled +

    OptionalebsConfig

    ebsConfig?: {
        capacity: string;
        storageClass: string;
    }

    Configurations necessary to use EBS as Persistent Volume

    +

    OptionalefsConfig

    efsConfig?: {
        capacity: string;
        pvcName: string;
        removalPolicy: RemovalPolicy;
    }

    Configuration necessary to use EFS as Persistent Volume

    +

    OptionalingressAnnotations

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

    Ingress annotations - only apply if Ingress is enabled, otherwise throws an error

    +

    OptionalingressHosts

    ingressHosts?: string[]

    Ingress host - only if Ingress is enabled It is a list of available hosts to be routed upon request

    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    OptionalnotebookStack

    notebookStack?: string

    Notebook stack as defined using Docker Stacks for Jupyter here: +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    OptionalnotebookStack

    notebookStack?: string

    Notebook stack as defined using Docker Stacks for Jupyter here: https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html#core-stacks

    -

    OptionaloidcConfig

    oidcConfig?: {
        authUrl: string;
        callbackUrl: string;
        clientId: string;
        clientSecret: string;
        scope?: string[];
        tokenUrl: string;
        userDataUrl: string;
        usernameKey?: string;
    }

    Configuration settings for OpenID Connect authentication protocol

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    serviceType

    serviceType: JupyterHubServiceType

    Configuration to set how the hub service will be exposed +

    OptionaloidcConfig

    oidcConfig?: {
        authUrl: string;
        callbackUrl: string;
        clientId: string;
        clientSecret: string;
        scope?: string[];
        tokenUrl: string;
        userDataUrl: string;
        usernameKey?: string;
    }

    Configuration settings for OpenID Connect authentication protocol

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    serviceType

    serviceType: JupyterHubServiceType

    Configuration to set how the hub service will be exposed See enum jupyterHubService for choices

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.KarpenterAddOnProps.html b/api/interfaces/addons.KarpenterAddOnProps.html index 41bb4fdc8..521952da8 100644 --- a/api/interfaces/addons.KarpenterAddOnProps.html +++ b/api/interfaces/addons.KarpenterAddOnProps.html @@ -1,5 +1,5 @@ KarpenterAddOnProps | @aws-quickstart/eks-blueprints

    Interface KarpenterAddOnProps

    Configuration options for the add-on

    -
    interface KarpenterAddOnProps {
        chart?: string;
        dependencyMode?: boolean;
        ec2NodeClassSpec?: Ec2NodeClassSpec;
        helmChartTimeout?: Duration;
        installCRDs?: boolean;
        interruptionHandling?: boolean;
        name?: string;
        namespace?: string;
        nodePoolSpec?: NodePoolSpec;
        podIdentity?: boolean;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface KarpenterAddOnProps {
        chart?: string;
        dependencyMode?: boolean;
        ec2NodeClassSpec?: Ec2NodeClassSpec;
        helmChartTimeout?: Duration;
        installCRDs?: boolean;
        interruptionHandling?: boolean;
        name?: string;
        namespace?: string;
        nodePoolSpec?: NodePoolSpec;
        podIdentity?: boolean;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? dependencyMode? ec2NodeClassSpec? helmChartTimeout? @@ -15,7 +15,7 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -23,16 +23,16 @@

    Default

    true
    -

    Optionalec2NodeClassSpec

    ec2NodeClassSpec?: Ec2NodeClassSpec

    This is the top level spec for the AWS Karpenter Provider +

    Optionalec2NodeClassSpec

    ec2NodeClassSpec?: Ec2NodeClassSpec

    This is the top level spec for the AWS Karpenter Provider It contains configuration necessary to launch instances in AWS.

    -

    OptionalhelmChartTimeout

    helmChartTimeout?: Duration

    Timeout duration while installing karpenter helm chart using addHelmChart API

    -

    OptionalinstallCRDs

    installCRDs?: boolean

    OptionalinterruptionHandling

    interruptionHandling?: boolean

    Flag for enabling Karpenter's native interruption handling

    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    OptionalnodePoolSpec

    nodePoolSpec?: NodePoolSpec

    This is the top level nodepool specification. Nodepools launch nodes in response to pods that are unschedulable. +

    OptionalhelmChartTimeout

    helmChartTimeout?: Duration

    Timeout duration while installing karpenter helm chart using addHelmChart API

    +

    OptionalinstallCRDs

    installCRDs?: boolean

    OptionalinterruptionHandling

    interruptionHandling?: boolean

    Flag for enabling Karpenter's native interruption handling

    +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    OptionalnodePoolSpec

    nodePoolSpec?: NodePoolSpec

    This is the top level nodepool specification. Nodepools launch nodes in response to pods that are unschedulable. A single nodepool is capable of managing a diverse set of nodes. Node properties are determined from a combination of nodepool and pod scheduling constraints.

    -

    OptionalpodIdentity

    podIdentity?: boolean

    Use Pod Identity. +

    OptionalpodIdentity

    podIdentity?: boolean

    Use Pod Identity. To use EKS Pod Identities

    • The cluster must have Kubernetes version 1.24 or later
      • @@ -43,10 +43,10 @@

      Default

      false
      -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.KedaAddOnProps.html b/api/interfaces/addons.KedaAddOnProps.html index fe68e4f82..c9b626521 100644 --- a/api/interfaces/addons.KedaAddOnProps.html +++ b/api/interfaces/addons.KedaAddOnProps.html @@ -1,5 +1,5 @@ KedaAddOnProps | @aws-quickstart/eks-blueprints

    Interface KedaAddOnProps

    User provided options for the Helm Chart

    -
    interface KedaAddOnProps {
        chart?: string;
        dependencyMode?: boolean;
        irsaRoles?: string[];
        kedaOperatorName?: string;
        kedaServiceAccountName?: string;
        name?: string;
        namespace?: string;
        podSecurityContextFsGroup?: number;
        release?: string;
        repository?: string;
        securityContextRunAsGroup?: number;
        securityContextRunAsUser?: number;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface KedaAddOnProps {
        chart?: string;
        dependencyMode?: boolean;
        irsaRoles?: string[];
        kedaOperatorName?: string;
        kedaServiceAccountName?: string;
        name?: string;
        namespace?: string;
        podSecurityContextFsGroup?: number;
        release?: string;
        repository?: string;
        securityContextRunAsGroup?: number;
        securityContextRunAsUser?: number;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? dependencyMode? irsaRoles? kedaOperatorName? @@ -15,7 +15,7 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -23,25 +23,25 @@

    Default

    true
    -

    OptionalirsaRoles

    irsaRoles?: string[]

    An array of Managed IAM Policies which Service Account of KEDA operator needs for IRSA Eg: irsaRoles:["CloudWatchFullAccess","AmazonSQSFullAccess"]. If not empty +

    OptionalirsaRoles

    irsaRoles?: string[]

    An array of Managed IAM Policies which Service Account of KEDA operator needs for IRSA Eg: irsaRoles:["CloudWatchFullAccess","AmazonSQSFullAccess"]. If not empty Service Account will be Created by CDK with IAM Roles Mapped (IRSA). In case if its empty, Keda will create the Service Account with out IAM Roles

    -

    OptionalkedaOperatorName

    kedaOperatorName?: string

    Name of the KEDA operator

    -

    OptionalkedaServiceAccountName

    kedaServiceAccountName?: string

    The name of the service account to use. If not set and create is true, a name is generated.

    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    OptionalpodSecurityContextFsGroup

    podSecurityContextFsGroup?: number

    securityContext: fsGroup +

    OptionalkedaOperatorName

    kedaOperatorName?: string

    Name of the KEDA operator

    +

    OptionalkedaServiceAccountName

    kedaServiceAccountName?: string

    The name of the service account to use. If not set and create is true, a name is generated.

    +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    OptionalpodSecurityContextFsGroup

    podSecurityContextFsGroup?: number

    securityContext: fsGroup Check the workaround for SQS Scalar with IRSA https://github.com/kedacore/keda/issues/837#issuecomment-789037326

    Deprecated

    Has no effect for version 2.14 and above. Update podSecurityContext.operator.fsGroup in Values instead. KEDA-is-secure-by-default with fsGroup: 1000

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalsecurityContextRunAsGroup

    securityContextRunAsGroup?: number

    securityContext:runAsGroup +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalsecurityContextRunAsGroup

    securityContextRunAsGroup?: number

    securityContext:runAsGroup Check the workaround for SQS Scalar with IRSA https://github.com/kedacore/keda/issues/837#issuecomment-789037326

    Deprecated

    Has no effect for version 2.14 and above. Update podSecurityContext.operator.runAsGroup in Values instead. KEDA-is-secure-by-default with runAsGroup: 1000

    -

    OptionalsecurityContextRunAsUser

    securityContextRunAsUser?: number

    securityContext:runAsUser +

    OptionalsecurityContextRunAsUser

    securityContextRunAsUser?: number

    securityContext:runAsUser Check the workaround for SQS Scalar with IRSA https://github.com/kedacore/keda/issues/837#issuecomment-789037326

    Deprecated

    Has no effect for version 2.14 and above. Update podSecurityContext.operator.runAsUser in Values instead. KEDA-is-secure-by-default with runAsUser: 1000

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Version of the helm chart to deploy

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Version of the helm chart to deploy

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.KnativeOperatorProps.html b/api/interfaces/addons.KnativeOperatorProps.html index 2bf784ec8..a1ca5bc26 100644 --- a/api/interfaces/addons.KnativeOperatorProps.html +++ b/api/interfaces/addons.KnativeOperatorProps.html @@ -1,5 +1,5 @@ KnativeOperatorProps | @aws-quickstart/eks-blueprints

    Interface KnativeOperatorProps

    Knative Operator Properties extended

    -
    interface KnativeOperatorProps {
        chart?: string;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface KnativeOperatorProps {
        chart?: string;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? dependencyMode? name? namespace? @@ -9,7 +9,7 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -17,21 +17,21 @@

    Default

    true
    -

    Optionalname

    name?: string

    The name to be assigned to given to the Knative operator

    +

    Optionalname

    name?: string

    The name to be assigned to given to the Knative operator

    Default

    knative-operator
    -

    Optionalnamespace

    namespace?: string

    The namespace to install Knative in

    +

    Optionalnamespace

    namespace?: string

    The namespace to install Knative in

    Default

    default
    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    The version of the KNative Operator to use

    +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    The version of the KNative Operator to use

    Default

    v1.8.1
    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.KubeRayAddOnProps.html b/api/interfaces/addons.KubeRayAddOnProps.html index a86d9492e..2ebd82a72 100644 --- a/api/interfaces/addons.KubeRayAddOnProps.html +++ b/api/interfaces/addons.KubeRayAddOnProps.html @@ -1,5 +1,5 @@ KubeRayAddOnProps | @aws-quickstart/eks-blueprints

    Interface KubeRayAddOnProps

    User provided options for the Helm Chart

    -
    interface KubeRayAddOnProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface KubeRayAddOnProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? createNamespace? dependencyMode? name? @@ -10,8 +10,8 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -19,12 +19,12 @@

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.KubeStateMetricsAddOnProps.html b/api/interfaces/addons.KubeStateMetricsAddOnProps.html index 8a5bbb015..742ec31bc 100644 --- a/api/interfaces/addons.KubeStateMetricsAddOnProps.html +++ b/api/interfaces/addons.KubeStateMetricsAddOnProps.html @@ -1,5 +1,5 @@ KubeStateMetricsAddOnProps | @aws-quickstart/eks-blueprints

    Interface KubeStateMetricsAddOnProps

    User provided option for the Helm Chart

    -
    interface KubeStateMetricsAddOnProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface KubeStateMetricsAddOnProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? createNamespace? dependencyMode? name? @@ -10,8 +10,8 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -19,12 +19,12 @@

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.KubernetesSecret.html b/api/interfaces/addons.KubernetesSecret.html index d1312ef53..dd10ad1f1 100644 --- a/api/interfaces/addons.KubernetesSecret.html +++ b/api/interfaces/addons.KubernetesSecret.html @@ -1,12 +1,12 @@ KubernetesSecret | @aws-quickstart/eks-blueprints

    Interface KubernetesSecret

    Configuration for Kubernetes Secrets

    -
    interface KubernetesSecret {
        data?: KubernetesSecretObjectData[];
        labels?: Values;
        secretAlias?: string;
        secretName: string;
        type?: KubernetesSecretType;
    }

    Properties

    data? +
    interface KubernetesSecret {
        data?: KubernetesSecretObjectData[];
        labels?: Values;
        secretAlias?: string;
        secretName: string;
        type?: KubernetesSecretType;
    }

    Properties

    data? labels? secretAlias? secretName type?

    Properties

    Optionaldata

    data?: KubernetesSecretObjectData[]

    Kubernetes SecretObject Data

    -

    Optionallabels

    labels?: Values

    Secret Labels

    -

    OptionalsecretAlias

    secretAlias?: string

    An alias for the AWS secret once it is synced as a Kubernetes secret.

    -

    secretName

    secretName: string

    Kubernetes Secret Name

    -

    Optionaltype

    type?: KubernetesSecretType

    Type of Kubernetes Secret

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionallabels

    labels?: Values

    Secret Labels

    +

    OptionalsecretAlias

    secretAlias?: string

    An alias for the AWS secret once it is synced as a Kubernetes secret.

    +

    secretName

    secretName: string

    Kubernetes Secret Name

    +

    Optionaltype

    type?: KubernetesSecretType

    Type of Kubernetes Secret

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.KubeviousAddOnProps.html b/api/interfaces/addons.KubeviousAddOnProps.html index 46eac9de9..709f74e67 100644 --- a/api/interfaces/addons.KubeviousAddOnProps.html +++ b/api/interfaces/addons.KubeviousAddOnProps.html @@ -1,5 +1,5 @@ KubeviousAddOnProps | @aws-quickstart/eks-blueprints

    Interface KubeviousAddOnProps

    User provided options for the Helm Chart

    -
    interface KubeviousAddOnProps {
        chart?: string;
        dependencyMode?: boolean;
        ingressEnabled?: boolean;
        kubeviousServiceType?: string;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface KubeviousAddOnProps {
        chart?: string;
        dependencyMode?: boolean;
        ingressEnabled?: boolean;
        kubeviousServiceType?: string;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? dependencyMode? ingressEnabled? kubeviousServiceType? @@ -11,7 +11,7 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -19,14 +19,14 @@

    Default

    true
    -

    OptionalingressEnabled

    ingressEnabled?: boolean

    Create an ingress for access to Kubevious

    -

    OptionalkubeviousServiceType

    kubeviousServiceType?: string

    Type of service to expose Kubevious UI

    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    OptionalingressEnabled

    ingressEnabled?: boolean

    Create an ingress for access to Kubevious

    +

    OptionalkubeviousServiceType

    kubeviousServiceType?: string

    Type of service to expose Kubevious UI

    +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Version of the helm chart to deploy

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Version of the helm chart to deploy

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.MetricsServerAddOnProps.html b/api/interfaces/addons.MetricsServerAddOnProps.html index 88eee405e..50af2ada5 100644 --- a/api/interfaces/addons.MetricsServerAddOnProps.html +++ b/api/interfaces/addons.MetricsServerAddOnProps.html @@ -1,5 +1,5 @@ MetricsServerAddOnProps | @aws-quickstart/eks-blueprints

    Interface MetricsServerAddOnProps

    Configuration options for the add-on.

    -
    interface MetricsServerAddOnProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface MetricsServerAddOnProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? createNamespace? dependencyMode? name? @@ -10,8 +10,8 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -19,12 +19,12 @@

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.NeuronMonitorAddOnProps.html b/api/interfaces/addons.NeuronMonitorAddOnProps.html index 9ce8927ea..665665c03 100644 --- a/api/interfaces/addons.NeuronMonitorAddOnProps.html +++ b/api/interfaces/addons.NeuronMonitorAddOnProps.html @@ -1,18 +1,18 @@ -NeuronMonitorAddOnProps | @aws-quickstart/eks-blueprints

    Interface NeuronMonitorAddOnProps

    interface NeuronMonitorAddOnProps {
        createNamespace?: boolean;
        imageTag?: string;
        namespace?: string;
        port?: number;
    }

    Properties

    createNamespace? +NeuronMonitorAddOnProps | @aws-quickstart/eks-blueprints

    Interface NeuronMonitorAddOnProps

    interface NeuronMonitorAddOnProps {
        createNamespace?: boolean;
        imageTag?: string;
        namespace?: string;
        port?: number;
    }

    Properties

    createNamespace? imageTag? namespace? port?

    Properties

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK. This should be done only for the first time.

    -

    OptionalimageTag

    imageTag?: string

    The tag of the Neuron Monitor application's Docker image.

    +

    OptionalimageTag

    imageTag?: string

    The tag of the Neuron Monitor application's Docker image.

    Default

    'latest'
    -

    Optionalnamespace

    namespace?: string

    Neuron Application's namespace

    +

    Optionalnamespace

    namespace?: string

    Neuron Application's namespace

    Default

    'kube-system'
    -

    Optionalport

    port?: number

    Application's port

    +

    Optionalport

    port?: number

    Application's port

    Default

    9010
    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.NginxAddOnProps.html b/api/interfaces/addons.NginxAddOnProps.html index df741a48f..211d4df33 100644 --- a/api/interfaces/addons.NginxAddOnProps.html +++ b/api/interfaces/addons.NginxAddOnProps.html @@ -1,6 +1,6 @@ NginxAddOnProps | @aws-quickstart/eks-blueprints

    Interface NginxAddOnProps

    Properties available to configure the nginx ingress controller. Values to pass to the chart as per https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/#

    -
    interface NginxAddOnProps {
        backendProtocol?: string;
        certificateResourceName?: string;
        chart?: string;
        crossZoneEnabled?: boolean;
        dependencyMode?: boolean;
        externalDnsHostname?: string;
        internetFacing?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        targetType?: string;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    backendProtocol? +
    interface NginxAddOnProps {
        backendProtocol?: string;
        certificateResourceName?: string;
        chart?: string;
        crossZoneEnabled?: boolean;
        dependencyMode?: boolean;
        externalDnsHostname?: string;
        internetFacing?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        targetType?: string;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    backendProtocol? certificateResourceName? chart? crossZoneEnabled? @@ -19,14 +19,14 @@

    Default

    tcp
    -

    OptionalcertificateResourceName

    certificateResourceName?: string

    Name of the certificate NamedResourceProvider to be used for certificate look up.

    +

    OptionalcertificateResourceName

    certificateResourceName?: string

    Name of the certificate NamedResourceProvider to be used for certificate look up.

    See

    ImportCertificateProvider and CreateCertificateProvider for examples of certificate providers.

    -

    Optionalchart

    chart?: string

    Chart name

    -

    OptionalcrossZoneEnabled

    crossZoneEnabled?: boolean

    Enabling cross AZ loadbalancing for

    +

    Optionalchart

    chart?: string

    Chart name

    +

    OptionalcrossZoneEnabled

    crossZoneEnabled?: boolean

    Enabling cross AZ loadbalancing for

    Default

    true
    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -34,23 +34,23 @@

    Default

    true
    -

    OptionalexternalDnsHostname

    externalDnsHostname?: string

    Used in conjunction with external DNS add-on to handle automatic registration of the service with Route53.

    -

    OptionalinternetFacing

    internetFacing?: boolean

    If the load balancer created for the ingress is internet facing. +

    OptionalexternalDnsHostname

    externalDnsHostname?: string

    Used in conjunction with external DNS add-on to handle automatic registration of the service with Route53.

    +

    OptionalinternetFacing

    internetFacing?: boolean

    If the load balancer created for the ingress is internet facing. Internal if set to false.

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    OptionaltargetType

    targetType?: string

    IP or instance mode. Default: IP, requires VPC-CNI, has better performance eliminating a hop through kubeproxy +

    OptionaltargetType

    targetType?: string

    IP or instance mode. Default: IP, requires VPC-CNI, has better performance eliminating a hop through kubeproxy Instance mode: traditional NodePort mode on the instance.

    Default

    ip
    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.OpenTelemetryCollector.html b/api/interfaces/addons.OpenTelemetryCollector.html index 6cd84a8d1..4a821c2bc 100644 --- a/api/interfaces/addons.OpenTelemetryCollector.html +++ b/api/interfaces/addons.OpenTelemetryCollector.html @@ -1,9 +1,9 @@ -OpenTelemetryCollector | @aws-quickstart/eks-blueprints

    Interface OpenTelemetryCollector

    interface OpenTelemetryCollector {
        manifestParameterMap?: Values;
        manifestPath: string;
    }

    Properties

    manifestParameterMap? +OpenTelemetryCollector | @aws-quickstart/eks-blueprints

    Interface OpenTelemetryCollector

    interface OpenTelemetryCollector {
        manifestParameterMap?: Values;
        manifestPath: string;
    }

    Properties

    manifestParameterMap? manifestPath

    Properties

    OptionalmanifestParameterMap

    manifestParameterMap?: Values

    This parameter is optional and holds an object of type Values, with keys and values. The same key literals will need to be used within the manifest between double curly braces {{}} and the add-on will replace them with the related values. The following keys are already in use by the add-on and will be replaced in your manifest with configured values, if you want to use them: remoteWriteEndpoint, awsRegion, deploymentMode, namespace, clusterName. To use any of those you can just include e.g. {{remoteWriteEndpoint}} inside the manifest.

    -

    manifestPath

    manifestPath: string

    An alternative OpenTelemetryCollector if you need further cusomisation. +

    manifestPath

    manifestPath: string

    An alternative OpenTelemetryCollector if you need further cusomisation. If not provided, the default will be used.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.PrometheusNodeExporterAddOnProps.html b/api/interfaces/addons.PrometheusNodeExporterAddOnProps.html index 1fedff487..af6505f5d 100644 --- a/api/interfaces/addons.PrometheusNodeExporterAddOnProps.html +++ b/api/interfaces/addons.PrometheusNodeExporterAddOnProps.html @@ -1,5 +1,5 @@ PrometheusNodeExporterAddOnProps | @aws-quickstart/eks-blueprints

    Interface PrometheusNodeExporterAddOnProps

    User provided option for the Helm Chart

    -
    interface PrometheusNodeExporterAddOnProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface PrometheusNodeExporterAddOnProps {
        chart?: string;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? createNamespace? dependencyMode? name? @@ -10,8 +10,8 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -19,12 +19,12 @@

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.SecretProvider.html b/api/interfaces/addons.SecretProvider.html index e188611e0..73eada35c 100644 --- a/api/interfaces/addons.SecretProvider.html +++ b/api/interfaces/addons.SecretProvider.html @@ -1,4 +1,4 @@ SecretProvider | @aws-quickstart/eks-blueprints

    Interface SecretProvider

    Secret Provider Interface You can provide() your own Secrets

    -
    interface SecretProvider {
        provide(clusterInfo?: ClusterInfo): ISecret | IStringParameter;
    }

    Implemented by

    Methods

    provide -

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Methods
    \ No newline at end of file +
    interface SecretProvider {
        provide(clusterInfo?: ClusterInfo): ISecret | IStringParameter;
    }

    Implemented by

    Methods

    provide +

    Methods

    provide

    Settings

    Member Visibility

    On This Page

    Methods
    \ No newline at end of file diff --git a/api/interfaces/addons.SecretsStoreAddOnProps.html b/api/interfaces/addons.SecretsStoreAddOnProps.html index f01aaf197..3801e164b 100644 --- a/api/interfaces/addons.SecretsStoreAddOnProps.html +++ b/api/interfaces/addons.SecretsStoreAddOnProps.html @@ -1,5 +1,5 @@ SecretsStoreAddOnProps | @aws-quickstart/eks-blueprints

    Interface SecretsStoreAddOnProps

    Configuration options for Secrets Store AddOn

    -
    interface SecretsStoreAddOnProps {
        ascpUrl?: string;
        chart?: string;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        rotationPollInterval?: string;
        skipVersionValidation?: boolean;
        syncSecrets?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    ascpUrl? +
    interface SecretsStoreAddOnProps {
        ascpUrl?: string;
        chart?: string;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        rotationPollInterval?: string;
        skipVersionValidation?: boolean;
        syncSecrets?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    ascpUrl? chart? dependencyMode? name? @@ -12,8 +12,8 @@ values? version?

    Properties

    Optional ReadonlyascpUrl

    ascpUrl?: string

    ASCP secret and configuration provider URL for provisioning.

    -

    Optionalchart

    chart?: string

    Chart name

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    Optionalchart

    chart?: string

    Chart name

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -21,23 +21,23 @@

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optional Readonlynamespace

    namespace?: string

    Namespace where Secrets Store CSI driver will be installed

    +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optional Readonlynamespace

    namespace?: string

    Namespace where Secrets Store CSI driver will be installed

    Default

    'kube-system'
    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    Optional ReadonlyrotationPollInterval

    rotationPollInterval?: string

    Rotation Poll Interval, e.g. '120s'.

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    Optional ReadonlyrotationPollInterval

    rotationPollInterval?: string

    Rotation Poll Interval, e.g. '120s'.

    Default

    undefined
    If provided, sets auto rotation to true and sets the polling interval.
    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optional ReadonlysyncSecrets

    syncSecrets?: boolean

    Enable Sync Secrets to kubernetes secrets

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optional Readonlyversion

    version?: string

    Version of the Secrets Store CSI Driver. Eg. v0.0.23

    +

    Optional ReadonlysyncSecrets

    syncSecrets?: boolean

    Enable Sync Secrets to kubernetes secrets

    +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optional Readonlyversion

    version?: string

    Version of the Secrets Store CSI Driver. Eg. v0.0.23

    Default

    'v0.0.23/'
    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.UpboundCrossplaneAddOnProps.html b/api/interfaces/addons.UpboundCrossplaneAddOnProps.html index 3dfc2edc9..5ab2efced 100644 --- a/api/interfaces/addons.UpboundCrossplaneAddOnProps.html +++ b/api/interfaces/addons.UpboundCrossplaneAddOnProps.html @@ -1,5 +1,5 @@ UpboundCrossplaneAddOnProps | @aws-quickstart/eks-blueprints

    Interface UpboundCrossplaneAddOnProps

    User provided options for the Helm Chart.

    -
    interface UpboundCrossplaneAddOnProps {
        chart?: string;
        clusterAccessRole: IRole;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface UpboundCrossplaneAddOnProps {
        chart?: string;
        clusterAccessRole: IRole;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? clusterAccessRole createNamespace? dependencyMode? @@ -11,8 +11,8 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    clusterAccessRole

    clusterAccessRole: IRole

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    -

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    clusterAccessRole

    clusterAccessRole: IRole

    OptionalcreateNamespace

    createNamespace?: boolean

    To Create Namespace using CDK

    +

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -20,12 +20,12 @@

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.VeleroAddOnProps.html b/api/interfaces/addons.VeleroAddOnProps.html index 436290b0e..6069408ef 100644 --- a/api/interfaces/addons.VeleroAddOnProps.html +++ b/api/interfaces/addons.VeleroAddOnProps.html @@ -1,5 +1,5 @@ VeleroAddOnProps | @aws-quickstart/eks-blueprints

    Interface VeleroAddOnProps

    Configuration options for the add-on.

    -
    interface VeleroAddOnProps {
        chart?: string;
        createNamespace: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? +
    interface VeleroAddOnProps {
        chart?: string;
        createNamespace: boolean;
        dependencyMode?: boolean;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    chart? createNamespace dependencyMode? name? @@ -10,7 +10,7 @@ values? version?

    Properties

    Optionalchart

    chart?: string

    Chart name

    -

    createNamespace

    createNamespace: boolean

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). +

    createNamespace

    createNamespace: boolean

    OptionaldependencyMode

    dependencyMode?: boolean

    Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. @@ -18,12 +18,12 @@

    Default

    true
    -

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    -

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    -

    Optionalrelease

    release?: string

    Helm release

    -

    Optionalrepository

    repository?: string

    Helm repository

    -

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true +

    Optionalname

    name?: string

    Name of the helm chart (add-on)

    +

    Optionalnamespace

    namespace?: string

    Namespace where helm release will be installed

    +

    Optionalrelease

    release?: string

    Helm release

    +

    Optionalrepository

    repository?: string

    Helm repository

    +

    OptionalskipVersionValidation

    skipVersionValidation?: boolean

    When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

    -

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    -

    Optionalversion

    version?: string

    Helm chart version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionalvalues

    values?: Values

    Optional values for the helm chart.

    +

    Optionalversion

    version?: string

    Helm chart version.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.VpcCniAddOnProps.html b/api/interfaces/addons.VpcCniAddOnProps.html index 17055e0bf..c4902b0e0 100644 --- a/api/interfaces/addons.VpcCniAddOnProps.html +++ b/api/interfaces/addons.VpcCniAddOnProps.html @@ -1,5 +1,5 @@ VpcCniAddOnProps | @aws-quickstart/eks-blueprints

    Interface VpcCniAddOnProps

    User provided option for the Helm Chart

    -
    interface VpcCniAddOnProps {
        additionalEniTags?: string;
        annotatePodIp?: boolean;
        awsEc2Endpoint?: string;
        awsExternalServiceCidrs?: string;
        awsManageEnisNonSchedulable?: boolean;
        awsVpcCniNodePortSupport?: boolean;
        awsVpcEniMtu?: number;
        awsVpcK8sCniCustomNetworkCfg?: boolean;
        awsVpcK8sCniExternalSnat?: boolean;
        awsVpcK8sCniLogFile?: string;
        awsVpcK8sCniLogLevel?: string;
        awsVpcK8sCniRandomizeSnat?: string;
        awsVpcK8sCniVethPrefix?: string;
        awsVpcK8sExcludeSnatCidrs?: string;
        awsVpcK8sPluginLogFile?: string;
        awsVpcK8sPluginLogLevel?: string;
        clusterEndpoint?: string;
        customNetworkingConfig?: CustomNetworkingConfig;
        disableIntrospection?: boolean;
        disableLeakedEniCleanup?: boolean;
        disableMetrics?: boolean;
        disableTcpEarlyDemux?: boolean;
        disablenetworkResourceProvisioning?: boolean;
        enableBandwidthPlugin?: boolean;
        enableNetworkPolicy?: boolean;
        enableNftables?: boolean;
        enablePodEni?: boolean;
        enablePrefixDelegation?: boolean;
        enableV6Egress?: boolean;
        enableWindowsIpam?: boolean;
        eniConfigAnnotationDef?: string;
        eniConfigLabelDef?: string;
        introspectionBindAddress?: string;
        maxEni?: number;
        minimumIpTarget?: number;
        podSecurityGroupEnforcingMode?: string;
        serviceAccountPolicies?: IManagedPolicy[];
        version?: string;
        warmEniTarget?: number;
        warmIpTarget?: number;
        warmPrefixTarget?: number;
    }

    Properties

    additionalEniTags? +
    interface VpcCniAddOnProps {
        additionalEniTags?: string;
        annotatePodIp?: boolean;
        awsEc2Endpoint?: string;
        awsExternalServiceCidrs?: string;
        awsManageEnisNonSchedulable?: boolean;
        awsVpcCniNodePortSupport?: boolean;
        awsVpcEniMtu?: number;
        awsVpcK8sCniCustomNetworkCfg?: boolean;
        awsVpcK8sCniExternalSnat?: boolean;
        awsVpcK8sCniLogFile?: string;
        awsVpcK8sCniLogLevel?: string;
        awsVpcK8sCniRandomizeSnat?: string;
        awsVpcK8sCniVethPrefix?: string;
        awsVpcK8sExcludeSnatCidrs?: string;
        awsVpcK8sPluginLogFile?: string;
        awsVpcK8sPluginLogLevel?: string;
        clusterEndpoint?: string;
        customNetworkingConfig?: CustomNetworkingConfig;
        disableIntrospection?: boolean;
        disableLeakedEniCleanup?: boolean;
        disableMetrics?: boolean;
        disableTcpEarlyDemux?: boolean;
        disablenetworkResourceProvisioning?: boolean;
        enableBandwidthPlugin?: boolean;
        enableNetworkPolicy?: boolean;
        enableNftables?: boolean;
        enablePodEni?: boolean;
        enablePrefixDelegation?: boolean;
        enableV6Egress?: boolean;
        enableWindowsIpam?: boolean;
        eniConfigAnnotationDef?: string;
        eniConfigLabelDef?: string;
        introspectionBindAddress?: string;
        maxEni?: number;
        minimumIpTarget?: number;
        podSecurityGroupEnforcingMode?: string;
        serviceAccountPolicies?: IManagedPolicy[];
        version?: string;
        warmEniTarget?: number;
        warmIpTarget?: number;
        warmPrefixTarget?: number;
    }

    Properties

    additionalEniTags? annotatePodIp? awsEc2Endpoint? awsExternalServiceCidrs? @@ -43,116 +43,116 @@

    Properties

    OptionaladditionalEniTags

    additionalEniTags?: string

    ADDITIONAL_ENI_TAGS Environment Variable. Type: String. Metadata applied to ENI helps you categorize and organize your resources for billing or other purposes.

    -

    OptionalannotatePodIp

    annotatePodIp?: boolean

    ANNOTATE_POD_IP Environment Variable. Type: Boolean. +

    OptionalannotatePodIp

    annotatePodIp?: boolean

    ANNOTATE_POD_IP Environment Variable. Type: Boolean. Setting ANNOTATE_POD_IP to true will allow IPAMD to add an annotation vpc.amazonaws.com/pod-ips to the pod with pod IP.

    -

    OptionalawsEc2Endpoint

    awsEc2Endpoint?: string

    AWS_EC2_ENDPOINT Environment Variable. Type: string. +

    OptionalawsEc2Endpoint

    awsEc2Endpoint?: string

    AWS_EC2_ENDPOINT Environment Variable. Type: string. Specifies the EC2 endpoint to use. This is useful if you are using a custom endpoint for EC2.

    -

    OptionalawsExternalServiceCidrs

    awsExternalServiceCidrs?: string

    AWS_EXTERNAL_SERVICE_CIDRS Environment Variable. Type: string. +

    OptionalawsExternalServiceCidrs

    awsExternalServiceCidrs?: string

    AWS_EXTERNAL_SERVICE_CIDRS Environment Variable. Type: string. Specify a comma-separated list of IPv4 CIDRs that must be routed via main routing table. This is required for secondary ENIs to reach endpoints outside of VPC that are backed by a service.

    -

    OptionalawsManageEnisNonSchedulable

    awsManageEnisNonSchedulable?: boolean

    AWS_MANAGE_ENIS_NON_SCHEDULABLE Environment Variable. Type: Boolean. +

    OptionalawsManageEnisNonSchedulable

    awsManageEnisNonSchedulable?: boolean

    AWS_MANAGE_ENIS_NON_SCHEDULABLE Environment Variable. Type: Boolean. Specifies whether IPAMD should allocate or deallocate ENIs on a non-schedulable node.

    -

    OptionalawsVpcCniNodePortSupport

    awsVpcCniNodePortSupport?: boolean

    AWS_VPC_CNI_NODE_PORT_SUPPORT Environment Variable. Type: Boolean. +

    OptionalawsVpcCniNodePortSupport

    awsVpcCniNodePortSupport?: boolean

    AWS_VPC_CNI_NODE_PORT_SUPPORT Environment Variable. Type: Boolean. Specifies whether NodePort services are enabled on a worker node's primary network interface.

    -

    OptionalawsVpcEniMtu

    awsVpcEniMtu?: number

    AWS_VPC_ENI_MTU Environment Variable. Type: Integer. +

    OptionalawsVpcEniMtu

    awsVpcEniMtu?: number

    AWS_VPC_ENI_MTU Environment Variable. Type: Integer. Used to configure the MTU size for attached ENIs. The valid range is from 576 to 9001.

    -

    OptionalawsVpcK8sCniCustomNetworkCfg

    awsVpcK8sCniCustomNetworkCfg?: boolean

    AWS_VPC_K8S_CNI_CUSTOM_NETWORK_CFG Environment Variable. Type: Boolean. +

    OptionalawsVpcK8sCniCustomNetworkCfg

    awsVpcK8sCniCustomNetworkCfg?: boolean

    AWS_VPC_K8S_CNI_CUSTOM_NETWORK_CFG Environment Variable. Type: Boolean. Specifies that your pods may use subnets and security groups that are independent of your worker node's VPC configuration.

    -

    OptionalawsVpcK8sCniExternalSnat

    awsVpcK8sCniExternalSnat?: boolean

    AWS_VPC_K8S_CNI_EXTERNALSNAT Environment Variable. Type: Boolean. +

    OptionalawsVpcK8sCniExternalSnat

    awsVpcK8sCniExternalSnat?: boolean

    AWS_VPC_K8S_CNI_EXTERNALSNAT Environment Variable. Type: Boolean. Specifies whether an external NAT gateway should be used to provide SNAT of secondary ENI IP addresses.

    -

    OptionalawsVpcK8sCniLogFile

    awsVpcK8sCniLogFile?: string

    AWS_VPC_K8S_CNI_LOG_FILE Environment Variable. Type: String. +

    OptionalawsVpcK8sCniLogFile

    awsVpcK8sCniLogFile?: string

    AWS_VPC_K8S_CNI_LOG_FILE Environment Variable. Type: String. Specifies where to write the logging output of ipamd. Either to stdout or to override the default file (i.e., /var/log/aws-routed-eni/ipamd.log).

    -

    OptionalawsVpcK8sCniLogLevel

    awsVpcK8sCniLogLevel?: string

    AWS_VPC_K8S_CNI_LOGLEVEL Environment Variable. Type: String. +

    OptionalawsVpcK8sCniLogLevel

    awsVpcK8sCniLogLevel?: string

    AWS_VPC_K8S_CNI_LOGLEVEL Environment Variable. Type: String. Specifies the loglevel for ipamd and cni-metric-helper.

    -

    OptionalawsVpcK8sCniRandomizeSnat

    awsVpcK8sCniRandomizeSnat?: string

    AWS_VPC_K8S_CNI_RANDOMIZESNAT Environment Variable. Type: String. +

    OptionalawsVpcK8sCniRandomizeSnat

    awsVpcK8sCniRandomizeSnat?: string

    AWS_VPC_K8S_CNI_RANDOMIZESNAT Environment Variable. Type: String. Specifies whether the SNAT iptables rule should randomize the outgoing ports for connections.

    -

    OptionalawsVpcK8sCniVethPrefix

    awsVpcK8sCniVethPrefix?: string

    AWS_VPC_K8S_CNI_VETHPREFIX Environment Variable. Type: String. +

    OptionalawsVpcK8sCniVethPrefix

    awsVpcK8sCniVethPrefix?: string

    AWS_VPC_K8S_CNI_VETHPREFIX Environment Variable. Type: String. Specifies the veth prefix used to generate the host-side veth device name for the CNI.

    -

    OptionalawsVpcK8sExcludeSnatCidrs

    awsVpcK8sExcludeSnatCidrs?: string

    AWS_VPC_K8S_CNI_EXCLUDE_SNAT_CIDRS Environment Variable. Type: String. +

    OptionalawsVpcK8sExcludeSnatCidrs

    awsVpcK8sExcludeSnatCidrs?: string

    AWS_VPC_K8S_CNI_EXCLUDE_SNAT_CIDRS Environment Variable. Type: String. Specify a comma-separated list of IPv4 CIDRs to exclude from SNAT.

    -

    OptionalawsVpcK8sPluginLogFile

    awsVpcK8sPluginLogFile?: string

    AWS_VPC_K8S_PLUGIN_LOG_FILE Environment Variable. Type: String. +

    OptionalawsVpcK8sPluginLogFile

    awsVpcK8sPluginLogFile?: string

    AWS_VPC_K8S_PLUGIN_LOG_FILE Environment Variable. Type: String. Specifies where to write the logging output for aws-cni plugin.

    -

    OptionalawsVpcK8sPluginLogLevel

    awsVpcK8sPluginLogLevel?: string

    AWS_VPC_K8S_PLUGIN_LOG_LEVEL Environment Variable. Type: String. +

    OptionalawsVpcK8sPluginLogLevel

    awsVpcK8sPluginLogLevel?: string

    AWS_VPC_K8S_PLUGIN_LOG_LEVEL Environment Variable. Type: String. Specifies the loglevel for aws-cni plugin.

    -

    OptionalclusterEndpoint

    clusterEndpoint?: string

    CLUSTER_ENDPOINT Environment Variable. Type: String. +

    OptionalclusterEndpoint

    clusterEndpoint?: string

    CLUSTER_ENDPOINT Environment Variable. Type: String. Specifies the cluster endpoint to use for connecting to the api-server without relying on kube-proxy.

    -

    OptionalcustomNetworkingConfig

    customNetworkingConfig?: CustomNetworkingConfig

    CustomNetworkingConfig holding Secondary Subnet IDs for creating ENIConfig

    -

    OptionaldisableIntrospection

    disableIntrospection?: boolean

    DISABLE_INTROSPECTION Environment Variable. Type: Boolean.

    -

    OptionaldisableLeakedEniCleanup

    disableLeakedEniCleanup?: boolean

    DISABLE_LEAKED_ENI_CLEANUP Environment Variable. Type: Boolean.

    -

    OptionaldisableMetrics

    disableMetrics?: boolean

    DISABLE_METRICS Environment Variable. Type: Boolean. +

    OptionalcustomNetworkingConfig

    customNetworkingConfig?: CustomNetworkingConfig

    CustomNetworkingConfig holding Secondary Subnet IDs for creating ENIConfig

    +

    OptionaldisableIntrospection

    disableIntrospection?: boolean

    DISABLE_INTROSPECTION Environment Variable. Type: Boolean.

    +

    OptionaldisableLeakedEniCleanup

    disableLeakedEniCleanup?: boolean

    DISABLE_LEAKED_ENI_CLEANUP Environment Variable. Type: Boolean.

    +

    OptionaldisableMetrics

    disableMetrics?: boolean

    DISABLE_METRICS Environment Variable. Type: Boolean. Specifies whether the prometheus metrics endpoint is disabled or not for ipamd. By default metrics are published on :61678/metrics.

    -

    OptionaldisableTcpEarlyDemux

    disableTcpEarlyDemux?: boolean

    DISABLE_TCP_EARLY_DEMUX Environment Variable. Type: Boolean. +

    OptionaldisableTcpEarlyDemux

    disableTcpEarlyDemux?: boolean

    DISABLE_TCP_EARLY_DEMUX Environment Variable. Type: Boolean. If ENABLE_POD_ENI is set to true, for the kubelet to connect via TCP to pods that are using per pod security groups, DISABLE_TCP_EARLY_DEMUX should be set to true for amazon-k8s-cni-init the container under initcontainers.

    -

    OptionaldisablenetworkResourceProvisioning

    disablenetworkResourceProvisioning?: boolean

    DISABLE_NETWORK_RESOURCE_PROVISIONING Environment Variable. Type: Boolean. +

    OptionaldisablenetworkResourceProvisioning

    disablenetworkResourceProvisioning?: boolean

    DISABLE_NETWORK_RESOURCE_PROVISIONING Environment Variable. Type: Boolean. Setting DISABLE_NETWORK_RESOURCE_PROVISIONING to true will make IPAMD depend only on IMDS to get attached ENIs and IPs/prefixes.

    -

    OptionalenableBandwidthPlugin

    enableBandwidthPlugin?: boolean

    ENABLE_BANDWIDTH_PLUGIN Environment Variable. Type: Boolean. +

    OptionalenableBandwidthPlugin

    enableBandwidthPlugin?: boolean

    ENABLE_BANDWIDTH_PLUGIN Environment Variable. Type: Boolean. Setting ENABLE_BANDWIDTH_PLUGIN to true will update 10-aws.conflist to include upstream bandwidth plugin as a chained plugin.

    -

    OptionalenableNetworkPolicy

    enableNetworkPolicy?: boolean

    Enable kubernetes network policy in the VPC CNI introduced in vpc-cni 1.14 +

    OptionalenableNetworkPolicy

    enableNetworkPolicy?: boolean

    Enable kubernetes network policy in the VPC CNI introduced in vpc-cni 1.14 More informaton on official AWS documentation: https://docs.aws.amazon.com/eks/latest/userguide/cni-network-policy.html

    -

    OptionalenableNftables

    enableNftables?: boolean

    ENABLE_NFTABLES Environment Variable. Type: Boolean. +

    OptionalenableNftables

    enableNftables?: boolean

    ENABLE_NFTABLES Environment Variable. Type: Boolean. VPC CNI uses iptables-legacy by default. Setting ENABLE_NFTABLES to true will update VPC CNI to use iptables-nft

    -

    OptionalenablePodEni

    enablePodEni?: boolean

    ENABLE_POD_ENI Environment Variable. Type: Boolean. +

    OptionalenablePodEni

    enablePodEni?: boolean

    ENABLE_POD_ENI Environment Variable. Type: Boolean. Setting ENABLE_POD_ENI to true will allow IPAMD to add the vpc.amazonaws.com/has-trunk-attached label to the node if the instance has the capacity to attach an additional ENI.

    -

    OptionalenablePrefixDelegation

    enablePrefixDelegation?: boolean

    ENABLE_PREFIX_DELEGATION Environment Variable. Type: Boolean. +

    OptionalenablePrefixDelegation

    enablePrefixDelegation?: boolean

    ENABLE_PREFIX_DELEGATION Environment Variable. Type: Boolean. To enable prefix delegation on nitro instances. Setting ENABLE_PREFIX_DELEGATION to true will start allocating a prefix (/28 for IPv4 and /80 for IPv6) instead of a secondary IP in the ENIs subnet.

    -

    OptionalenableV6Egress

    enableV6Egress?: boolean

    ENABLE_V6_EGRESS Environment Variable. Type: Boolean. +

    OptionalenableV6Egress

    enableV6Egress?: boolean

    ENABLE_V6_EGRESS Environment Variable. Type: Boolean. Specifies whether PODs in an IPv4 cluster support IPv6 egress. If env is set to true, range fd00::ac:00/118 is reserved for IPv6 egress.

    -

    OptionalenableWindowsIpam

    enableWindowsIpam?: boolean

    Enable windows support for your cluster

    -

    OptionaleniConfigAnnotationDef

    eniConfigAnnotationDef?: string

    ENI_CONFIG_ANNOTATION_DEF Environment Variable. Type: String. +

    OptionalenableWindowsIpam

    enableWindowsIpam?: boolean

    Enable windows support for your cluster

    +

    OptionaleniConfigAnnotationDef

    eniConfigAnnotationDef?: string

    ENI_CONFIG_ANNOTATION_DEF Environment Variable. Type: String. Specifies node annotation key name. This should be used when AWS_VPC_K8S_CNI_CUSTOM_NETWORK_CFG=true

    -

    OptionaleniConfigLabelDef

    eniConfigLabelDef?: string

    ENI_CONFIG_LABEL_DEF Environment Variable. Type: String. +

    OptionaleniConfigLabelDef

    eniConfigLabelDef?: string

    ENI_CONFIG_LABEL_DEF Environment Variable. Type: String. Specifies node label key name. This should be used when AWS_VPC_K8S_CNI_CUSTOM_NETWORK_CFG=true.

    -

    OptionalintrospectionBindAddress

    introspectionBindAddress?: string

    INTROSPECTION_BIND_ADDRESS Environment Variable. Type: String. +

    OptionalintrospectionBindAddress

    introspectionBindAddress?: string

    INTROSPECTION_BIND_ADDRESS Environment Variable. Type: String. Specifies the bind address for the introspection endpoint.

    -

    OptionalmaxEni

    maxEni?: number

    MAX_ENI Environment Variable. Format integer. +

    OptionalmaxEni

    maxEni?: number

    MAX_ENI Environment Variable. Format integer. Specifies the maximum number of ENIs that will be attached to the node.

    -

    OptionalminimumIpTarget

    minimumIpTarget?: number

    MINIMUM_IP_TARGET Environment Variable. Format integer. +

    OptionalminimumIpTarget

    minimumIpTarget?: number

    MINIMUM_IP_TARGET Environment Variable. Format integer. Specifies the number of total IP addresses that the ipamd daemon should attempt to allocate for pod assignment on the node.

    -

    OptionalpodSecurityGroupEnforcingMode

    podSecurityGroupEnforcingMode?: string

    POD_SECURITY_GROUP_ENFORCING_MODE Environment Variable. Type: String. +

    OptionalpodSecurityGroupEnforcingMode

    podSecurityGroupEnforcingMode?: string

    POD_SECURITY_GROUP_ENFORCING_MODE Environment Variable. Type: String. Once ENABLE_POD_ENI is set to true, this value controls how the traffic of pods with the security group behaves.

    -

    OptionalserviceAccountPolicies

    serviceAccountPolicies?: IManagedPolicy[]

    If specified, an IRSA account will be created for the VPC-CNI add-on with the IRSA role +

    OptionalserviceAccountPolicies

    serviceAccountPolicies?: IManagedPolicy[]

    If specified, an IRSA account will be created for the VPC-CNI add-on with the IRSA role having the specified managed policies. When specified, the node role for the cluster provider can be configured without the CNI policy.

    For IPv4 the required managed policy is AmazonEKS_CNI_Policy.

    Example

    serviceAccountPolicies: [ManagedPolicy.fromAwsManagedPolicyName("AmazonEKS_CNI_Policy")]
    -

    Optionalversion

    version?: string

    Version of the add-on to use. Must match the version of the cluster where it +

    Optionalversion

    version?: string

    Version of the add-on to use. Must match the version of the cluster where it will be deployed.

    -

    OptionalwarmEniTarget

    warmEniTarget?: number

    WARM_ENI_TARGET Environment Variable. Format integer. +

    OptionalwarmEniTarget

    warmEniTarget?: number

    WARM_ENI_TARGET Environment Variable. Format integer. Specifies the number of free elastic network interfaces (and all of their available IP addresses) that the ipamd daemon should attempt to keep available for pod assignment on the node.

    -

    OptionalwarmIpTarget

    warmIpTarget?: number

    WARM_IP_TARGET Environment Variable. Format integer. +

    OptionalwarmIpTarget

    warmIpTarget?: number

    WARM_IP_TARGET Environment Variable. Format integer. Specifies the number of free IP addresses that the ipamd daemon should attempt to keep available for pod assignment on the node.

    -

    OptionalwarmPrefixTarget

    warmPrefixTarget?: number

    WARM_PREFIX_TARGET Environment Variable. Format integer. +

    OptionalwarmPrefixTarget

    warmPrefixTarget?: number

    WARM_PREFIX_TARGET Environment Variable. Format integer. Specifies the number of free IPv4(/28) prefixes that the ipamd daemon should attempt to keep available for pod assignment on the node.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/addons.XrayAdotAddOnProps.html b/api/interfaces/addons.XrayAdotAddOnProps.html index 4bff9ee03..4d35a2791 100644 --- a/api/interfaces/addons.XrayAdotAddOnProps.html +++ b/api/interfaces/addons.XrayAdotAddOnProps.html @@ -1,17 +1,17 @@ XrayAdotAddOnProps | @aws-quickstart/eks-blueprints

    Interface XrayAdotAddOnProps

    Configuration options for add-on.

    -
    interface XrayAdotAddOnProps {
        deploymentMode?: xrayDeploymentMode;
        name?: string;
        namespace?: string;
    }

    Properties

    deploymentMode? +
    interface XrayAdotAddOnProps {
        deploymentMode?: xrayDeploymentMode;
        name?: string;
        namespace?: string;
    }

    Properties

    deploymentMode? name? namespace?

    Properties

    OptionaldeploymentMode

    deploymentMode?: xrayDeploymentMode

    Modes supported : deployment, daemonset, statefulSet, and sidecar

    Default

    deployment
    -

    Optionalname

    name?: string

    Name for deployment of the ADOT Collector for XRay.

    +

    Optionalname

    name?: string

    Name for deployment of the ADOT Collector for XRay.

    Default

    'adot-collector-xray'
    -

    Optionalnamespace

    namespace?: string

    Namespace to deploy the ADOT Collector for XRay.

    +

    Optionalnamespace

    namespace?: string

    Namespace to deploy the ADOT Collector for XRay.

    Default

    default
    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/builders.GpuOptions.html b/api/interfaces/builders.GpuOptions.html index 51d14d660..0a7188546 100644 --- a/api/interfaces/builders.GpuOptions.html +++ b/api/interfaces/builders.GpuOptions.html @@ -1,5 +1,5 @@ GpuOptions | @aws-quickstart/eks-blueprints

    Interface GpuOptions

    Configuration options for GPU Builder.

    -
    interface GpuOptions {
        blockDeviceSize?: number;
        clusterProviderTags?: {
            [key: string]: string;
        };
        desiredNodeSize?: number;
        instanceClass: InstanceClass;
        instanceSize: InstanceSize;
        kubernetesVersion: KubernetesVersion;
        maxNodeSize?: number;
        minNodeSize?: number;
        nodeGroupTags?: {
            [key: string]: string;
        };
    }

    Properties

    blockDeviceSize? +
    interface GpuOptions {
        blockDeviceSize?: number;
        clusterProviderTags?: {
            [key: string]: string;
        };
        desiredNodeSize?: number;
        instanceClass: InstanceClass;
        instanceSize: InstanceSize;
        kubernetesVersion: KubernetesVersion;
        maxNodeSize?: number;
        minNodeSize?: number;
        nodeGroupTags?: {
            [key: string]: string;
        };
    }

    Properties

    blockDeviceSize? clusterProviderTags? desiredNodeSize? instanceClass @@ -9,13 +9,13 @@ minNodeSize? nodeGroupTags?

    Properties

    OptionalblockDeviceSize

    blockDeviceSize?: number

    Optional, Block device size.

    -

    OptionalclusterProviderTags

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

    Optional, Cluster Provider Tags.

    -

    OptionaldesiredNodeSize

    desiredNodeSize?: number

    Optional, Desired number of nodes to use for the cluster.

    -

    instanceClass

    instanceClass: InstanceClass

    Required, Instance class to use for the cluster.

    -

    instanceSize

    instanceSize: InstanceSize

    Required, Instance size to use for the cluster.

    -

    kubernetesVersion

    kubernetesVersion: KubernetesVersion

    Required, Kubernetes version to use for the cluster.

    -

    OptionalmaxNodeSize

    maxNodeSize?: number

    Optional, Maximum number of nodes to use for the cluster.

    -

    OptionalminNodeSize

    minNodeSize?: number

    Optional, Minimum number of nodes to use for the cluster.

    -

    OptionalnodeGroupTags

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

    Optional, Node Group Tags for AL2 nodes +

    OptionalclusterProviderTags

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

    Optional, Cluster Provider Tags.

    +

    OptionaldesiredNodeSize

    desiredNodeSize?: number

    Optional, Desired number of nodes to use for the cluster.

    +

    instanceClass

    instanceClass: InstanceClass

    Required, Instance class to use for the cluster.

    +

    instanceSize

    instanceSize: InstanceSize

    Required, Instance size to use for the cluster.

    +

    kubernetesVersion

    kubernetesVersion: KubernetesVersion

    Required, Kubernetes version to use for the cluster.

    +

    OptionalmaxNodeSize

    maxNodeSize?: number

    Optional, Maximum number of nodes to use for the cluster.

    +

    OptionalminNodeSize

    minNodeSize?: number

    Optional, Minimum number of nodes to use for the cluster.

    +

    OptionalnodeGroupTags

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

    Optional, Node Group Tags for AL2 nodes which run standard cluster software.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/builders.WindowsOptions.html b/api/interfaces/builders.WindowsOptions.html index 7f1c69866..e1654649d 100644 --- a/api/interfaces/builders.WindowsOptions.html +++ b/api/interfaces/builders.WindowsOptions.html @@ -1,5 +1,5 @@ WindowsOptions | @aws-quickstart/eks-blueprints

    Interface WindowsOptions

    Configuration options for Windows Builder.

    -
    interface WindowsOptions {
        blockDeviceSize?: number;
        clusterProviderTags?: {
            [key: string]: string;
        };
        desiredNodeCount?: number;
        genericNodeGroupOptions: NodegroupOptions;
        instanceClass: InstanceClass;
        instanceSize: InstanceSize;
        kubernetesVersion: KubernetesVersion;
        maxNodeSize?: number;
        minNodeSize?: number;
        noScheduleForWindowsNodes?: boolean;
        nodeRole?: Role;
        windowsAmiType?: NodegroupAmiType;
        windowsNodeGroupOptions: NodegroupOptions;
    }

    Properties

    blockDeviceSize? +
    interface WindowsOptions {
        blockDeviceSize?: number;
        clusterProviderTags?: {
            [key: string]: string;
        };
        desiredNodeCount?: number;
        genericNodeGroupOptions: NodegroupOptions;
        instanceClass: InstanceClass;
        instanceSize: InstanceSize;
        kubernetesVersion: KubernetesVersion;
        maxNodeSize?: number;
        minNodeSize?: number;
        noScheduleForWindowsNodes?: boolean;
        nodeRole?: Role;
        windowsAmiType?: NodegroupAmiType;
        windowsNodeGroupOptions: NodegroupOptions;
    }

    Properties

    blockDeviceSize? clusterProviderTags? desiredNodeCount? genericNodeGroupOptions @@ -13,17 +13,17 @@ windowsAmiType? windowsNodeGroupOptions

    Properties

    OptionalblockDeviceSize

    blockDeviceSize?: number

    Optional, Block device size.

    -

    OptionalclusterProviderTags

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

    Optional, Cluster Provider Tags.

    -

    OptionaldesiredNodeCount

    desiredNodeCount?: number

    Optional, Desired number of nodes to use for the cluster.

    -

    genericNodeGroupOptions

    genericNodeGroupOptions: NodegroupOptions

    instanceClass

    instanceClass: InstanceClass

    Required, Instance class to use for the cluster.

    -

    instanceSize

    instanceSize: InstanceSize

    Required, Instance size to use for the cluster.

    -

    kubernetesVersion

    kubernetesVersion: KubernetesVersion

    Required, Kubernetes version to use for the cluster.

    -

    OptionalmaxNodeSize

    maxNodeSize?: number

    Optional, Maximum number of nodes to use for the cluster.

    -

    OptionalminNodeSize

    minNodeSize?: number

    Optional, Minimum number of nodes to use for the cluster.

    -

    OptionalnoScheduleForWindowsNodes

    noScheduleForWindowsNodes?: boolean

    Optional, No Schedule for Windows Nodes, this allows Windows +

    OptionalclusterProviderTags

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

    Optional, Cluster Provider Tags.

    +

    OptionaldesiredNodeCount

    desiredNodeCount?: number

    Optional, Desired number of nodes to use for the cluster.

    +

    genericNodeGroupOptions

    genericNodeGroupOptions: NodegroupOptions

    instanceClass

    instanceClass: InstanceClass

    Required, Instance class to use for the cluster.

    +

    instanceSize

    instanceSize: InstanceSize

    Required, Instance size to use for the cluster.

    +

    kubernetesVersion

    kubernetesVersion: KubernetesVersion

    Required, Kubernetes version to use for the cluster.

    +

    OptionalmaxNodeSize

    maxNodeSize?: number

    Optional, Maximum number of nodes to use for the cluster.

    +

    OptionalminNodeSize

    minNodeSize?: number

    Optional, Minimum number of nodes to use for the cluster.

    +

    OptionalnoScheduleForWindowsNodes

    noScheduleForWindowsNodes?: boolean

    Optional, No Schedule for Windows Nodes, this allows Windows nodes to be marked as no-schedule by default to prevent any linux workloads from scheduling.

    -

    OptionalnodeRole

    nodeRole?: Role

    optional, Node IAM Role to be attached to Windows +

    OptionalnodeRole

    nodeRole?: Role

    optional, Node IAM Role to be attached to Windows and Non-windows nodes.

    -

    OptionalwindowsAmiType

    windowsAmiType?: NodegroupAmiType

    Optional, AMI Type for Windows Nodes

    -

    windowsNodeGroupOptions

    windowsNodeGroupOptions: NodegroupOptions

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    OptionalwindowsAmiType

    windowsAmiType?: NodegroupAmiType

    Optional, AMI Type for Windows Nodes

    +

    windowsNodeGroupOptions

    windowsNodeGroupOptions: NodegroupOptions

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/clusters.AsgClusterProviderProps.html b/api/interfaces/clusters.AsgClusterProviderProps.html index 462d1cf88..c96bfbb66 100644 --- a/api/interfaces/clusters.AsgClusterProviderProps.html +++ b/api/interfaces/clusters.AsgClusterProviderProps.html @@ -1,5 +1,5 @@ AsgClusterProviderProps | @aws-quickstart/eks-blueprints

    Interface AsgClusterProviderProps

    Configuration options for the cluster provider.

    -
    interface AsgClusterProviderProps {
        allowAllOutbound?: boolean;
        associatePublicIpAddress?: boolean;
        autoScalingGroupName?: string;
        blockDevices?: BlockDevice[];
        bootstrapEnabled?: boolean;
        bootstrapOptions?: BootstrapOptions;
        capacityRebalance?: boolean;
        clusterName?: string;
        cooldown?: Duration;
        defaultInstanceWarmup?: Duration;
        desiredSize?: number;
        groupMetrics?: GroupMetrics[];
        healthCheck?: HealthCheck;
        id: string;
        ignoreUnmodifiedSizeProperties?: boolean;
        instanceMonitoring?: Monitoring;
        instanceType?: InstanceType;
        keyName?: string;
        keyPair?: IKeyPair;
        machineImageType?: MachineImageType;
        mapRole?: boolean;
        maxInstanceLifetime?: Duration;
        maxSize?: number;
        minSize?: number;
        name?: string;
        newInstancesProtectedFromScaleIn?: boolean;
        nodeGroupSubnets?: SubnetSelection;
        notifications?: NotificationConfiguration[];
        outputClusterName?: boolean;
        outputConfigCommand?: boolean;
        privateCluster?: boolean;
        role?: IRole;
        securityGroup?: ISecurityGroup;
        signals?: Signals;
        spotInterruptHandler?: boolean;
        spotPrice?: string;
        ssmSessionPermissions?: boolean;
        tags?: {
            [key: string]: string;
        };
        terminationPolicies?: TerminationPolicy[];
        terminationPolicyCustomLambdaFunctionArn?: string;
        updatePolicy?: UpdatePolicy;
        version?: KubernetesVersion;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection[];
    }

    Hierarchy (view full)

    Properties

    allowAllOutbound? +
    interface AsgClusterProviderProps {
        allowAllOutbound?: boolean;
        associatePublicIpAddress?: boolean;
        autoScalingGroupName?: string;
        blockDevices?: BlockDevice[];
        bootstrapEnabled?: boolean;
        bootstrapOptions?: BootstrapOptions;
        capacityRebalance?: boolean;
        clusterName?: string;
        cooldown?: Duration;
        defaultInstanceWarmup?: Duration;
        desiredSize?: number;
        groupMetrics?: GroupMetrics[];
        healthCheck?: HealthCheck;
        id: string;
        ignoreUnmodifiedSizeProperties?: boolean;
        instanceMonitoring?: Monitoring;
        instanceType?: InstanceType;
        keyName?: string;
        keyPair?: IKeyPair;
        machineImageType?: MachineImageType;
        mapRole?: boolean;
        maxInstanceLifetime?: Duration;
        maxSize?: number;
        minSize?: number;
        name?: string;
        newInstancesProtectedFromScaleIn?: boolean;
        nodeGroupSubnets?: SubnetSelection;
        notifications?: NotificationConfiguration[];
        outputClusterName?: boolean;
        outputConfigCommand?: boolean;
        privateCluster?: boolean;
        role?: IRole;
        securityGroup?: ISecurityGroup;
        signals?: Signals;
        spotInterruptHandler?: boolean;
        spotPrice?: string;
        ssmSessionPermissions?: boolean;
        tags?: {
            [key: string]: string;
        };
        terminationPolicies?: TerminationPolicy[];
        terminationPolicyCustomLambdaFunctionArn?: string;
        updatePolicy?: UpdatePolicy;
        version?: KubernetesVersion;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection[];
    }

    Hierarchy (view full)

    Properties

    allowAllOutbound? associatePublicIpAddress? autoScalingGroupName? blockDevices? @@ -106,7 +106,7 @@

    Default

    OptionaldesiredSize

    desiredSize?: number

    Desired size, defaults to min size.

    -

    Optional ReadonlygroupMetrics

    groupMetrics?: GroupMetrics[]

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

    Optional ReadonlygroupMetrics

    groupMetrics?: GroupMetrics[]

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

    Default

    - no group metrics will be reported
@@ -117,7 +117,7 @@ 
    Default

    id

    id: string

    Id of this node group. Expected to be unique in cluster scope.

    -

    Optional ReadonlyignoreUnmodifiedSizeProperties

    ignoreUnmodifiedSizeProperties?: boolean

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

    +

    Optional ReadonlyignoreUnmodifiedSizeProperties

    ignoreUnmodifiedSizeProperties?: boolean

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

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

    Default'eks.default.instance-type' in CDK context (e.g. ~/.cdk.json under "context" key))
  • M5.Large
    • -

    Optional ReadonlykeyName

    keyName?: string

    Name of SSH keypair to grant access to instances

    +

    Optional ReadonlykeyName

    keyName?: string

    Name of SSH keypair to grant access to instances

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

    You can either specify keyPair or keyName, not both.

    Default

    - No SSH access will be possible.
@@ -178,12 +178,12 @@ 
    Default
    Default
    3
 
    
 
-

    OptionalminSize

    minSize?: number

    Min size of the node group

    +

    OptionalminSize

    minSize?: number

    Min size of the node group

    Default

    1
    -

    Optionalname

    name?: string

    The name for the cluster.

    -

    Optional ReadonlynewInstancesProtectedFromScaleIn

    newInstancesProtectedFromScaleIn?: boolean

    Whether newly-launched instances are protected from termination by Amazon +

    Optionalname

    name?: string

    The name for the cluster.

    +

    Optional ReadonlynewInstancesProtectedFromScaleIn

    newInstancesProtectedFromScaleIn?: boolean

    Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

    By default, Auto Scaling can terminate an instance at any time after launch when scaling in an Auto Scaling Group, subject to the group's termination @@ -199,7 +199,7 @@

    Default

    Default

    all private subnets
    -

    Optional Readonlynotifications

    notifications?: NotificationConfiguration[]

    Configure autoscaling group to send notifications about fleet changes to an SNS topic(s)

    +

    Optional Readonlynotifications

    notifications?: NotificationConfiguration[]

    Configure autoscaling group to send notifications about fleet changes to an SNS topic(s)

    See

    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations

    Default

    - No fleet change notifications will be sent.
    @@ -219,7 +219,7 @@

    Default

    Default

    false
    -

    Optional Readonlyrole

    role?: IRole

    Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

    +

    Optional Readonlyrole

    role?: IRole

    Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

    Default

    - A role is automatically created for you
    @@ -267,7 +267,7 @@

    Default

    Optionaltags

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

    Tags for the cluster

    -

    Optional ReadonlyterminationPolicies

    terminationPolicies?: TerminationPolicy[]

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

    Optional ReadonlyterminationPolicies

    terminationPolicies?: TerminationPolicy[]

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

    See

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

    Default

    -

    Optional ReadonlykeyName

    keyName?: string

    Name of SSH keypair to grant access to instances

    +

    Optional ReadonlykeyName

    keyName?: string

    Name of SSH keypair to grant access to instances

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

    You can either specify keyPair or keyName, not both.

    Default

    - No SSH access will be possible.
@@ -165,11 +165,11 @@ 
    Default
    Default
    3
 
    
 
-

    OptionalminSize

    minSize?: number

    Min size of the node group

    +

    OptionalminSize

    minSize?: number

    Min size of the node group

    Default

    1
    -

    Optional ReadonlynewInstancesProtectedFromScaleIn

    newInstancesProtectedFromScaleIn?: boolean

    Whether newly-launched instances are protected from termination by Amazon +

    Optional ReadonlynewInstancesProtectedFromScaleIn

    newInstancesProtectedFromScaleIn?: boolean

    Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

    By default, Auto Scaling can terminate an instance at any time after launch when scaling in an Auto Scaling Group, subject to the group's termination @@ -185,7 +185,7 @@

    Default

    Default

    all private subnets
    -

    Optional Readonlynotifications

    notifications?: NotificationConfiguration[]

    Configure autoscaling group to send notifications about fleet changes to an SNS topic(s)

    +

    Optional Readonlynotifications

    notifications?: NotificationConfiguration[]

    Configure autoscaling group to send notifications about fleet changes to an SNS topic(s)

    See

    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations

    Default

    - No fleet change notifications will be sent.
    diff --git a/api/interfaces/clusters.FargateClusterProviderProps.html b/api/interfaces/clusters.FargateClusterProviderProps.html index fb8c24270..58c10100d 100644 --- a/api/interfaces/clusters.FargateClusterProviderProps.html +++ b/api/interfaces/clusters.FargateClusterProviderProps.html @@ -1,5 +1,5 @@ FargateClusterProviderProps | @aws-quickstart/eks-blueprints

    Interface FargateClusterProviderProps

    Configuration options for the cluster provider.

    -
    interface FargateClusterProviderProps {
        clusterName?: string;
        fargateProfiles?: {
            [key: string]: eks.FargateProfileOptions;
        } | Map<string, FargateProfileOptions>;
        name?: string;
        outputClusterName?: boolean;
        outputConfigCommand?: boolean;
        privateCluster?: boolean;
        role?: IRole;
        securityGroup?: ISecurityGroup;
        tags?: {
            [key: string]: string;
        };
        version?: KubernetesVersion;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection[];
    }

    Hierarchy

    • Partial<eks.CommonClusterOptions>
      • FargateClusterProviderProps

    Properties

    clusterName? +
    interface FargateClusterProviderProps {
        clusterName?: string;
        fargateProfiles?: {
            [key: string]: eks.FargateProfileOptions;
        } | Map<string, FargateProfileOptions>;
        name?: string;
        outputClusterName?: boolean;
        outputConfigCommand?: boolean;
        privateCluster?: boolean;
        role?: IRole;
        securityGroup?: ISecurityGroup;
        tags?: {
            [key: string]: string;
        };
        version?: KubernetesVersion;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection[];
    }

    Hierarchy

    • Partial<eks.CommonClusterOptions>
      • FargateClusterProviderProps

    Properties

    clusterName? fargateProfiles? name? outputClusterName? @@ -17,8 +17,8 @@

    OptionalfargateProfiles

    fargateProfiles?: {
        [key: string]: eks.FargateProfileOptions;
    } | Map<string, FargateProfileOptions>

    The Fargate profiles associated with the cluster.

    Note The Map<> form is deprecated and will be removed from a future release.

    -

    Optionalname

    name?: string

    The name for the cluster.

    -

    Optional ReadonlyoutputClusterName

    outputClusterName?: boolean

    Determines whether a CloudFormation output with the name of the cluster +

    Optionalname

    name?: string

    The name for the cluster.

    +

    Optional ReadonlyoutputClusterName

    outputClusterName?: boolean

    Determines whether a CloudFormation output with the name of the cluster will be synthesized.

    Default

    false
    @@ -33,7 +33,7 @@

    Default

    false
    -

    Optional Readonlyrole

    role?: IRole

    Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

    +

    Optional Readonlyrole

    role?: IRole

    Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

    Default

    - A role is automatically created for you
    @@ -42,10 +42,10 @@

    Optionaltags

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

    Tags for the cluster

    -

    Optional Readonlyversion

    version?: KubernetesVersion

    The Kubernetes version to run in the cluster

    +

    Optional Readonlyversion

    version?: KubernetesVersion

    The Kubernetes version to run in the cluster

    Optional Readonlyvpc

    vpc?: IVpc

    The VPC in which to create the Cluster.

    Default

    • a VPC with default configuration will be created and can be accessed through cluster.vpc.

    OptionalvpcSubnets

    vpcSubnets?: SubnetSelection[]

    Subnets are passed to the cluster configuration.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/clusters.GenericClusterProviderProps.html b/api/interfaces/clusters.GenericClusterProviderProps.html index 9488c087c..0a6123c7f 100644 --- a/api/interfaces/clusters.GenericClusterProviderProps.html +++ b/api/interfaces/clusters.GenericClusterProviderProps.html @@ -1,6 +1,6 @@ GenericClusterProviderProps | @aws-quickstart/eks-blueprints

    Interface GenericClusterProviderProps

    Properties for the generic cluster provider, containing definitions of managed node groups, auto-scaling groups, fargate profiles.

    -
    interface GenericClusterProviderProps {
        albController?: AlbControllerOptions;
        authenticationMode?: AuthenticationMode;
        autoscalingNodeGroups?: AutoscalingNodeGroup[];
        awscliLayer?: ILayerVersion;
        clusterHandlerEnvironment?: {
            [key: string]: string;
        };
        clusterHandlerSecurityGroup?: ISecurityGroup;
        clusterLogging?: ControlPlaneLogType[];
        clusterName?: string;
        coreDnsComputeType?: CoreDnsComputeType;
        endpointAccess?: EndpointAccess;
        fargateProfiles?: {
            [key: string]: eks.FargateProfileOptions;
        };
        ipFamily?: IpFamily;
        kubectlEnvironment?: {
            [key: string]: string;
        };
        kubectlLayer?: ILayerVersion;
        kubectlMemory?: Size;
        managedNodeGroups?: ManagedNodeGroup[];
        mastersRole?: IRole;
        onEventLayer?: ILayerVersion;
        outputClusterName?: boolean;
        outputConfigCommand?: boolean;
        outputMastersRoleArn?: boolean;
        placeClusterHandlerInVpc?: boolean;
        privateCluster?: boolean;
        prune?: boolean;
        role?: IRole;
        secretsEncryptionKey?: IKey;
        securityGroup?: ISecurityGroup;
        serviceIpv4Cidr?: string;
        tags?: {
            [key: string]: string;
        };
        version?: KubernetesVersion;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection[];
    }

    Hierarchy

    • Partial<eks.ClusterOptions>
      • GenericClusterProviderProps

    Properties

    albController? +
    interface GenericClusterProviderProps {
        albController?: AlbControllerOptions;
        authenticationMode?: AuthenticationMode;
        autoscalingNodeGroups?: AutoscalingNodeGroup[];
        awscliLayer?: ILayerVersion;
        clusterHandlerEnvironment?: {
            [key: string]: string;
        };
        clusterHandlerSecurityGroup?: ISecurityGroup;
        clusterLogging?: ControlPlaneLogType[];
        clusterName?: string;
        coreDnsComputeType?: CoreDnsComputeType;
        endpointAccess?: EndpointAccess;
        fargateProfiles?: {
            [key: string]: eks.FargateProfileOptions;
        };
        ipFamily?: IpFamily;
        kubectlEnvironment?: {
            [key: string]: string;
        };
        kubectlLayer?: ILayerVersion;
        kubectlMemory?: Size;
        managedNodeGroups?: ManagedNodeGroup[];
        mastersRole?: IRole;
        onEventLayer?: ILayerVersion;
        outputClusterName?: boolean;
        outputConfigCommand?: boolean;
        outputMastersRoleArn?: boolean;
        placeClusterHandlerInVpc?: boolean;
        privateCluster?: boolean;
        prune?: boolean;
        role?: IRole;
        secretsEncryptionKey?: IKey;
        securityGroup?: ISecurityGroup;
        serviceIpv4Cidr?: string;
        tags?: {
            [key: string]: string;
        };
        version?: KubernetesVersion;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection[];
    }

    Hierarchy

    • Partial<eks.ClusterOptions>
      • GenericClusterProviderProps

    Properties

    albController? authenticationMode? autoscalingNodeGroups? awscliLayer? @@ -42,7 +42,7 @@

    Default

    OptionalautoscalingNodeGroups

    autoscalingNodeGroups?: AutoscalingNodeGroup[]

    Array of autoscaling node groups.

    -

    Optional ReadonlyawscliLayer

    awscliLayer?: ILayerVersion

    An AWS Lambda layer that contains the aws CLI.

    +

    Optional ReadonlyawscliLayer

    awscliLayer?: ILayerVersion

    An AWS Lambda layer that contains the aws CLI.

    The handler expects the layer to include the following executables:

    /opt/awscli/aws
    @@ -78,7 +78,7 @@

    Default

    OptionalfargateProfiles

    fargateProfiles?: {
        [key: string]: eks.FargateProfileOptions;
    }

    Fargate profiles

    -

    Optional ReadonlyipFamily

    ipFamily?: IpFamily

    Specify which IP family is used to assign Kubernetes pod and service IP addresses.

    +

    Optional ReadonlyipFamily

    ipFamily?: IpFamily

    Specify which IP family is used to assign Kubernetes pod and service IP addresses.

    Default

    - IpFamily.IP_V4
    @@ -105,7 +105,7 @@

    SeeCopy

    OptionalmanagedNodeGroups

    managedNodeGroups?: ManagedNodeGroup[]

    Array of managed node groups.

    -

    Optional ReadonlymastersRole

    mastersRole?: IRole

    An IAM role that will be added to the system:masters Kubernetes RBAC +

    Optional ReadonlymastersRole

    mastersRole?: IRole

    An IAM role that will be added to the system:masters Kubernetes RBAC group.

    See

    https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings

    Default

    - no masters role.
@@ -144,7 +144,7 @@ 
    Default

    OptionalprivateCluster

    privateCluster?: boolean

    Whether API server is private.

    -

    Optional Readonlyprune

    prune?: boolean

    Indicates whether Kubernetes resources added through addManifest() can be +

    Optional Readonlyprune

    prune?: boolean

    Indicates whether Kubernetes resources added through addManifest() can be automatically pruned. When this is enabled (default), prune labels will be allocated and injected to each resource. These labels will then be used when issuing the kubectl apply operation with the --prune switch.

    @@ -169,7 +169,7 @@

    DefaultSee

    https://docs.aws.amazon.com/eks/latest/APIReference/API_KubernetesNetworkConfigRequest.html#AmazonEKS-Type-KubernetesNetworkConfigRequest-serviceIpv4Cidr

    Optionaltags

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

    Tags for the cluster

    -

    Optional Readonlyversion

    version?: KubernetesVersion

    The Kubernetes version to run in the cluster

    +

    Optional Readonlyversion

    version?: KubernetesVersion

    The Kubernetes version to run in the cluster

    Optional Readonlyvpc

    vpc?: IVpc

    The VPC in which to create the Cluster.

    Default

    Optionalid

    id?: string

    Used for the CDK construct id for the imported cluster. Useful when passing tokens for cluster name.

    -

    Optional ReadonlyipFamily

    ipFamily?: IpFamily

    Specify which IP family is used to assign Kubernetes pod and service IP addresses.

    +

    Optional ReadonlyipFamily

    ipFamily?: IpFamily

    Specify which IP family is used to assign Kubernetes pod and service IP addresses.

    Default

    - IpFamily.IP_V4
    @@ -133,4 +133,4 @@

    Seecluster.connections.

    version

    version: KubernetesVersion

    This property is needed as it drives selection of certain add-on versions as well as kubectl layer.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/clusters.LaunchTemplateProps.html b/api/interfaces/clusters.LaunchTemplateProps.html index 8beab5577..87eacba19 100644 --- a/api/interfaces/clusters.LaunchTemplateProps.html +++ b/api/interfaces/clusters.LaunchTemplateProps.html @@ -1,14 +1,14 @@ LaunchTemplateProps | @aws-quickstart/eks-blueprints

    Interface LaunchTemplateProps

    Configuration options for the custom AMI.

    -
    interface LaunchTemplateProps {
        blockDevices?: BlockDevice[];
        machineImage?: IMachineImage;
        requireImdsv2?: boolean;
        securityGroup?: ISecurityGroup;
        tags?: {
            [key: string]: string;
        };
        userData?: UserData;
    }

    Properties

    blockDevices? +
    interface LaunchTemplateProps {
        blockDevices?: BlockDevice[];
        machineImage?: IMachineImage;
        requireImdsv2?: boolean;
        securityGroup?: ISecurityGroup;
        tags?: {
            [key: string]: string;
        };
        userData?: UserData;
    }

    Properties

    blockDevices? machineImage? requireImdsv2? securityGroup? tags? userData?

    Properties

    OptionalblockDevices

    blockDevices?: BlockDevice[]

    Specifies how block devices are exposed to the instance

    -

    OptionalmachineImage

    machineImage?: IMachineImage

    The custom AMI for the node group.

    -

    OptionalrequireImdsv2

    requireImdsv2?: boolean

    Whether IMDSv2 should be required on launched instances. (optional, default: false)

    -

    OptionalsecurityGroup

    securityGroup?: ISecurityGroup

    Security group to assign to instances created with the launch template.

    -

    Optionaltags

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

    Custom Tags for launch template which will propogate to worker nodes.

    -

    OptionaluserData

    userData?: UserData

    The userData for worker node when using custom AMI. Only applicable when customAmi is used.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    OptionalmachineImage

    machineImage?: IMachineImage

    The custom AMI for the node group.

    +

    OptionalrequireImdsv2

    requireImdsv2?: boolean

    Whether IMDSv2 should be required on launched instances. (optional, default: false)

    +

    OptionalsecurityGroup

    securityGroup?: ISecurityGroup

    Security group to assign to instances created with the launch template.

    +

    Optionaltags

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

    Custom Tags for launch template which will propogate to worker nodes.

    +

    OptionaluserData

    userData?: UserData

    The userData for worker node when using custom AMI. Only applicable when customAmi is used.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/clusters.ManagedNodeGroup.html b/api/interfaces/clusters.ManagedNodeGroup.html index 4c6527892..da7102f2b 100644 --- a/api/interfaces/clusters.ManagedNodeGroup.html +++ b/api/interfaces/clusters.ManagedNodeGroup.html @@ -1,4 +1,4 @@ -ManagedNodeGroup | @aws-quickstart/eks-blueprints

    Interface ManagedNodeGroup

    interface ManagedNodeGroup {
        amiReleaseVersion?: string;
        amiType?: NodegroupAmiType;
        desiredSize?: number;
        diskSize?: number;
        enableSsmPermissions?: boolean;
        forceUpdate?: boolean;
        id: string;
        instanceTypes?: InstanceType[];
        labels?: {
            [name: string]: string;
        };
        launchTemplate?: LaunchTemplateProps;
        launchTemplateSpec?: LaunchTemplateSpec;
        maxSize?: number;
        maxUnavailable?: number;
        maxUnavailablePercentage?: number;
        minSize?: number;
        nodeGroupCapacityType?: CapacityType;
        nodeGroupSubnets?: SubnetSelection;
        nodeRole?: IRole;
        nodegroupName?: string;
        remoteAccess?: NodegroupRemoteAccess;
        tags?: {
            [name: string]: string;
        };
        taints?: TaintSpec[];
    }

    Hierarchy

    • Omit<eks.NodegroupOptions,
          | "launchTemplate"
          | "subnets"
          | "capacityType"
          | "releaseVersion">
      • ManagedNodeGroup

    Properties

    amiReleaseVersion? +ManagedNodeGroup | @aws-quickstart/eks-blueprints

    Interface ManagedNodeGroup

    interface ManagedNodeGroup {
        amiReleaseVersion?: string;
        amiType?: NodegroupAmiType;
        desiredSize?: number;
        diskSize?: number;
        enableSsmPermissions?: boolean;
        forceUpdate?: boolean;
        id: string;
        instanceTypes?: InstanceType[];
        labels?: {
            [name: string]: string;
        };
        launchTemplate?: LaunchTemplateProps;
        launchTemplateSpec?: LaunchTemplateSpec;
        maxSize?: number;
        maxUnavailable?: number;
        maxUnavailablePercentage?: number;
        minSize?: number;
        nodeGroupCapacityType?: CapacityType;
        nodeGroupSubnets?: SubnetSelection;
        nodeRole?: IRole;
        nodegroupName?: string;
        remoteAccess?: NodegroupRemoteAccess;
        tags?: {
            [name: string]: string;
        };
        taints?: TaintSpec[];
    }

    Hierarchy

    • Omit<eks.NodegroupOptions,
          | "launchTemplate"
          | "subnets"
          | "capacityType"
          | "releaseVersion">
      • ManagedNodeGroup

    Properties

    amiReleaseVersion? amiType? desiredSize? diskSize? @@ -22,14 +22,14 @@ taints?

    Properties

    OptionalamiReleaseVersion

    amiReleaseVersion?: string

    This property is used to upgrade node groups to the latest kubelet by upgrading node group AMI. Look up the versions here (mapped to Kubernetes version): https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html

    -

    OptionalamiType

    amiType?: NodegroupAmiType

    Choose AMI type for the managed node group.

    -

    OptionaldesiredSize

    desiredSize?: number

    Desired size, defaults to min size.

    -

    Optional ReadonlydiskSize

    diskSize?: number

    The root device disk size (in GiB) for your node group instances.

    +

    OptionalamiType

    amiType?: NodegroupAmiType

    Choose AMI type for the managed node group.

    +

    OptionaldesiredSize

    desiredSize?: number

    Desired size, defaults to min size.

    +

    Optional ReadonlydiskSize

    diskSize?: number

    The root device disk size (in GiB) for your node group instances.

    Default

    20

    OptionalenableSsmPermissions

    enableSsmPermissions?: boolean

    If set to true will add AmazonSSMManagedInstanceCore to the node role.

    -

    Optional ReadonlyforceUpdate

    forceUpdate?: boolean

    Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. +

    Optional ReadonlyforceUpdate

    forceUpdate?: boolean

    Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.

    @@ -37,17 +37,17 @@

    id

    id: string

    Id of this node group. Expected to be unique in cluster scope.

    -

    OptionalinstanceTypes

    instanceTypes?: InstanceType[]

    Instance types used for the node group. Multiple types makes sense if capacity type is SPOT.

    +

    OptionalinstanceTypes

    instanceTypes?: InstanceType[]

    Instance types used for the node group. Multiple types makes sense if capacity type is SPOT.

    Default

    m5.large
    -

    Optional Readonlylabels

    labels?: {
        [name: string]: string;
    }

    The Kubernetes labels to be applied to the nodes in the node group when they are created.

    +

    Optional Readonlylabels

    labels?: {
        [name: string]: string;
    }

    The Kubernetes labels to be applied to the nodes in the node group when they are created.

    Default

    - None

    OptionallaunchTemplate

    launchTemplate?: LaunchTemplateProps

    The Launch Template properties for the Nodes. amiType and amiReleaseVersion will be ignored if this is set.

    -

    Optional ReadonlylaunchTemplateSpec

    launchTemplateSpec?: LaunchTemplateSpec

    Launch template specification used for the nodegroup

    +

    Optional ReadonlylaunchTemplateSpec

    launchTemplateSpec?: LaunchTemplateSpec

    Launch template specification used for the nodegroup

    See

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

    Default

    Default

    3
    -

    Optional ReadonlymaxUnavailable

    maxUnavailable?: number

    The maximum number of nodes unavailable at once during a version update. +

    Optional ReadonlymaxUnavailable

    maxUnavailable?: number

    The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. The maximum number is 100.

    This value or maxUnavailablePercentage is required to have a value for custom update configurations to be applied.

    See

    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-updateconfig.html#cfn-eks-nodegroup-updateconfig-maxunavailable

    @@ -76,12 +76,12 @@

    Default

    Default

    1
    -

    OptionalnodeGroupCapacityType

    nodeGroupCapacityType?: CapacityType

    Select either SPOT or ON-DEMAND

    -

    OptionalnodeGroupSubnets

    nodeGroupSubnets?: SubnetSelection

    Subnets for the autoscaling group where nodes (instances) will be placed.

    +

    OptionalnodeGroupCapacityType

    nodeGroupCapacityType?: CapacityType

    Select either SPOT or ON-DEMAND

    +

    OptionalnodeGroupSubnets

    nodeGroupSubnets?: SubnetSelection

    Subnets for the autoscaling group where nodes (instances) will be placed.

    Default

    all private subnets
    -

    Optional ReadonlynodeRole

    nodeRole?: IRole

    The IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon +

    Optional ReadonlynodeRole

    nodeRole?: IRole

    The IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched.

    diff --git a/api/interfaces/clusters.MngClusterProviderProps.html b/api/interfaces/clusters.MngClusterProviderProps.html index 63a81336b..8ef1c1aaa 100644 --- a/api/interfaces/clusters.MngClusterProviderProps.html +++ b/api/interfaces/clusters.MngClusterProviderProps.html @@ -1,5 +1,5 @@ MngClusterProviderProps | @aws-quickstart/eks-blueprints

    Interface MngClusterProviderProps

    Configuration options for the cluster provider.

    -
    interface MngClusterProviderProps {
        amiReleaseVersion?: string;
        amiType?: NodegroupAmiType;
        clusterName?: string;
        desiredSize?: number;
        diskSize?: number;
        enableSsmPermissions?: boolean;
        forceUpdate?: boolean;
        id?: string;
        instanceTypes?: InstanceType[];
        labels?: {
            [name: string]: string;
        };
        launchTemplate?: LaunchTemplateProps;
        launchTemplateSpec?: LaunchTemplateSpec;
        maxSize?: number;
        maxUnavailable?: number;
        maxUnavailablePercentage?: number;
        minSize?: number;
        name?: string;
        nodeGroupCapacityType?: CapacityType;
        nodeGroupSubnets?: SubnetSelection;
        nodeGroupTags?: {
            [key: string]: string;
        };
        nodeRole?: IRole;
        nodegroupName?: string;
        outputClusterName?: boolean;
        outputConfigCommand?: boolean;
        privateCluster?: boolean;
        remoteAccess?: NodegroupRemoteAccess;
        role?: IRole;
        securityGroup?: ISecurityGroup;
        tags?: {
            [key: string]: string;
        };
        taints?: TaintSpec[];
        version?: KubernetesVersion;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection[];
    }

    Hierarchy

    • Partial<eks.CommonClusterOptions>
    • Omit<ManagedNodeGroup, "id">
      • MngClusterProviderProps

    Properties

    amiReleaseVersion? +
    interface MngClusterProviderProps {
        amiReleaseVersion?: string;
        amiType?: NodegroupAmiType;
        clusterName?: string;
        desiredSize?: number;
        diskSize?: number;
        enableSsmPermissions?: boolean;
        forceUpdate?: boolean;
        id?: string;
        instanceTypes?: InstanceType[];
        labels?: {
            [name: string]: string;
        };
        launchTemplate?: LaunchTemplateProps;
        launchTemplateSpec?: LaunchTemplateSpec;
        maxSize?: number;
        maxUnavailable?: number;
        maxUnavailablePercentage?: number;
        minSize?: number;
        name?: string;
        nodeGroupCapacityType?: CapacityType;
        nodeGroupSubnets?: SubnetSelection;
        nodeGroupTags?: {
            [key: string]: string;
        };
        nodeRole?: IRole;
        nodegroupName?: string;
        outputClusterName?: boolean;
        outputConfigCommand?: boolean;
        privateCluster?: boolean;
        remoteAccess?: NodegroupRemoteAccess;
        role?: IRole;
        securityGroup?: ISecurityGroup;
        tags?: {
            [key: string]: string;
        };
        taints?: TaintSpec[];
        version?: KubernetesVersion;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection[];
    }

    Hierarchy

    • Partial<eks.CommonClusterOptions>
    • Omit<ManagedNodeGroup, "id">
      • MngClusterProviderProps

    Properties

    amiReleaseVersion? amiType? clusterName? desiredSize? @@ -34,18 +34,18 @@ vpcSubnets?

    Properties

    OptionalamiReleaseVersion

    amiReleaseVersion?: string

    This property is used to upgrade node groups to the latest kubelet by upgrading node group AMI. Look up the versions here (mapped to Kubernetes version): https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html

    -

    OptionalamiType

    amiType?: NodegroupAmiType

    Choose AMI type for the managed node group.

    -

    Optional ReadonlyclusterName

    clusterName?: string

    Name for the cluster.

    +

    OptionalamiType

    amiType?: NodegroupAmiType

    Choose AMI type for the managed node group.

    +

    Optional ReadonlyclusterName

    clusterName?: string

    Name for the cluster.

    Default

    - Automatically generated name

    OptionaldesiredSize

    desiredSize?: number

    Desired size, defaults to min size.

    -

    Optional ReadonlydiskSize

    diskSize?: number

    The root device disk size (in GiB) for your node group instances.

    +

    Optional ReadonlydiskSize

    diskSize?: number

    The root device disk size (in GiB) for your node group instances.

    Default

    20

    OptionalenableSsmPermissions

    enableSsmPermissions?: boolean

    If set to true will add AmazonSSMManagedInstanceCore to the node role.

    -

    Optional ReadonlyforceUpdate

    forceUpdate?: boolean

    Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. +

    Optional ReadonlyforceUpdate

    forceUpdate?: boolean

    Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.

    @@ -53,17 +53,17 @@

    Optionalid

    id?: string

    In this case id is optional and defaults tp the cluster name

    -

    OptionalinstanceTypes

    instanceTypes?: InstanceType[]

    Instance types used for the node group. Multiple types makes sense if capacity type is SPOT.

    +

    OptionalinstanceTypes

    instanceTypes?: InstanceType[]

    Instance types used for the node group. Multiple types makes sense if capacity type is SPOT.

    Default

    m5.large
    -

    Optional Readonlylabels

    labels?: {
        [name: string]: string;
    }

    The Kubernetes labels to be applied to the nodes in the node group when they are created.

    +

    Optional Readonlylabels

    labels?: {
        [name: string]: string;
    }

    The Kubernetes labels to be applied to the nodes in the node group when they are created.

    Default

    - None

    OptionallaunchTemplate

    launchTemplate?: LaunchTemplateProps

    The Launch Template properties for the Nodes. amiType and amiReleaseVersion will be ignored if this is set.

    -

    Optional ReadonlylaunchTemplateSpec

    launchTemplateSpec?: LaunchTemplateSpec

    Launch template specification used for the nodegroup

    +

    Optional ReadonlylaunchTemplateSpec

    launchTemplateSpec?: LaunchTemplateSpec

    Launch template specification used for the nodegroup

    See

    @@ -74,7 +74,7 @@

    Default

    Default

    3
    -

    Optional ReadonlymaxUnavailable

    maxUnavailable?: number

    The maximum number of nodes unavailable at once during a version update. +

    Optional ReadonlymaxUnavailable

    maxUnavailable?: number

    The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. The maximum number is 100.

    This value or maxUnavailablePercentage is required to have a value for custom update configurations to be applied.

    See

    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-updateconfig.html#cfn-eks-nodegroup-updateconfig-maxunavailable

    @@ -92,15 +92,15 @@

    Default

    Default

    1
    -

    Optionalname

    name?: string

    The name for the cluster.

    +

    Optionalname

    name?: string

    The name for the cluster.

    Deprecated

    use #clusterName

    -

    OptionalnodeGroupCapacityType

    nodeGroupCapacityType?: CapacityType

    Select either SPOT or ON-DEMAND

    -

    OptionalnodeGroupSubnets

    nodeGroupSubnets?: SubnetSelection

    Subnets for the autoscaling group where nodes (instances) will be placed.

    +

    OptionalnodeGroupCapacityType

    nodeGroupCapacityType?: CapacityType

    Select either SPOT or ON-DEMAND

    +

    OptionalnodeGroupSubnets

    nodeGroupSubnets?: SubnetSelection

    Subnets for the autoscaling group where nodes (instances) will be placed.

    Default

    all private subnets
    -

    OptionalnodeGroupTags

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

    Tags for the node group.

    -

    Optional ReadonlynodeRole

    nodeRole?: IRole

    The IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon +

    OptionalnodeGroupTags

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

    Tags for the node group.

    +

    Optional ReadonlynodeRole

    nodeRole?: IRole

    The IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched.

    @@ -126,7 +126,7 @@

    Default

    Default

    false
    -

    Optional ReadonlyremoteAccess

    remoteAccess?: NodegroupRemoteAccess

    The remote access (SSH) configuration to use with your node group. Disabled by default, however, if you +

    Optional ReadonlyremoteAccess

    remoteAccess?: NodegroupRemoteAccess

    The remote access (SSH) configuration to use with your node group. Disabled by default, however, if you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the worker nodes is opened to the internet (0.0.0.0/0)

    Default

    - disabled
@@ -141,7 +141,7 @@ 
    Default

    Optionaltags

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

    Tags for the Cluster.

    -

    Optional Readonlytaints

    taints?: TaintSpec[]

    The Kubernetes taints to be applied to the nodes in the node group when they are created.

    +

    Optional Readonlytaints

    taints?: TaintSpec[]

    The Kubernetes taints to be applied to the nodes in the node group when they are created.

    Default

    - None
    diff --git a/api/interfaces/pipelines.CodeCommitSourceRepository.html b/api/interfaces/pipelines.CodeCommitSourceRepository.html index c44cf3805..cb29d5060 100644 --- a/api/interfaces/pipelines.CodeCommitSourceRepository.html +++ b/api/interfaces/pipelines.CodeCommitSourceRepository.html @@ -1,18 +1,18 @@ -CodeCommitSourceRepository | @aws-quickstart/eks-blueprints

    Interface CodeCommitSourceRepository

    interface CodeCommitSourceRepository {
        codeCommitOptions?: CodeCommitSourceOptions;
        codeCommitRepoName: string;
        credentialsSecretName?: string;
        name?: string;
        path?: string;
        targetRevision?: string;
    }

    Hierarchy

    • Omit<ApplicationRepository, "credentialsType" | "credentialsSecretName " | "repoUrl">
      • CodeCommitSourceRepository

    Properties

    codeCommitOptions? +CodeCommitSourceRepository | @aws-quickstart/eks-blueprints

    Interface CodeCommitSourceRepository

    interface CodeCommitSourceRepository {
        codeCommitOptions?: CodeCommitSourceOptions;
        codeCommitRepoName: string;
        credentialsSecretName?: string;
        name?: string;
        path?: string;
        targetRevision?: string;
    }

    Hierarchy

    • Omit<ApplicationRepository, "credentialsType" | "credentialsSecretName " | "repoUrl">
      • CodeCommitSourceRepository

    Properties

    codeCommitOptions? codeCommitRepoName credentialsSecretName? name? path? targetRevision?

    Properties

    OptionalcodeCommitOptions

    codeCommitOptions?: CodeCommitSourceOptions

    Optional CodeCommitSourceOptions.

    -

    codeCommitRepoName

    codeCommitRepoName: string

    The name of the CodeCommit repository.

    -

    OptionalcredentialsSecretName

    credentialsSecretName?: string

    Secret from AWS Secrets Manager to import credentials to access the specified git repository. +

    codeCommitRepoName

    codeCommitRepoName: string

    The name of the CodeCommit repository.

    +

    OptionalcredentialsSecretName

    credentialsSecretName?: string

    Secret from AWS Secrets Manager to import credentials to access the specified git repository. The secret must exist in the same region and account where the stack will run.

    -

    Optionalname

    name?: string

    Optional name for the bootstrap application

    -

    Optionalpath

    path?: string

    Path within the repository

    -

    OptionaltargetRevision

    targetRevision?: string

    Optional target revision for the repository. +

    Optionalname

    name?: string

    Optional name for the bootstrap application

    +

    Optionalpath

    path?: string

    Path within the repository

    +

    OptionaltargetRevision

    targetRevision?: string

    Optional target revision for the repository. TargetRevision defines the revision of the source to sync the application to. In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD. In case of Helm, this is a semver tag for the Chart's version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/pipelines.CodeStarConnectionRepository.html b/api/interfaces/pipelines.CodeStarConnectionRepository.html index f66fca226..b9555a40f 100644 --- a/api/interfaces/pipelines.CodeStarConnectionRepository.html +++ b/api/interfaces/pipelines.CodeStarConnectionRepository.html @@ -1,4 +1,4 @@ -CodeStarConnectionRepository | @aws-quickstart/eks-blueprints

    Interface CodeStarConnectionRepository

    interface CodeStarConnectionRepository {
        codeStarConnectionArn: string;
        credentialsSecretName?: string;
        name?: string;
        owner?: string;
        path?: string;
        repoUrl: string;
        targetRevision?: string;
    }

    Hierarchy

    Properties

    codeStarConnectionArn +CodeStarConnectionRepository | @aws-quickstart/eks-blueprints

    Interface CodeStarConnectionRepository

    interface CodeStarConnectionRepository {
        codeStarConnectionArn: string;
        credentialsSecretName?: string;
        name?: string;
        owner?: string;
        path?: string;
        repoUrl: string;
        targetRevision?: string;
    }

    Hierarchy

    Properties

    codeStarConnectionArn credentialsSecretName? name? owner? @@ -6,15 +6,15 @@ repoUrl targetRevision?

    Properties

    codeStarConnectionArn

    codeStarConnectionArn: string

    The ARN of the CodeStar Connection.

    -

    OptionalcredentialsSecretName

    credentialsSecretName?: string

    Secret from AWS Secrets Manager to import credentials to access the specified git repository. +

    OptionalcredentialsSecretName

    credentialsSecretName?: string

    Secret from AWS Secrets Manager to import credentials to access the specified git repository. The secret must exist in the same region and account where the stack will run.

    -

    Optionalname

    name?: string

    Optional name for the bootstrap application

    -

    Optionalowner

    owner?: string

    The owner of the repository for the pipeline

    -

    Optionalpath

    path?: string

    Path within the repository

    -

    repoUrl

    repoUrl: string

    Expected to support helm style repo at the moment

    -

    OptionaltargetRevision

    targetRevision?: string

    Optional target revision for the repository. +

    Optionalname

    name?: string

    Optional name for the bootstrap application

    +

    Optionalowner

    owner?: string

    The owner of the repository for the pipeline

    +

    Optionalpath

    path?: string

    Path within the repository

    +

    repoUrl

    repoUrl: string

    Expected to support helm style repo at the moment

    +

    OptionaltargetRevision

    targetRevision?: string

    Optional target revision for the repository. TargetRevision defines the revision of the source to sync the application to. In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD. In case of Helm, this is a semver tag for the Chart's version.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/pipelines.GitHubSourceRepository.html b/api/interfaces/pipelines.GitHubSourceRepository.html index 645288fe9..c75340c8b 100644 --- a/api/interfaces/pipelines.GitHubSourceRepository.html +++ b/api/interfaces/pipelines.GitHubSourceRepository.html @@ -1,6 +1,6 @@ GitHubSourceRepository | @aws-quickstart/eks-blueprints

    Interface GitHubSourceRepository

    credentialsType is excluded and the only supported credentialsSecret is a plaintext GitHub OAuth token. repoUrl

    -
    interface GitHubSourceRepository {
        credentialsSecretName: string;
        name?: string;
        owner?: string;
        path?: string;
        repoUrl: string;
        targetRevision?: string;
        trigger?: GitHubTrigger;
    }

    Hierarchy

    Properties

    credentialsSecretName +
    interface GitHubSourceRepository {
        credentialsSecretName: string;
        name?: string;
        owner?: string;
        path?: string;
        repoUrl: string;
        targetRevision?: string;
        trigger?: GitHubTrigger;
    }

    Hierarchy

    Properties

    credentialsSecretName name? owner? path? @@ -18,14 +18,14 @@
  • admin:repo_hook - if you plan to use webhooks (true by default)

    • See

    https://docs.aws.amazon.com/codepipeline/latest/userguide/GitHub-create-personal-token-CLI.html

    -

    Optionalname

    name?: string

    Optional name for the bootstrap application

    -

    Optionalowner

    owner?: string

    The owner of the repository for the pipeline (GitHub handle).

    -

    Optionalpath

    path?: string

    Path within the repository

    -

    repoUrl

    repoUrl: string

    Expected to support helm style repo at the moment

    -

    OptionaltargetRevision

    targetRevision?: string

    Optional target revision for the repository. +

    Optionalname

    name?: string

    Optional name for the bootstrap application

    +

    Optionalowner

    owner?: string

    The owner of the repository for the pipeline (GitHub handle).

    +

    Optionalpath

    path?: string

    Path within the repository

    +

    repoUrl

    repoUrl: string

    Expected to support helm style repo at the moment

    +

    OptionaltargetRevision

    targetRevision?: string

    Optional target revision for the repository. TargetRevision defines the revision of the source to sync the application to. In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD. In case of Helm, this is a semver tag for the Chart's version.

    -

    Optionaltrigger

    trigger?: GitHubTrigger

    How GitHub source action will be triggered.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Optionaltrigger

    trigger?: GitHubTrigger

    How GitHub source action will be triggered.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/pipelines.PipelineWave.html b/api/interfaces/pipelines.PipelineWave.html index a13575c23..0218c05bc 100644 --- a/api/interfaces/pipelines.PipelineWave.html +++ b/api/interfaces/pipelines.PipelineWave.html @@ -1,5 +1,5 @@ PipelineWave | @aws-quickstart/eks-blueprints

    Interface PipelineWave

    Represents wave configuration

    -
    interface PipelineWave {
        id: string;
        props?: WaveProps;
        stages: StackStage[];
    }

    Properties

    id +
    interface PipelineWave {
        id: string;
        props?: WaveProps;
        stages: StackStage[];
    }

    Properties

    id props? stages -

    Properties

    id

    id: string

    Optionalprops

    props?: WaveProps

    stages

    stages: StackStage[]

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Properties

    id

    id: string

    Optionalprops

    props?: WaveProps

    stages

    stages: StackStage[]

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/pipelines.StackStage.html b/api/interfaces/pipelines.StackStage.html index 394b04498..cffee48d4 100644 --- a/api/interfaces/pipelines.StackStage.html +++ b/api/interfaces/pipelines.StackStage.html @@ -1,8 +1,8 @@ StackStage | @aws-quickstart/eks-blueprints

    Interface StackStage

    Stack stage is a builder construct to allow adding stages to a pipeline. Each stage is expected to produce a stack.

    -
    interface StackStage {
        id: string;
        stackBuilder: StackBuilder;
        stageProps?: AddStageOpts;
    }

    Hierarchy (view full)

    Properties

    id +
    interface StackStage {
        id: string;
        stackBuilder: StackBuilder;
        stageProps?: AddStageOpts;
    }

    Hierarchy (view full)

    Properties

    id stackBuilder stageProps?

    Properties

    id

    id: string

    id of the stage

    -

    stackBuilder

    stackBuilder: StackBuilder

    Builder that can produce a stack which will be deployed as part of the stage

    -

    OptionalstageProps

    stageProps?: AddStageOpts

    Optional stage properties, such as {manualApprovals: true} which can control stage transitions.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    stackBuilder

    stackBuilder: StackBuilder

    Builder that can produce a stack which will be deployed as part of the stage

    +

    OptionalstageProps

    stageProps?: AddStageOpts

    Optional stage properties, such as {manualApprovals: true} which can control stage transitions.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/pipelines.WaveStage.html b/api/interfaces/pipelines.WaveStage.html index 58ffd7686..acd9a4483 100644 --- a/api/interfaces/pipelines.WaveStage.html +++ b/api/interfaces/pipelines.WaveStage.html @@ -1,10 +1,10 @@ WaveStage | @aws-quickstart/eks-blueprints

    Interface WaveStage

    Internal interface for wave stages

    -
    interface WaveStage {
        id: string;
        stackBuilder: StackBuilder;
        stageProps?: AddStageOpts;
        waveId?: string;
    }

    Hierarchy (view full)

    Properties

    id +
    interface WaveStage {
        id: string;
        stackBuilder: StackBuilder;
        stageProps?: AddStageOpts;
        waveId?: string;
    }

    Hierarchy (view full)

    Properties

    id stackBuilder stageProps? waveId?

    Properties

    id

    id: string

    id of the stage

    -

    stackBuilder

    stackBuilder: StackBuilder

    Builder that can produce a stack which will be deployed as part of the stage

    -

    OptionalstageProps

    stageProps?: AddStageOpts

    Optional stage properties, such as {manualApprovals: true} which can control stage transitions.

    -

    OptionalwaveId

    waveId?: string

    Wave id if this stage is part of a wave. Not required if stage is supplied

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    stackBuilder

    stackBuilder: StackBuilder

    Builder that can produce a stack which will be deployed as part of the stage

    +

    OptionalstageProps

    stageProps?: AddStageOpts

    Optional stage properties, such as {manualApprovals: true} which can control stage transitions.

    +

    OptionalwaveId

    waveId?: string

    Wave id if this stage is part of a wave. Not required if stage is supplied

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/resources.CreateEfsFileSystemProps.html b/api/interfaces/resources.CreateEfsFileSystemProps.html index fa663e4d8..c1098fb75 100644 --- a/api/interfaces/resources.CreateEfsFileSystemProps.html +++ b/api/interfaces/resources.CreateEfsFileSystemProps.html @@ -1,4 +1,4 @@ -CreateEfsFileSystemProps | @aws-quickstart/eks-blueprints

    Interface CreateEfsFileSystemProps

    interface CreateEfsFileSystemProps {
        efsProps?: Omit<FileSystemProps, "vpc" | "kmsKey">;
        kmsKeyResourceName?: string;
        name?: string;
    }

    Properties

    efsProps? +CreateEfsFileSystemProps | @aws-quickstart/eks-blueprints

    Interface CreateEfsFileSystemProps

    interface CreateEfsFileSystemProps {
        efsProps?: Omit<FileSystemProps, "vpc" | "kmsKey">;
        kmsKeyResourceName?: string;
        name?: string;
    }

    Properties

    efsProps? kmsKeyResourceName? name? -

    Properties

    Optional ReadonlyefsProps

    efsProps?: Omit<FileSystemProps, "vpc" | "kmsKey">

    Optional ReadonlykmsKeyResourceName

    kmsKeyResourceName?: string

    Optional Readonlyname

    name?: string

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Properties

    Optional ReadonlyefsProps

    efsProps?: Omit<FileSystemProps, "vpc" | "kmsKey">

    Optional ReadonlykmsKeyResourceName

    kmsKeyResourceName?: string

    Optional Readonlyname

    name?: string

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/resources.CreateS3BucketProps.html b/api/interfaces/resources.CreateS3BucketProps.html index a4124498c..2001c2b6e 100644 --- a/api/interfaces/resources.CreateS3BucketProps.html +++ b/api/interfaces/resources.CreateS3BucketProps.html @@ -1,4 +1,4 @@ -CreateS3BucketProps | @aws-quickstart/eks-blueprints

    Interface CreateS3BucketProps

    interface CreateS3BucketProps {
        id: string;
        name?: string;
        s3BucketProps?: Omit<BucketProps, "bucketName">;
    }

    Properties

    id +CreateS3BucketProps | @aws-quickstart/eks-blueprints

    Interface CreateS3BucketProps

    interface CreateS3BucketProps {
        id: string;
        name?: string;
        s3BucketProps?: Omit<BucketProps, "bucketName">;
    }

    Properties

    id name? s3BucketProps? -

    Properties

    Readonlyid

    id: string

    Optional Readonlyname

    name?: string

    Optional Readonlys3BucketProps

    s3BucketProps?: Omit<BucketProps, "bucketName">

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Properties

    Readonlyid

    id: string

    Optional Readonlyname

    name?: string

    Optional Readonlys3BucketProps

    s3BucketProps?: Omit<BucketProps, "bucketName">

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/resources.DelegatingHostedZoneProviderProps.html b/api/interfaces/resources.DelegatingHostedZoneProviderProps.html index 107eb56d3..5665044e0 100644 --- a/api/interfaces/resources.DelegatingHostedZoneProviderProps.html +++ b/api/interfaces/resources.DelegatingHostedZoneProviderProps.html @@ -1,12 +1,12 @@ -DelegatingHostedZoneProviderProps | @aws-quickstart/eks-blueprints

    Interface DelegatingHostedZoneProviderProps

    interface DelegatingHostedZoneProviderProps {
        delegatingRoleName: string;
        parentDnsAccountId: string;
        parentDomain: string;
        subdomain: string;
        wildcardSubdomain?: boolean;
    }

    Properties

    delegatingRoleName +DelegatingHostedZoneProviderProps | @aws-quickstart/eks-blueprints

    Interface DelegatingHostedZoneProviderProps

    interface DelegatingHostedZoneProviderProps {
        delegatingRoleName: string;
        parentDnsAccountId: string;
        parentDomain: string;
        subdomain: string;
        wildcardSubdomain?: boolean;
    }

    Properties

    delegatingRoleName parentDnsAccountId parentDomain subdomain wildcardSubdomain?

    Properties

    delegatingRoleName

    delegatingRoleName: string

    Role name in the parent account for delegation. Must have trust relationship set up with the workload account where the EKS Cluster Blueprint is provisioned (account level trust).

    -

    parentDnsAccountId

    parentDnsAccountId: string

    Account Id for the parent hosted zone.

    -

    parentDomain

    parentDomain: string

    Parent domain name.

    -

    subdomain

    subdomain: string

    Name for the child zone (expected to be a subdomain of the parent hosted zone).

    -

    OptionalwildcardSubdomain

    wildcardSubdomain?: boolean

    Where a wild-card entry should be created for the subdomain. In this case a wildcard CNAME record is created along with the subdomain.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    parentDnsAccountId

    parentDnsAccountId: string

    Account Id for the parent hosted zone.

    +

    parentDomain

    parentDomain: string

    Parent domain name.

    +

    subdomain

    subdomain: string

    Name for the child zone (expected to be a subdomain of the parent hosted zone).

    +

    OptionalwildcardSubdomain

    wildcardSubdomain?: boolean

    Where a wild-card entry should be created for the subdomain. In this case a wildcard CNAME record is created along with the subdomain.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/resources.LookupEfsFileSystemProps.html b/api/interfaces/resources.LookupEfsFileSystemProps.html index 0bf6c6574..528092783 100644 --- a/api/interfaces/resources.LookupEfsFileSystemProps.html +++ b/api/interfaces/resources.LookupEfsFileSystemProps.html @@ -1,3 +1,3 @@ -LookupEfsFileSystemProps | @aws-quickstart/eks-blueprints

    Interface LookupEfsFileSystemProps

    interface LookupEfsFileSystemProps {
        fileSystemId: string;
        name: string;
    }

    Properties

    fileSystemId +LookupEfsFileSystemProps | @aws-quickstart/eks-blueprints

    Interface LookupEfsFileSystemProps

    interface LookupEfsFileSystemProps {
        fileSystemId: string;
        name: string;
    }

    Properties

    fileSystemId name -

    Properties

    ReadonlyfileSystemId

    fileSystemId: string

    Readonlyname

    name: string

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Properties

    ReadonlyfileSystemId

    fileSystemId: string

    Readonlyname

    name: string

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/teams.BatchEksTeamProps.html b/api/interfaces/teams.BatchEksTeamProps.html index 1ea6cc070..89d0cebcc 100644 --- a/api/interfaces/teams.BatchEksTeamProps.html +++ b/api/interfaces/teams.BatchEksTeamProps.html @@ -1,5 +1,5 @@ BatchEksTeamProps | @aws-quickstart/eks-blueprints

    Interface BatchEksTeamProps

    Interface to define an AWS Batch on EKS team

    -
    interface BatchEksTeamProps {
        computeResources: {
            allocationStrategy: BatchAllocationStrategy;
            envType: BatchEnvType;
            instanceTypes: string[];
            maxvCpus: number;
            minvCpus: number;
            priority: number;
        };
        envName: string;
        jobQueueName: string;
        name: string;
        namespace?: string;
        namespaceAnnotations?: {
            [key: string]: any;
        };
        namespaceHardLimits?: Values;
        namespaceLabels?: {
            [key: string]: any;
        };
        serviceAccountName?: string;
        serviceAccountPolicies?: IManagedPolicy[];
        teamManifestDir?: string;
        teamSecrets?: CsiSecretProps[];
        userRoleArn?: string;
        users?: ArnPrincipal[];
        extensionFunction?(team: ApplicationTeam, clusterInfo: ClusterInfo): void;
    }

    Hierarchy (view full)

    Properties

    computeResources +
    interface BatchEksTeamProps {
        computeResources: {
            allocationStrategy: BatchAllocationStrategy;
            envType: BatchEnvType;
            instanceTypes: string[];
            maxvCpus: number;
            minvCpus: number;
            priority: number;
        };
        envName: string;
        jobQueueName: string;
        name: string;
        namespace?: string;
        namespaceAnnotations?: {
            [key: string]: any;
        };
        namespaceHardLimits?: Values;
        namespaceLabels?: {
            [key: string]: any;
        };
        serviceAccountName?: string;
        serviceAccountPolicies?: IManagedPolicy[];
        teamManifestDir?: string;
        teamSecrets?: CsiSecretProps[];
        userRoleArn?: string;
        users?: ArnPrincipal[];
        extensionFunction?(team: ApplicationTeam, clusterInfo: ClusterInfo): void;
    }

    Hierarchy (view full)

    Properties

    computeResources envName jobQueueName name @@ -21,25 +21,25 @@
  • maxvCpus: number

    The maximum number of Amazon EC2 vCPUs that an environment can reach.

  • minvCpus: number

    The minimum number of Amazon EC2 vCPUs that an environment should maintain.

  • priority: number

    Priority of the job queue - priority is set in descending order

    -

    • envName

    envName: string

    Compute Environment name

    -

    jobQueueName

    jobQueueName: string

    Name of the Job Queue

    -

    Readonlyname

    name: string

    Required unique name for organization. +

    envName

    envName: string

    Compute Environment name

    +

    jobQueueName

    jobQueueName: string

    Name of the Job Queue

    +

    Readonlyname

    name: string

    Required unique name for organization. May map to an OU name.

    -

    Optional Readonlynamespace

    namespace?: string

    Defaults to team name prefixed by "team-"

    -

    Optional ReadonlynamespaceAnnotations

    namespaceAnnotations?: {
        [key: string]: any;
    } = ...

    Annotations such as necessary for GitOps engine.

    -

    Optional ReadonlynamespaceHardLimits

    namespaceHardLimits?: Values = ...

    Optional, but highly recommended setting to ensure predictable demands.

    -

    Optional ReadonlynamespaceLabels

    namespaceLabels?: {
        [key: string]: any;
    }

    Labels such as necessary for AWS AppMesh

    -

    Optional ReadonlyserviceAccountName

    serviceAccountName?: string

    Service Account Name

    -

    Optional ReadonlyserviceAccountPolicies

    serviceAccountPolicies?: IManagedPolicy[]

    If specified, the IRSA account will be created for with the IRSA role +

    Optional Readonlynamespace

    namespace?: string

    Defaults to team name prefixed by "team-"

    +

    Optional ReadonlynamespaceAnnotations

    namespaceAnnotations?: {
        [key: string]: any;
    } = ...

    Annotations such as necessary for GitOps engine.

    +

    Optional ReadonlynamespaceHardLimits

    namespaceHardLimits?: Values = ...

    Optional, but highly recommended setting to ensure predictable demands.

    +

    Optional ReadonlynamespaceLabels

    namespaceLabels?: {
        [key: string]: any;
    }

    Labels such as necessary for AWS AppMesh

    +

    Optional ReadonlyserviceAccountName

    serviceAccountName?: string

    Service Account Name

    +

    Optional ReadonlyserviceAccountPolicies

    serviceAccountPolicies?: IManagedPolicy[]

    If specified, the IRSA account will be created for with the IRSA role having the specified managed policies.

    Example

    serviceAccountPolicies: [ManagedPolicy.fromAwsManagedPolicyName("")]
    -

    Optional ReadonlyteamManifestDir

    teamManifestDir?: string

    Optional, directory where a team's manifests are stored

    -

    Optional ReadonlyteamSecrets

    teamSecrets?: CsiSecretProps[]

    Team Secrets

    -

    Optional ReadonlyuserRoleArn

    userRoleArn?: string

    Options existing role that should be used for cluster access. +

    Optional ReadonlyteamManifestDir

    teamManifestDir?: string

    Optional, directory where a team's manifests are stored

    +

    Optional ReadonlyteamSecrets

    teamSecrets?: CsiSecretProps[]

    Team Secrets

    +

    Optional ReadonlyuserRoleArn

    userRoleArn?: string

    Options existing role that should be used for cluster access. If userRole and users are not provided, then no IAM setup is performed.

    -

    Optional Readonlyusers

    users?: ArnPrincipal[]

    Team members who need to get access to the cluster

    -

    Methods

    OptionalextensionFunction

    Optional Readonlyusers

    users?: ArnPrincipal[]

    Team members who need to get access to the cluster

    +

    Methods

    OptionalextensionFunction

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    \ No newline at end of file diff --git a/api/interfaces/teams.BedrockTeamProps.html b/api/interfaces/teams.BedrockTeamProps.html index 61166e880..5c2efc0cb 100644 --- a/api/interfaces/teams.BedrockTeamProps.html +++ b/api/interfaces/teams.BedrockTeamProps.html @@ -1,5 +1,5 @@ BedrockTeamProps | @aws-quickstart/eks-blueprints

    Interface BedrockTeamProps

    Interface to define a GenAI on EKS team

    -
    interface BedrockTeamProps {
        createNamespace?: boolean;
        name: string;
        namespace?: string;
        namespaceAnnotations?: {
            [key: string]: any;
        };
        namespaceHardLimits?: Values;
        namespaceLabels?: {
            [key: string]: any;
        };
        serviceAccountName?: string;
        serviceAccountPolicies?: IManagedPolicy[];
        teamManifestDir?: string;
        teamSecrets?: CsiSecretProps[];
        userRoleArn?: string;
        users?: ArnPrincipal[];
        extensionFunction?(team: ApplicationTeam, clusterInfo: ClusterInfo): void;
    }

    Hierarchy (view full)

    Properties

    createNamespace? +
    interface BedrockTeamProps {
        createNamespace?: boolean;
        name: string;
        namespace?: string;
        namespaceAnnotations?: {
            [key: string]: any;
        };
        namespaceHardLimits?: Values;
        namespaceLabels?: {
            [key: string]: any;
        };
        serviceAccountName?: string;
        serviceAccountPolicies?: IManagedPolicy[];
        teamManifestDir?: string;
        teamSecrets?: CsiSecretProps[];
        userRoleArn?: string;
        users?: ArnPrincipal[];
        extensionFunction?(team: ApplicationTeam, clusterInfo: ClusterInfo): void;
    }

    Hierarchy (view full)

    Properties

    createNamespace? name namespace? namespaceAnnotations? @@ -13,23 +13,23 @@ users?

    Methods

    extensionFunction?

    Properties

    OptionalcreateNamespace

    createNamespace?: boolean

    Create Namespace with the provided one.

    -

    Readonlyname

    name: string

    Required unique name for organization. +

    Readonlyname

    name: string

    Required unique name for organization. May map to an OU name.

    -

    Optionalnamespace

    namespace?: string

    Name of the service account namespace.

    -

    Optional ReadonlynamespaceAnnotations

    namespaceAnnotations?: {
        [key: string]: any;
    } = ...

    Annotations such as necessary for GitOps engine.

    -

    Optional ReadonlynamespaceHardLimits

    namespaceHardLimits?: Values = ...

    Optional, but highly recommended setting to ensure predictable demands.

    -

    Optional ReadonlynamespaceLabels

    namespaceLabels?: {
        [key: string]: any;
    }

    Labels such as necessary for AWS AppMesh

    -

    OptionalserviceAccountName

    serviceAccountName?: string

    Name of the service account for Bedrock.

    -

    Optional ReadonlyserviceAccountPolicies

    serviceAccountPolicies?: IManagedPolicy[]

    If specified, the IRSA account will be created for with the IRSA role +

    Optionalnamespace

    namespace?: string

    Name of the service account namespace.

    +

    Optional ReadonlynamespaceAnnotations

    namespaceAnnotations?: {
        [key: string]: any;
    } = ...

    Annotations such as necessary for GitOps engine.

    +

    Optional ReadonlynamespaceHardLimits

    namespaceHardLimits?: Values = ...

    Optional, but highly recommended setting to ensure predictable demands.

    +

    Optional ReadonlynamespaceLabels

    namespaceLabels?: {
        [key: string]: any;
    }

    Labels such as necessary for AWS AppMesh

    +

    OptionalserviceAccountName

    serviceAccountName?: string

    Name of the service account for Bedrock.

    +

    Optional ReadonlyserviceAccountPolicies

    serviceAccountPolicies?: IManagedPolicy[]

    If specified, the IRSA account will be created for with the IRSA role having the specified managed policies.

    Example

    serviceAccountPolicies: [ManagedPolicy.fromAwsManagedPolicyName("")]
    -

    Optional ReadonlyteamManifestDir

    teamManifestDir?: string

    Optional, directory where a team's manifests are stored

    -

    Optional ReadonlyteamSecrets

    teamSecrets?: CsiSecretProps[]

    Team Secrets

    -

    Optional ReadonlyuserRoleArn

    userRoleArn?: string

    Options existing role that should be used for cluster access. +

    Optional ReadonlyteamManifestDir

    teamManifestDir?: string

    Optional, directory where a team's manifests are stored

    +

    Optional ReadonlyteamSecrets

    teamSecrets?: CsiSecretProps[]

    Team Secrets

    +

    Optional ReadonlyuserRoleArn

    userRoleArn?: string

    Options existing role that should be used for cluster access. If userRole and users are not provided, then no IAM setup is performed.

    -

    Optional Readonlyusers

    users?: ArnPrincipal[]

    Team members who need to get access to the cluster

    -

    Methods

    OptionalextensionFunction

    Optional Readonlyusers

    users?: ArnPrincipal[]

    Team members who need to get access to the cluster

    +

    Methods

    OptionalextensionFunction

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    \ No newline at end of file diff --git a/api/interfaces/teams.EmrEksTeamProps.html b/api/interfaces/teams.EmrEksTeamProps.html index 2258b1826..126473e73 100644 --- a/api/interfaces/teams.EmrEksTeamProps.html +++ b/api/interfaces/teams.EmrEksTeamProps.html @@ -1,5 +1,5 @@ EmrEksTeamProps | @aws-quickstart/eks-blueprints

    Interface EmrEksTeamProps

    Interface to define a EMR on EKS team

    -
    interface EmrEksTeamProps {
        createNamespace: boolean;
        executionRoles: ExecutionRoleDefinition[];
        name: string;
        namespace?: string;
        namespaceAnnotations?: {
            [key: string]: any;
        };
        namespaceHardLimits?: Values;
        namespaceLabels?: {
            [key: string]: any;
        };
        serviceAccountName?: string;
        serviceAccountPolicies?: IManagedPolicy[];
        teamManifestDir?: string;
        teamSecrets?: CsiSecretProps[];
        userRoleArn?: string;
        users?: ArnPrincipal[];
        virtualClusterName: string;
        virtualClusterNamespace: string;
        virtualClusterTags?: CfnTag[];
        extensionFunction?(team: ApplicationTeam, clusterInfo: ClusterInfo): void;
    }

    Hierarchy (view full)

    Properties

    createNamespace +
    interface EmrEksTeamProps {
        createNamespace: boolean;
        executionRoles: ExecutionRoleDefinition[];
        name: string;
        namespace?: string;
        namespaceAnnotations?: {
            [key: string]: any;
        };
        namespaceHardLimits?: Values;
        namespaceLabels?: {
            [key: string]: any;
        };
        serviceAccountName?: string;
        serviceAccountPolicies?: IManagedPolicy[];
        teamManifestDir?: string;
        teamSecrets?: CsiSecretProps[];
        userRoleArn?: string;
        users?: ArnPrincipal[];
        virtualClusterName: string;
        virtualClusterNamespace: string;
        virtualClusterTags?: CfnTag[];
        extensionFunction?(team: ApplicationTeam, clusterInfo: ClusterInfo): void;
    }

    Hierarchy (view full)

    Properties

    createNamespace executionRoles name namespace? @@ -17,25 +17,25 @@ virtualClusterTags?

    Methods

    extensionFunction?

    Properties

    createNamespace

    createNamespace: boolean

    To define if the namespace that team will use need to be created

    -

    executionRoles

    executionRoles: ExecutionRoleDefinition[]

    List of execution role to associated with the VC namespace ExecutionRoleDefinition

    -

    Readonlyname

    name: string

    Required unique name for organization. +

    executionRoles

    executionRoles: ExecutionRoleDefinition[]

    List of execution role to associated with the VC namespace ExecutionRoleDefinition

    +

    Readonlyname

    name: string

    Required unique name for organization. May map to an OU name.

    -

    Optional Readonlynamespace

    namespace?: string

    Defaults to team name prefixed by "team-"

    -

    Optional ReadonlynamespaceAnnotations

    namespaceAnnotations?: {
        [key: string]: any;
    } = ...

    Annotations such as necessary for GitOps engine.

    -

    Optional ReadonlynamespaceHardLimits

    namespaceHardLimits?: Values = ...

    Optional, but highly recommended setting to ensure predictable demands.

    -

    Optional ReadonlynamespaceLabels

    namespaceLabels?: {
        [key: string]: any;
    }

    Labels such as necessary for AWS AppMesh

    -

    Optional ReadonlyserviceAccountName

    serviceAccountName?: string

    Service Account Name

    -

    Optional ReadonlyserviceAccountPolicies

    serviceAccountPolicies?: IManagedPolicy[]

    If specified, the IRSA account will be created for with the IRSA role +

    Optional Readonlynamespace

    namespace?: string

    Defaults to team name prefixed by "team-"

    +

    Optional ReadonlynamespaceAnnotations

    namespaceAnnotations?: {
        [key: string]: any;
    } = ...

    Annotations such as necessary for GitOps engine.

    +

    Optional ReadonlynamespaceHardLimits

    namespaceHardLimits?: Values = ...

    Optional, but highly recommended setting to ensure predictable demands.

    +

    Optional ReadonlynamespaceLabels

    namespaceLabels?: {
        [key: string]: any;
    }

    Labels such as necessary for AWS AppMesh

    +

    Optional ReadonlyserviceAccountName

    serviceAccountName?: string

    Service Account Name

    +

    Optional ReadonlyserviceAccountPolicies

    serviceAccountPolicies?: IManagedPolicy[]

    If specified, the IRSA account will be created for with the IRSA role having the specified managed policies.

    Example

    serviceAccountPolicies: [ManagedPolicy.fromAwsManagedPolicyName("")]
    -

    Optional ReadonlyteamManifestDir

    teamManifestDir?: string

    Optional, directory where a team's manifests are stored

    -

    Optional ReadonlyteamSecrets

    teamSecrets?: CsiSecretProps[]

    Team Secrets

    -

    Optional ReadonlyuserRoleArn

    userRoleArn?: string

    Options existing role that should be used for cluster access. +

    Optional ReadonlyteamManifestDir

    teamManifestDir?: string

    Optional, directory where a team's manifests are stored

    +

    Optional ReadonlyteamSecrets

    teamSecrets?: CsiSecretProps[]

    Team Secrets

    +

    Optional ReadonlyuserRoleArn

    userRoleArn?: string

    Options existing role that should be used for cluster access. If userRole and users are not provided, then no IAM setup is performed.

    -

    Optional Readonlyusers

    users?: ArnPrincipal[]

    Team members who need to get access to the cluster

    -

    virtualClusterName

    virtualClusterName: string

    virtualClusterNamespace

    virtualClusterNamespace: string

    OptionalvirtualClusterTags

    virtualClusterTags?: CfnTag[]

    Tags to apply to EMR on EKS Virtual Cluster

    -

    Methods

    OptionalextensionFunction

    Optional Readonlyusers

    users?: ArnPrincipal[]

    Team members who need to get access to the cluster

    +

    virtualClusterName

    virtualClusterName: string

    virtualClusterNamespace

    virtualClusterNamespace: string

    OptionalvirtualClusterTags

    virtualClusterTags?: CfnTag[]

    Tags to apply to EMR on EKS Virtual Cluster

    +

    Methods

    OptionalextensionFunction

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    \ No newline at end of file diff --git a/api/interfaces/teams.ExecutionRoleDefinition.html b/api/interfaces/teams.ExecutionRoleDefinition.html index 48c950f3a..b6ce4ae8b 100644 --- a/api/interfaces/teams.ExecutionRoleDefinition.html +++ b/api/interfaces/teams.ExecutionRoleDefinition.html @@ -1,11 +1,11 @@ ExecutionRoleDefinition | @aws-quickstart/eks-blueprints

    Interface ExecutionRoleDefinition

    Interface define the object to create an execution role

    -
    interface ExecutionRoleDefinition {
        excutionRoleIamPolicy?: IManagedPolicy;
        executionRoleIamPolicyStatement?: PolicyStatement[];
        executionRoleName: string;
    }

    Properties

    excutionRoleIamPolicy? +
    interface ExecutionRoleDefinition {
        excutionRoleIamPolicy?: IManagedPolicy;
        executionRoleIamPolicyStatement?: PolicyStatement[];
        executionRoleName: string;
    }

    Properties

    excutionRoleIamPolicy? executionRoleIamPolicyStatement? executionRoleName

    Properties

    OptionalexcutionRoleIamPolicy

    excutionRoleIamPolicy?: IManagedPolicy

    The IAM policy to use with IAM role if it already exists Can be initialized for example by fromPolicyName in Policy class

    -

    OptionalexecutionRoleIamPolicyStatement

    executionRoleIamPolicyStatement?: PolicyStatement[]

    Takes an array of IAM Policy Statement, you should pass this +

    OptionalexecutionRoleIamPolicyStatement

    executionRoleIamPolicyStatement?: PolicyStatement[]

    Takes an array of IAM Policy Statement, you should pass this if you want the Team to create the policy along the IAM role

    -

    executionRoleName

    executionRoleName: string

    The name of the IAM role to create, this name is used as base for the excution Role name +

    executionRoleName

    executionRoleName: string

    The name of the IAM role to create, this name is used as base for the excution Role name The name will have the following format after deployment: NAME-AWS-REGION-EKS-CLUSTER-NAME.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Properties
    \ No newline at end of file diff --git a/api/interfaces/utils.Constraint.html b/api/interfaces/utils.Constraint.html index 7242d199f..2cf648d82 100644 --- a/api/interfaces/utils.Constraint.html +++ b/api/interfaces/utils.Constraint.html @@ -1,3 +1,3 @@ Constraint | @aws-quickstart/eks-blueprints

    Interface Constraint

    This is interface for the constraints needed to test asking for the key name of the object, the value being tested, and context for detailed Zod errors.

    -
    interface Constraint {
        validate(key: string, value: any, identifier: string): any;
    }

    Implemented by

    Methods

    validate -

    Methods

    validate

    Settings

    Member Visibility

    On This Page

    Methods
    \ No newline at end of file +
    interface Constraint {
        validate(key: string, value: any, identifier: string): any;
    }

    Implemented by

    Methods

    validate +

    Methods

    validate

    Settings

    Member Visibility

    On This Page

    Methods
    \ No newline at end of file diff --git a/api/media/readme-internal/index.html b/api/media/readme-internal/index.html index 522a6ecf1..ea7dd0599 100644 --- a/api/media/readme-internal/index.html +++ b/api/media/readme-internal/index.html @@ -10,9 +10,8 @@ - - + @@ -20,15 +19,12 @@ - + - - - @@ -52,6 +48,9 @@ + + + @@ -81,7 +80,6 @@
    @@ -102,12 +100,8 @@
    - - -

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/types/pipelines.PipelineProps.html b/api/types/pipelines.PipelineProps.html index 0c6751f4c..8ba1b91f3 100644 --- a/api/types/pipelines.PipelineProps.html +++ b/api/types/pipelines.PipelineProps.html @@ -10,4 +10,4 @@
  • repository: GitHubSourceRepository | CodeCommitSourceRepository | CodeStarConnectionRepository

    Repository for the pipeline (GitHub or CodeCommitRepository).

  • stages: WaveStage[]

    Pipeline stages and options.

  • waves: PipelineWave[]

    Waves for the pipeline. Stages inside the wave are executed in parallel.

    -

    • Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/types/utils.ConstraintsType.html b/api/types/utils.ConstraintsType.html index 183800c4b..553889504 100644 --- a/api/types/utils.ConstraintsType.html +++ b/api/types/utils.ConstraintsType.html @@ -1,2 +1,2 @@ ConstraintsType | @aws-quickstart/eks-blueprints

    Type Alias ConstraintsType<T>

    ConstraintsType<T>: Partial<Record<keyof T, Constraint>>

    The type that derives from a generic input structure, retaining the keys. Enables to define mapping between the input structure keys and constraints.

    -

    Type Parameters

    • T

    Settings

    Member Visibility
    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/types/utils.OneArgFn.html b/api/types/utils.OneArgFn.html index d16d87b90..7df85c800 100644 --- a/api/types/utils.OneArgFn.html +++ b/api/types/utils.OneArgFn.html @@ -1 +1 @@ -OneArgFn | @aws-quickstart/eks-blueprints

    Type Alias OneArgFn<T>

    OneArgFn<T>: ((arg: any) => T)

    Type Parameters

    • T

    Settings

    Member Visibility
    \ No newline at end of file +OneArgFn | @aws-quickstart/eks-blueprints

    Type Alias OneArgFn<T>

    OneArgFn<T>: ((arg: any) => T)

    Type Parameters

    • T

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/types/utils.Writeable.html b/api/types/utils.Writeable.html index 815d84d4d..e9a9c0772 100644 --- a/api/types/utils.Writeable.html +++ b/api/types/utils.Writeable.html @@ -1 +1 @@ -Writeable | @aws-quickstart/eks-blueprints

    Type Alias Writeable<T>

    Writeable<T>: {
        -readonly [P in keyof T]: T[P]
    }

    Type Parameters

    • T

    Settings

    Member Visibility
    \ No newline at end of file +Writeable | @aws-quickstart/eks-blueprints

    Type Alias Writeable<T>

    Writeable<T>: {
        -readonly [P in keyof T]: T[P]
    }

    Type Parameters

    • T

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/variables/addons.ISTIO_VERSION.html b/api/variables/addons.ISTIO_VERSION.html index f5acbeb4e..851c7fbfb 100644 --- a/api/variables/addons.ISTIO_VERSION.html +++ b/api/variables/addons.ISTIO_VERSION.html @@ -1 +1 @@ -ISTIO_VERSION | @aws-quickstart/eks-blueprints

    Variable ISTIO_VERSIONConst

    ISTIO_VERSION: "1.22.2" = "1.22.2"

    Settings

    Member Visibility
    \ No newline at end of file +ISTIO_VERSION | @aws-quickstart/eks-blueprints

    Variable ISTIO_VERSIONConst

    ISTIO_VERSION: "1.22.2" = "1.22.2"

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/variables/addons.serviceMappings.html b/api/variables/addons.serviceMappings.html index bac77e8d6..5734c9ed2 100644 --- a/api/variables/addons.serviceMappings.html +++ b/api/variables/addons.serviceMappings.html @@ -1,3 +1,3 @@ serviceMappings | @aws-quickstart/eks-blueprints

    Variable serviceMappingsConst

    serviceMappings: {
        [key in AckServiceName]?: AckChartMapping
    } = ...

    List of all Service Mappings such as chart, version, managed IAM policy for all supported AWS services by ACK Addon.

    -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/variables/clusters.defaultOptions.html b/api/variables/clusters.defaultOptions.html index a42066785..e4173c59e 100644 --- a/api/variables/clusters.defaultOptions.html +++ b/api/variables/clusters.defaultOptions.html @@ -1 +1 @@ -defaultOptions | @aws-quickstart/eks-blueprints

    Variable defaultOptionsConst

    defaultOptions: {} = {}

    Settings

    Member Visibility
    \ No newline at end of file +defaultOptions | @aws-quickstart/eks-blueprints

    Variable defaultOptionsConst

    defaultOptions: {} = {}

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/variables/pipelines.DEFAULT_BUILD_POLICIES.html b/api/variables/pipelines.DEFAULT_BUILD_POLICIES.html index fccf8f5e8..5658d388b 100644 --- a/api/variables/pipelines.DEFAULT_BUILD_POLICIES.html +++ b/api/variables/pipelines.DEFAULT_BUILD_POLICIES.html @@ -3,4 +3,4 @@ Not recommended for production. For production use case, CodeBuild policies must be restricted to particular resources. Outbound access from the build should be controlled by ACL.

    -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/variables/stacks.DEFAULT_VERSION.html b/api/variables/stacks.DEFAULT_VERSION.html index f8a331ddf..c9a525737 100644 --- a/api/variables/stacks.DEFAULT_VERSION.html +++ b/api/variables/stacks.DEFAULT_VERSION.html @@ -1 +1 @@ -DEFAULT_VERSION | @aws-quickstart/eks-blueprints

    Variable DEFAULT_VERSIONConst

    DEFAULT_VERSION: KubernetesVersion = KubernetesVersion.V1_29

    Settings

    Member Visibility
    \ No newline at end of file +DEFAULT_VERSION | @aws-quickstart/eks-blueprints

    Variable DEFAULT_VERSIONConst

    DEFAULT_VERSION: KubernetesVersion = KubernetesVersion.V1_29

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/variables/utils.addonArchitectureMap.html b/api/variables/utils.addonArchitectureMap.html index 00679c1d1..441489a0e 100644 --- a/api/variables/utils.addonArchitectureMap.html +++ b/api/variables/utils.addonArchitectureMap.html @@ -1 +1 @@ -addonArchitectureMap | @aws-quickstart/eks-blueprints

    Variable addonArchitectureMapConst

    addonArchitectureMap: Map<string, ArchType[]> = ...

    Settings

    Member Visibility
    \ No newline at end of file +addonArchitectureMap | @aws-quickstart/eks-blueprints

    Variable addonArchitectureMapConst

    addonArchitectureMap: Map<string, ArchType[]> = ...

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/variables/utils.isDynamicProxy.html b/api/variables/utils.isDynamicProxy.html index 9405e51c4..656575635 100644 --- a/api/variables/utils.isDynamicProxy.html +++ b/api/variables/utils.isDynamicProxy.html @@ -1,2 +1,2 @@ isDynamicProxy | @aws-quickstart/eks-blueprints

    Variable isDynamicProxyConst

    isDynamicProxy: typeof isDynamicProxy = ...

    Symbol that uniquely designates that a particular proxy is instance of our DummyProxy

    -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/variables/utils.logger.html b/api/variables/utils.logger.html index 9335c0072..57b9aab06 100644 --- a/api/variables/utils.logger.html +++ b/api/variables/utils.logger.html @@ -1,2 +1,2 @@ logger | @aws-quickstart/eks-blueprints

    Variable loggerConst

    logger: Logger<unknown> = ...

    Standard developer logger for troubleshooting. Will leverage sourcemap support.

    -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/variables/utils.registries.html b/api/variables/utils.registries.html index f98034a92..523b3264f 100644 --- a/api/variables/utils.registries.html +++ b/api/variables/utils.registries.html @@ -1 +1 @@ -registries | @aws-quickstart/eks-blueprints

    Variable registriesConst

    registries: Map<string, string> = ...

    Settings

    Member Visibility
    \ No newline at end of file +registries | @aws-quickstart/eks-blueprints

    Variable registriesConst

    registries: Map<string, string> = ...

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/variables/utils.sourceFunction.html b/api/variables/utils.sourceFunction.html index 58e5ea36d..ea9bf2bee 100644 --- a/api/variables/utils.sourceFunction.html +++ b/api/variables/utils.sourceFunction.html @@ -1,2 +1,2 @@ sourceFunction | @aws-quickstart/eks-blueprints

    Variable sourceFunctionConst

    sourceFunction: typeof sourceFunction = ...

    Symbol that retrieves the source function from the proxy. This function is expected to create the required target (e.g. resource).

    -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/api/variables/utils.userLog.html b/api/variables/utils.userLog.html index d1a87689e..0f5598fdf 100644 --- a/api/variables/utils.userLog.html +++ b/api/variables/utils.userLog.html @@ -1,2 +1,2 @@ userLog | @aws-quickstart/eks-blueprints

    Variable userLogConst

    userLog: Logger<unknown> = ...

    User log is a logger for user info. Does not display callstack

    -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/assets/javascripts/bundle.b4d07000.min.js b/assets/javascripts/bundle.b4d07000.min.js new file mode 100644 index 000000000..3c0bdad9a --- /dev/null +++ b/assets/javascripts/bundle.b4d07000.min.js @@ -0,0 +1,29 @@ +"use strict";(()=>{var Ci=Object.create;var gr=Object.defineProperty;var Ri=Object.getOwnPropertyDescriptor;var ki=Object.getOwnPropertyNames,Ht=Object.getOwnPropertySymbols,Hi=Object.getPrototypeOf,yr=Object.prototype.hasOwnProperty,nn=Object.prototype.propertyIsEnumerable;var rn=(e,t,r)=>t in e?gr(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,P=(e,t)=>{for(var r in t||(t={}))yr.call(t,r)&&rn(e,r,t[r]);if(Ht)for(var r of Ht(t))nn.call(t,r)&&rn(e,r,t[r]);return e};var on=(e,t)=>{var r={};for(var n in e)yr.call(e,n)&&t.indexOf(n)<0&&(r[n]=e[n]);if(e!=null&&Ht)for(var n of Ht(e))t.indexOf(n)<0&&nn.call(e,n)&&(r[n]=e[n]);return r};var Pt=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var Pi=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of ki(t))!yr.call(e,o)&&o!==r&&gr(e,o,{get:()=>t[o],enumerable:!(n=Ri(t,o))||n.enumerable});return e};var yt=(e,t,r)=>(r=e!=null?Ci(Hi(e)):{},Pi(t||!e||!e.__esModule?gr(r,"default",{value:e,enumerable:!0}):r,e));var sn=Pt((xr,an)=>{(function(e,t){typeof xr=="object"&&typeof an!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(xr,function(){"use strict";function e(r){var n=!0,o=!1,i=null,s={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function a(O){return!!(O&&O!==document&&O.nodeName!=="HTML"&&O.nodeName!=="BODY"&&"classList"in O&&"contains"in O.classList)}function f(O){var Qe=O.type,De=O.tagName;return!!(De==="INPUT"&&s[Qe]&&!O.readOnly||De==="TEXTAREA"&&!O.readOnly||O.isContentEditable)}function c(O){O.classList.contains("focus-visible")||(O.classList.add("focus-visible"),O.setAttribute("data-focus-visible-added",""))}function u(O){O.hasAttribute("data-focus-visible-added")&&(O.classList.remove("focus-visible"),O.removeAttribute("data-focus-visible-added"))}function p(O){O.metaKey||O.altKey||O.ctrlKey||(a(r.activeElement)&&c(r.activeElement),n=!0)}function m(O){n=!1}function d(O){a(O.target)&&(n||f(O.target))&&c(O.target)}function h(O){a(O.target)&&(O.target.classList.contains("focus-visible")||O.target.hasAttribute("data-focus-visible-added"))&&(o=!0,window.clearTimeout(i),i=window.setTimeout(function(){o=!1},100),u(O.target))}function v(O){document.visibilityState==="hidden"&&(o&&(n=!0),Y())}function Y(){document.addEventListener("mousemove",N),document.addEventListener("mousedown",N),document.addEventListener("mouseup",N),document.addEventListener("pointermove",N),document.addEventListener("pointerdown",N),document.addEventListener("pointerup",N),document.addEventListener("touchmove",N),document.addEventListener("touchstart",N),document.addEventListener("touchend",N)}function B(){document.removeEventListener("mousemove",N),document.removeEventListener("mousedown",N),document.removeEventListener("mouseup",N),document.removeEventListener("pointermove",N),document.removeEventListener("pointerdown",N),document.removeEventListener("pointerup",N),document.removeEventListener("touchmove",N),document.removeEventListener("touchstart",N),document.removeEventListener("touchend",N)}function N(O){O.target.nodeName&&O.target.nodeName.toLowerCase()==="html"||(n=!1,B())}document.addEventListener("keydown",p,!0),document.addEventListener("mousedown",m,!0),document.addEventListener("pointerdown",m,!0),document.addEventListener("touchstart",m,!0),document.addEventListener("visibilitychange",v,!0),Y(),r.addEventListener("focus",d,!0),r.addEventListener("blur",h,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var cn=Pt(Er=>{(function(e){var t=function(){try{return!!Symbol.iterator}catch(c){return!1}},r=t(),n=function(c){var u={next:function(){var p=c.shift();return{done:p===void 0,value:p}}};return r&&(u[Symbol.iterator]=function(){return u}),u},o=function(c){return encodeURIComponent(c).replace(/%20/g,"+")},i=function(c){return decodeURIComponent(String(c).replace(/\+/g," "))},s=function(){var c=function(p){Object.defineProperty(this,"_entries",{writable:!0,value:{}});var m=typeof p;if(m!=="undefined")if(m==="string")p!==""&&this._fromString(p);else if(p instanceof c){var d=this;p.forEach(function(B,N){d.append(N,B)})}else if(p!==null&&m==="object")if(Object.prototype.toString.call(p)==="[object Array]")for(var h=0;hd[0]?1:0}),c._entries&&(c._entries={});for(var p=0;p1?i(d[1]):"")}})})(typeof global!="undefined"?global:typeof window!="undefined"?window:typeof self!="undefined"?self:Er);(function(e){var t=function(){try{var o=new e.URL("b","http://a");return o.pathname="c d",o.href==="http://a/c%20d"&&o.searchParams}catch(i){return!1}},r=function(){var o=e.URL,i=function(f,c){typeof f!="string"&&(f=String(f)),c&&typeof c!="string"&&(c=String(c));var u=document,p;if(c&&(e.location===void 0||c!==e.location.href)){c=c.toLowerCase(),u=document.implementation.createHTMLDocument(""),p=u.createElement("base"),p.href=c,u.head.appendChild(p);try{if(p.href.indexOf(c)!==0)throw new Error(p.href)}catch(O){throw new Error("URL unable to set base "+c+" due to "+O)}}var m=u.createElement("a");m.href=f,p&&(u.body.appendChild(m),m.href=m.href);var d=u.createElement("input");if(d.type="url",d.value=f,m.protocol===":"||!/:/.test(m.href)||!d.checkValidity()&&!c)throw new TypeError("Invalid URL");Object.defineProperty(this,"_anchorElement",{value:m});var h=new e.URLSearchParams(this.search),v=!0,Y=!0,B=this;["append","delete","set"].forEach(function(O){var Qe=h[O];h[O]=function(){Qe.apply(h,arguments),v&&(Y=!1,B.search=h.toString(),Y=!0)}}),Object.defineProperty(this,"searchParams",{value:h,enumerable:!0});var N=void 0;Object.defineProperty(this,"_updateSearchParams",{enumerable:!1,configurable:!1,writable:!1,value:function(){this.search!==N&&(N=this.search,Y&&(v=!1,this.searchParams._fromString(this.search),v=!0))}})},s=i.prototype,a=function(f){Object.defineProperty(s,f,{get:function(){return this._anchorElement[f]},set:function(c){this._anchorElement[f]=c},enumerable:!0})};["hash","host","hostname","port","protocol"].forEach(function(f){a(f)}),Object.defineProperty(s,"search",{get:function(){return this._anchorElement.search},set:function(f){this._anchorElement.search=f,this._updateSearchParams()},enumerable:!0}),Object.defineProperties(s,{toString:{get:function(){var f=this;return function(){return f.href}}},href:{get:function(){return this._anchorElement.href.replace(/\?$/,"")},set:function(f){this._anchorElement.href=f,this._updateSearchParams()},enumerable:!0},pathname:{get:function(){return this._anchorElement.pathname.replace(/(^\/?)/,"/")},set:function(f){this._anchorElement.pathname=f},enumerable:!0},origin:{get:function(){var f={"http:":80,"https:":443,"ftp:":21}[this._anchorElement.protocol],c=this._anchorElement.port!=f&&this._anchorElement.port!=="";return this._anchorElement.protocol+"//"+this._anchorElement.hostname+(c?":"+this._anchorElement.port:"")},enumerable:!0},password:{get:function(){return""},set:function(f){},enumerable:!0},username:{get:function(){return""},set:function(f){},enumerable:!0}}),i.createObjectURL=function(f){return o.createObjectURL.apply(o,arguments)},i.revokeObjectURL=function(f){return o.revokeObjectURL.apply(o,arguments)},e.URL=i};if(t()||r(),e.location!==void 0&&!("origin"in e.location)){var n=function(){return e.location.protocol+"//"+e.location.hostname+(e.location.port?":"+e.location.port:"")};try{Object.defineProperty(e.location,"origin",{get:n,enumerable:!0})}catch(o){setInterval(function(){e.location.origin=n()},100)}}})(typeof global!="undefined"?global:typeof window!="undefined"?window:typeof self!="undefined"?self:Er)});var qr=Pt((Mt,Nr)=>{/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */(function(t,r){typeof Mt=="object"&&typeof Nr=="object"?Nr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof Mt=="object"?Mt.ClipboardJS=r():t.ClipboardJS=r()})(Mt,function(){return function(){var e={686:function(n,o,i){"use strict";i.d(o,{default:function(){return Ai}});var s=i(279),a=i.n(s),f=i(370),c=i.n(f),u=i(817),p=i.n(u);function m(j){try{return document.execCommand(j)}catch(T){return!1}}var d=function(T){var E=p()(T);return m("cut"),E},h=d;function v(j){var T=document.documentElement.getAttribute("dir")==="rtl",E=document.createElement("textarea");E.style.fontSize="12pt",E.style.border="0",E.style.padding="0",E.style.margin="0",E.style.position="absolute",E.style[T?"right":"left"]="-9999px";var H=window.pageYOffset||document.documentElement.scrollTop;return E.style.top="".concat(H,"px"),E.setAttribute("readonly",""),E.value=j,E}var Y=function(T,E){var H=v(T);E.container.appendChild(H);var I=p()(H);return m("copy"),H.remove(),I},B=function(T){var E=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},H="";return typeof T=="string"?H=Y(T,E):T instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(T==null?void 0:T.type)?H=Y(T.value,E):(H=p()(T),m("copy")),H},N=B;function O(j){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?O=function(E){return typeof E}:O=function(E){return E&&typeof Symbol=="function"&&E.constructor===Symbol&&E!==Symbol.prototype?"symbol":typeof E},O(j)}var Qe=function(){var T=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},E=T.action,H=E===void 0?"copy":E,I=T.container,q=T.target,Me=T.text;if(H!=="copy"&&H!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(q!==void 0)if(q&&O(q)==="object"&&q.nodeType===1){if(H==="copy"&&q.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(H==="cut"&&(q.hasAttribute("readonly")||q.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(Me)return N(Me,{container:I});if(q)return H==="cut"?h(q):N(q,{container:I})},De=Qe;function $e(j){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?$e=function(E){return typeof E}:$e=function(E){return E&&typeof Symbol=="function"&&E.constructor===Symbol&&E!==Symbol.prototype?"symbol":typeof E},$e(j)}function Ei(j,T){if(!(j instanceof T))throw new TypeError("Cannot call a class as a function")}function tn(j,T){for(var E=0;E0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof I.action=="function"?I.action:this.defaultAction,this.target=typeof I.target=="function"?I.target:this.defaultTarget,this.text=typeof I.text=="function"?I.text:this.defaultText,this.container=$e(I.container)==="object"?I.container:document.body}},{key:"listenClick",value:function(I){var q=this;this.listener=c()(I,"click",function(Me){return q.onClick(Me)})}},{key:"onClick",value:function(I){var q=I.delegateTarget||I.currentTarget,Me=this.action(q)||"copy",kt=De({action:Me,container:this.container,target:this.target(q),text:this.text(q)});this.emit(kt?"success":"error",{action:Me,text:kt,trigger:q,clearSelection:function(){q&&q.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(I){return vr("action",I)}},{key:"defaultTarget",value:function(I){var q=vr("target",I);if(q)return document.querySelector(q)}},{key:"defaultText",value:function(I){return vr("text",I)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(I){var q=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return N(I,q)}},{key:"cut",value:function(I){return h(I)}},{key:"isSupported",value:function(){var I=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],q=typeof I=="string"?[I]:I,Me=!!document.queryCommandSupported;return q.forEach(function(kt){Me=Me&&!!document.queryCommandSupported(kt)}),Me}}]),E}(a()),Ai=Li},828:function(n){var o=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function s(a,f){for(;a&&a.nodeType!==o;){if(typeof a.matches=="function"&&a.matches(f))return a;a=a.parentNode}}n.exports=s},438:function(n,o,i){var s=i(828);function a(u,p,m,d,h){var v=c.apply(this,arguments);return u.addEventListener(m,v,h),{destroy:function(){u.removeEventListener(m,v,h)}}}function f(u,p,m,d,h){return typeof u.addEventListener=="function"?a.apply(null,arguments):typeof m=="function"?a.bind(null,document).apply(null,arguments):(typeof u=="string"&&(u=document.querySelectorAll(u)),Array.prototype.map.call(u,function(v){return a(v,p,m,d,h)}))}function c(u,p,m,d){return function(h){h.delegateTarget=s(h.target,p),h.delegateTarget&&d.call(u,h)}}n.exports=f},879:function(n,o){o.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},o.nodeList=function(i){var s=Object.prototype.toString.call(i);return i!==void 0&&(s==="[object NodeList]"||s==="[object HTMLCollection]")&&"length"in i&&(i.length===0||o.node(i[0]))},o.string=function(i){return typeof i=="string"||i instanceof String},o.fn=function(i){var s=Object.prototype.toString.call(i);return s==="[object Function]"}},370:function(n,o,i){var s=i(879),a=i(438);function f(m,d,h){if(!m&&!d&&!h)throw new Error("Missing required arguments");if(!s.string(d))throw new TypeError("Second argument must be a String");if(!s.fn(h))throw new TypeError("Third argument must be a Function");if(s.node(m))return c(m,d,h);if(s.nodeList(m))return u(m,d,h);if(s.string(m))return p(m,d,h);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function c(m,d,h){return m.addEventListener(d,h),{destroy:function(){m.removeEventListener(d,h)}}}function u(m,d,h){return Array.prototype.forEach.call(m,function(v){v.addEventListener(d,h)}),{destroy:function(){Array.prototype.forEach.call(m,function(v){v.removeEventListener(d,h)})}}}function p(m,d,h){return a(document.body,m,d,h)}n.exports=f},817:function(n){function o(i){var s;if(i.nodeName==="SELECT")i.focus(),s=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var a=i.hasAttribute("readonly");a||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),a||i.removeAttribute("readonly"),s=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var f=window.getSelection(),c=document.createRange();c.selectNodeContents(i),f.removeAllRanges(),f.addRange(c),s=f.toString()}return s}n.exports=o},279:function(n){function o(){}o.prototype={on:function(i,s,a){var f=this.e||(this.e={});return(f[i]||(f[i]=[])).push({fn:s,ctx:a}),this},once:function(i,s,a){var f=this;function c(){f.off(i,c),s.apply(a,arguments)}return c._=s,this.on(i,c,a)},emit:function(i){var s=[].slice.call(arguments,1),a=((this.e||(this.e={}))[i]||[]).slice(),f=0,c=a.length;for(f;f{"use strict";/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var rs=/["'&<>]/;Yo.exports=ns;function ns(e){var t=""+e,r=rs.exec(t);if(!r)return t;var n,o="",i=0,s=0;for(i=r.index;i0&&i[i.length-1])&&(c[0]===6||c[0]===2)){r=0;continue}if(c[0]===3&&(!i||c[1]>i[0]&&c[1]=e.length&&(e=void 0),{value:e&&e[n++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function W(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var n=r.call(e),o,i=[],s;try{for(;(t===void 0||t-- >0)&&!(o=n.next()).done;)i.push(o.value)}catch(a){s={error:a}}finally{try{o&&!o.done&&(r=n.return)&&r.call(n)}finally{if(s)throw s.error}}return i}function D(e,t,r){if(r||arguments.length===2)for(var n=0,o=t.length,i;n1||a(m,d)})})}function a(m,d){try{f(n[m](d))}catch(h){p(i[0][3],h)}}function f(m){m.value instanceof et?Promise.resolve(m.value.v).then(c,u):p(i[0][2],m)}function c(m){a("next",m)}function u(m){a("throw",m)}function p(m,d){m(d),i.shift(),i.length&&a(i[0][0],i[0][1])}}function pn(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof Ee=="function"?Ee(e):e[Symbol.iterator](),r={},n("next"),n("throw"),n("return"),r[Symbol.asyncIterator]=function(){return this},r);function n(i){r[i]=e[i]&&function(s){return new Promise(function(a,f){s=e[i](s),o(a,f,s.done,s.value)})}}function o(i,s,a,f){Promise.resolve(f).then(function(c){i({value:c,done:a})},s)}}function C(e){return typeof e=="function"}function at(e){var t=function(n){Error.call(n),n.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var It=at(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +`+r.map(function(n,o){return o+1+") "+n.toString()}).join(` + `):"",this.name="UnsubscriptionError",this.errors=r}});function Ve(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Ie=function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,n,o,i;if(!this.closed){this.closed=!0;var s=this._parentage;if(s)if(this._parentage=null,Array.isArray(s))try{for(var a=Ee(s),f=a.next();!f.done;f=a.next()){var c=f.value;c.remove(this)}}catch(v){t={error:v}}finally{try{f&&!f.done&&(r=a.return)&&r.call(a)}finally{if(t)throw t.error}}else s.remove(this);var u=this.initialTeardown;if(C(u))try{u()}catch(v){i=v instanceof It?v.errors:[v]}var p=this._finalizers;if(p){this._finalizers=null;try{for(var m=Ee(p),d=m.next();!d.done;d=m.next()){var h=d.value;try{ln(h)}catch(v){i=i!=null?i:[],v instanceof It?i=D(D([],W(i)),W(v.errors)):i.push(v)}}}catch(v){n={error:v}}finally{try{d&&!d.done&&(o=m.return)&&o.call(m)}finally{if(n)throw n.error}}}if(i)throw new It(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)ln(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&Ve(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&Ve(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=function(){var t=new e;return t.closed=!0,t}(),e}();var Sr=Ie.EMPTY;function jt(e){return e instanceof Ie||e&&"closed"in e&&C(e.remove)&&C(e.add)&&C(e.unsubscribe)}function ln(e){C(e)?e():e.unsubscribe()}var Le={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var st={setTimeout:function(e,t){for(var r=[],n=2;n0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var n=this,o=this,i=o.hasError,s=o.isStopped,a=o.observers;return i||s?Sr:(this.currentObservers=null,a.push(r),new Ie(function(){n.currentObservers=null,Ve(a,r)}))},t.prototype._checkFinalizedStatuses=function(r){var n=this,o=n.hasError,i=n.thrownError,s=n.isStopped;o?r.error(i):s&&r.complete()},t.prototype.asObservable=function(){var r=new F;return r.source=this,r},t.create=function(r,n){return new xn(r,n)},t}(F);var xn=function(e){ie(t,e);function t(r,n){var o=e.call(this)||this;return o.destination=r,o.source=n,o}return t.prototype.next=function(r){var n,o;(o=(n=this.destination)===null||n===void 0?void 0:n.next)===null||o===void 0||o.call(n,r)},t.prototype.error=function(r){var n,o;(o=(n=this.destination)===null||n===void 0?void 0:n.error)===null||o===void 0||o.call(n,r)},t.prototype.complete=function(){var r,n;(n=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||n===void 0||n.call(r)},t.prototype._subscribe=function(r){var n,o;return(o=(n=this.source)===null||n===void 0?void 0:n.subscribe(r))!==null&&o!==void 0?o:Sr},t}(x);var Et={now:function(){return(Et.delegate||Date).now()},delegate:void 0};var wt=function(e){ie(t,e);function t(r,n,o){r===void 0&&(r=1/0),n===void 0&&(n=1/0),o===void 0&&(o=Et);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=n,i._timestampProvider=o,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=n===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,n),i}return t.prototype.next=function(r){var n=this,o=n.isStopped,i=n._buffer,s=n._infiniteTimeWindow,a=n._timestampProvider,f=n._windowTime;o||(i.push(r),!s&&i.push(a.now()+f)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var n=this._innerSubscribe(r),o=this,i=o._infiniteTimeWindow,s=o._buffer,a=s.slice(),f=0;f0?e.prototype.requestAsyncId.call(this,r,n,o):(r.actions.push(this),r._scheduled||(r._scheduled=ut.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,n,o){var i;if(o===void 0&&(o=0),o!=null?o>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,n,o);var s=r.actions;n!=null&&((i=s[s.length-1])===null||i===void 0?void 0:i.id)!==n&&(ut.cancelAnimationFrame(n),r._scheduled=void 0)},t}(Wt);var Sn=function(e){ie(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var n=this._scheduled;this._scheduled=void 0;var o=this.actions,i;r=r||o.shift();do if(i=r.execute(r.state,r.delay))break;while((r=o[0])&&r.id===n&&o.shift());if(this._active=!1,i){for(;(r=o[0])&&r.id===n&&o.shift();)r.unsubscribe();throw i}},t}(Dt);var Oe=new Sn(wn);var _=new F(function(e){return e.complete()});function Vt(e){return e&&C(e.schedule)}function Cr(e){return e[e.length-1]}function Ye(e){return C(Cr(e))?e.pop():void 0}function Te(e){return Vt(Cr(e))?e.pop():void 0}function zt(e,t){return typeof Cr(e)=="number"?e.pop():t}var pt=function(e){return e&&typeof e.length=="number"&&typeof e!="function"};function Nt(e){return C(e==null?void 0:e.then)}function qt(e){return C(e[ft])}function Kt(e){return Symbol.asyncIterator&&C(e==null?void 0:e[Symbol.asyncIterator])}function Qt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function zi(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var Yt=zi();function Gt(e){return C(e==null?void 0:e[Yt])}function Bt(e){return un(this,arguments,function(){var r,n,o,i;return $t(this,function(s){switch(s.label){case 0:r=e.getReader(),s.label=1;case 1:s.trys.push([1,,9,10]),s.label=2;case 2:return[4,et(r.read())];case 3:return n=s.sent(),o=n.value,i=n.done,i?[4,et(void 0)]:[3,5];case 4:return[2,s.sent()];case 5:return[4,et(o)];case 6:return[4,s.sent()];case 7:return s.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function Jt(e){return C(e==null?void 0:e.getReader)}function U(e){if(e instanceof F)return e;if(e!=null){if(qt(e))return Ni(e);if(pt(e))return qi(e);if(Nt(e))return Ki(e);if(Kt(e))return On(e);if(Gt(e))return Qi(e);if(Jt(e))return Yi(e)}throw Qt(e)}function Ni(e){return new F(function(t){var r=e[ft]();if(C(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function qi(e){return new F(function(t){for(var r=0;r=2;return function(n){return n.pipe(e?A(function(o,i){return e(o,i,n)}):de,ge(1),r?He(t):Dn(function(){return new Zt}))}}function Vn(){for(var e=[],t=0;t=2,!0))}function pe(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new x}:t,n=e.resetOnError,o=n===void 0?!0:n,i=e.resetOnComplete,s=i===void 0?!0:i,a=e.resetOnRefCountZero,f=a===void 0?!0:a;return function(c){var u,p,m,d=0,h=!1,v=!1,Y=function(){p==null||p.unsubscribe(),p=void 0},B=function(){Y(),u=m=void 0,h=v=!1},N=function(){var O=u;B(),O==null||O.unsubscribe()};return y(function(O,Qe){d++,!v&&!h&&Y();var De=m=m!=null?m:r();Qe.add(function(){d--,d===0&&!v&&!h&&(p=$r(N,f))}),De.subscribe(Qe),!u&&d>0&&(u=new rt({next:function($e){return De.next($e)},error:function($e){v=!0,Y(),p=$r(B,o,$e),De.error($e)},complete:function(){h=!0,Y(),p=$r(B,s),De.complete()}}),U(O).subscribe(u))})(c)}}function $r(e,t){for(var r=[],n=2;ne.next(document)),e}function K(e,t=document){return Array.from(t.querySelectorAll(e))}function z(e,t=document){let r=ce(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function ce(e,t=document){return t.querySelector(e)||void 0}function _e(){return document.activeElement instanceof HTMLElement&&document.activeElement||void 0}function tr(e){return L(b(document.body,"focusin"),b(document.body,"focusout")).pipe(ke(1),l(()=>{let t=_e();return typeof t!="undefined"?e.contains(t):!1}),V(e===_e()),J())}function Xe(e){return{x:e.offsetLeft,y:e.offsetTop}}function Kn(e){return L(b(window,"load"),b(window,"resize")).pipe(Ce(0,Oe),l(()=>Xe(e)),V(Xe(e)))}function rr(e){return{x:e.scrollLeft,y:e.scrollTop}}function dt(e){return L(b(e,"scroll"),b(window,"resize")).pipe(Ce(0,Oe),l(()=>rr(e)),V(rr(e)))}var Yn=function(){if(typeof Map!="undefined")return Map;function e(t,r){var n=-1;return t.some(function(o,i){return o[0]===r?(n=i,!0):!1}),n}return function(){function t(){this.__entries__=[]}return Object.defineProperty(t.prototype,"size",{get:function(){return this.__entries__.length},enumerable:!0,configurable:!0}),t.prototype.get=function(r){var n=e(this.__entries__,r),o=this.__entries__[n];return o&&o[1]},t.prototype.set=function(r,n){var o=e(this.__entries__,r);~o?this.__entries__[o][1]=n:this.__entries__.push([r,n])},t.prototype.delete=function(r){var n=this.__entries__,o=e(n,r);~o&&n.splice(o,1)},t.prototype.has=function(r){return!!~e(this.__entries__,r)},t.prototype.clear=function(){this.__entries__.splice(0)},t.prototype.forEach=function(r,n){n===void 0&&(n=null);for(var o=0,i=this.__entries__;o0},e.prototype.connect_=function(){!Wr||this.connected_||(document.addEventListener("transitionend",this.onTransitionEnd_),window.addEventListener("resize",this.refresh),va?(this.mutationsObserver_=new MutationObserver(this.refresh),this.mutationsObserver_.observe(document,{attributes:!0,childList:!0,characterData:!0,subtree:!0})):(document.addEventListener("DOMSubtreeModified",this.refresh),this.mutationEventsAdded_=!0),this.connected_=!0)},e.prototype.disconnect_=function(){!Wr||!this.connected_||(document.removeEventListener("transitionend",this.onTransitionEnd_),window.removeEventListener("resize",this.refresh),this.mutationsObserver_&&this.mutationsObserver_.disconnect(),this.mutationEventsAdded_&&document.removeEventListener("DOMSubtreeModified",this.refresh),this.mutationsObserver_=null,this.mutationEventsAdded_=!1,this.connected_=!1)},e.prototype.onTransitionEnd_=function(t){var r=t.propertyName,n=r===void 0?"":r,o=ba.some(function(i){return!!~n.indexOf(i)});o&&this.refresh()},e.getInstance=function(){return this.instance_||(this.instance_=new e),this.instance_},e.instance_=null,e}(),Gn=function(e,t){for(var r=0,n=Object.keys(t);r0},e}(),Jn=typeof WeakMap!="undefined"?new WeakMap:new Yn,Xn=function(){function e(t){if(!(this instanceof e))throw new TypeError("Cannot call a class as a function.");if(!arguments.length)throw new TypeError("1 argument required, but only 0 present.");var r=ga.getInstance(),n=new La(t,r,this);Jn.set(this,n)}return e}();["observe","unobserve","disconnect"].forEach(function(e){Xn.prototype[e]=function(){var t;return(t=Jn.get(this))[e].apply(t,arguments)}});var Aa=function(){return typeof nr.ResizeObserver!="undefined"?nr.ResizeObserver:Xn}(),Zn=Aa;var eo=new x,Ca=$(()=>k(new Zn(e=>{for(let t of e)eo.next(t)}))).pipe(g(e=>L(ze,k(e)).pipe(R(()=>e.disconnect()))),X(1));function he(e){return{width:e.offsetWidth,height:e.offsetHeight}}function ye(e){return Ca.pipe(S(t=>t.observe(e)),g(t=>eo.pipe(A(({target:r})=>r===e),R(()=>t.unobserve(e)),l(()=>he(e)))),V(he(e)))}function bt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function ar(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}var to=new x,Ra=$(()=>k(new IntersectionObserver(e=>{for(let t of e)to.next(t)},{threshold:0}))).pipe(g(e=>L(ze,k(e)).pipe(R(()=>e.disconnect()))),X(1));function sr(e){return Ra.pipe(S(t=>t.observe(e)),g(t=>to.pipe(A(({target:r})=>r===e),R(()=>t.unobserve(e)),l(({isIntersecting:r})=>r))))}function ro(e,t=16){return dt(e).pipe(l(({y:r})=>{let n=he(e),o=bt(e);return r>=o.height-n.height-t}),J())}var cr={drawer:z("[data-md-toggle=drawer]"),search:z("[data-md-toggle=search]")};function no(e){return cr[e].checked}function Ke(e,t){cr[e].checked!==t&&cr[e].click()}function Ue(e){let t=cr[e];return b(t,"change").pipe(l(()=>t.checked),V(t.checked))}function ka(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function Ha(){return L(b(window,"compositionstart").pipe(l(()=>!0)),b(window,"compositionend").pipe(l(()=>!1))).pipe(V(!1))}function oo(){let e=b(window,"keydown").pipe(A(t=>!(t.metaKey||t.ctrlKey)),l(t=>({mode:no("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),A(({mode:t,type:r})=>{if(t==="global"){let n=_e();if(typeof n!="undefined")return!ka(n,r)}return!0}),pe());return Ha().pipe(g(t=>t?_:e))}function le(){return new URL(location.href)}function ot(e){location.href=e.href}function io(){return new x}function ao(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)ao(e,r)}function M(e,t,...r){let n=document.createElement(e);if(t)for(let o of Object.keys(t))typeof t[o]!="undefined"&&(typeof t[o]!="boolean"?n.setAttribute(o,t[o]):n.setAttribute(o,""));for(let o of r)ao(n,o);return n}function fr(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function so(){return location.hash.substring(1)}function Dr(e){let t=M("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Pa(e){return L(b(window,"hashchange"),e).pipe(l(so),V(so()),A(t=>t.length>0),X(1))}function co(e){return Pa(e).pipe(l(t=>ce(`[id="${t}"]`)),A(t=>typeof t!="undefined"))}function Vr(e){let t=matchMedia(e);return er(r=>t.addListener(()=>r(t.matches))).pipe(V(t.matches))}function fo(){let e=matchMedia("print");return L(b(window,"beforeprint").pipe(l(()=>!0)),b(window,"afterprint").pipe(l(()=>!1))).pipe(V(e.matches))}function zr(e,t){return e.pipe(g(r=>r?t():_))}function ur(e,t={credentials:"same-origin"}){return ue(fetch(`${e}`,t)).pipe(fe(()=>_),g(r=>r.status!==200?Ot(()=>new Error(r.statusText)):k(r)))}function We(e,t){return ur(e,t).pipe(g(r=>r.json()),X(1))}function uo(e,t){let r=new DOMParser;return ur(e,t).pipe(g(n=>n.text()),l(n=>r.parseFromString(n,"text/xml")),X(1))}function pr(e){let t=M("script",{src:e});return $(()=>(document.head.appendChild(t),L(b(t,"load"),b(t,"error").pipe(g(()=>Ot(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(l(()=>{}),R(()=>document.head.removeChild(t)),ge(1))))}function po(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function lo(){return L(b(window,"scroll",{passive:!0}),b(window,"resize",{passive:!0})).pipe(l(po),V(po()))}function mo(){return{width:innerWidth,height:innerHeight}}function ho(){return b(window,"resize",{passive:!0}).pipe(l(mo),V(mo()))}function bo(){return G([lo(),ho()]).pipe(l(([e,t])=>({offset:e,size:t})),X(1))}function lr(e,{viewport$:t,header$:r}){let n=t.pipe(ee("size")),o=G([n,r]).pipe(l(()=>Xe(e)));return G([r,t,o]).pipe(l(([{height:i},{offset:s,size:a},{x:f,y:c}])=>({offset:{x:s.x-f,y:s.y-c+i},size:a})))}(()=>{function e(n,o){parent.postMessage(n,o||"*")}function t(...n){return n.reduce((o,i)=>o.then(()=>new Promise(s=>{let a=document.createElement("script");a.src=i,a.onload=s,document.body.appendChild(a)})),Promise.resolve())}var r=class extends EventTarget{constructor(n){super(),this.url=n,this.m=i=>{i.source===this.w&&(this.dispatchEvent(new MessageEvent("message",{data:i.data})),this.onmessage&&this.onmessage(i))},this.e=(i,s,a,f,c)=>{if(s===`${this.url}`){let u=new ErrorEvent("error",{message:i,filename:s,lineno:a,colno:f,error:c});this.dispatchEvent(u),this.onerror&&this.onerror(u)}};let o=document.createElement("iframe");o.hidden=!0,document.body.appendChild(this.iframe=o),this.w.document.open(),this.w.document.write(` + @@ -85,7 +84,6 @@
    @@ -106,12 +104,8 @@
    - - -