README.md

Aqua::Enterprise::Server

A resource provider for Aqua Enterprise Server.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
    "Type" : "Aqua::Enterprise::Server",
    "Properties" : {
        "ClusterID" : String,
        "KubeConfig" : String,
        "RoleArn" : String,
        "Namespace" : String,
        "Name" : String,
        "Values" : Values,
        "ValueYaml" : String,
        "Version" : String,
        "ValueOverrideURL" : String,
        "TimeOut" : Integer,
        "VPCConfiguration" : VPCConfiguration
    }
}

YAML

Type: Aqua::Enterprise::Server
Properties:
    ClusterID: String
    KubeConfig: String
    RoleArn: String
    Namespace: String
    Name: String
    Values: Values
    ValueYaml: String
    Version: String
    ValueOverrideURL: String
    TimeOut: Integer
    VPCConfiguration: VPCConfiguration

Properties

ClusterID

EKS cluster name

Required: No

Type: String

Update requires: Replacement

KubeConfig

Required: No

Type: String

Pattern: ^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$

Update requires: No interruption

RoleArn

Required: No

Type: String

Pattern: ^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$

Update requires: No interruption

Namespace

Namespace to use with helm. Created if doesn't exist and default will be used if not provided

Required: No

Type: String

Update requires: Replacement

Name

Name for the helm release

Required: No

Type: String

Update requires: Replacement

Values

Custom Values can optionally be specified

Required: No

Type: Values

Update requires: No interruption

ValueYaml

String representation of a values.yaml file

Required: No

Type: String

Update requires: No interruption

Version

Version can be specified, if not latest will be used

Required: No

Type: String

Update requires: No interruption

ValueOverrideURL

Custom Value Yaml file can optionally be specified

Required: No

Type: String

Pattern: ^[sS]3://0-9a-zA-Z(:[0-9])([?/#].*)?$

Update requires: No interruption

TimeOut

Timeout for resource provider. Default 60 mins

Required: No

Type: Integer

Update requires: No interruption

VPCConfiguration

For network connectivity to Cluster inside VPC

Required: No

Type: VPCConfiguration

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ID.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Resources

Returns the Resources value.

ID

Primary identifier for Cloudformation