MDAA TS Docs
    Preparing search index...

    Class MdaaRedshiftCluster

    A construct for the creation of a compliant Redshift Cluster Specifically, the construct ensures the following:

    • The cluster is encrypted at rest using KMS CMK.
    • SSL must be utilized to connect to the cluster.
    • The cluster is VPC connected and not publicly accessible.

    Hierarchy

    • Cluster
      • MdaaRedshiftCluster
    Index

    Constructors

    constructor

    Properties

    clusterEndpoint clusterName connections env node parameterGroup? physicalName secret? stack PROPERTY_INJECTION_ID

    Methods

    _enableCrossEnvironment addDefaultIamRole addIamRole addRotationMultiUser addRotationSingleUser addToParameterGroup applyRemovalPolicy asSecretAttachmentTarget enableRebootForParameterChanges generatePhysicalName getResourceArnAttribute getResourceNameAttribute toString fromClusterAttributes isConstruct isOwnedResource isResource

    Constructors

    Properties

    clusterEndpoint: Endpoint

    The endpoint to use for read/write operations

    clusterName: string

    Identifier of the cluster

    connections: Connections

    Access to the network connections

    env: ResourceEnvironment

    The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

    node: Node

    The tree node.

    parameterGroup?: IClusterParameterGroup

    The cluster's parameter group

    physicalName: string

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

    This value will resolve to one of the following:

    • a concrete value (e.g. "my-awesome-bucket")
    • undefined, when a name should be generated by CloudFormation
    • a concrete name generated automatically during synthesis, in cross-environment scenarios.
    secret?: ISecret

    The secret attached to this cluster

    stack: Stack

    The stack in which this resource is defined.

    PROPERTY_INJECTION_ID: string

    Uniquely identifies this class.

    Methods

    _enableCrossEnvironment

    • _enableCrossEnvironment(): void
      Internal

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

      Returns void

    • Adds default IAM role to cluster. The default IAM role must be already associated to the cluster to be added as the default role.

      Parameters

      • defaultIamRole: IRole

        the IAM role to be set as the default role

      Returns void

    • Adds a role to the cluster

      Parameters

      • role: IRole

        the role to add

      Returns void

    • Adds the multi user rotation to this cluster.

      Parameters

      • id: string
      • options: RotationMultiUserOptions

      Returns SecretRotation

    • Adds the single user rotation of the master password to this cluster.

      Parameters

      • OptionalautomaticallyAfter: Duration

        Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.

      Returns SecretRotation

    • Adds a parameter to the Clusters' parameter group

      Parameters

      • name: string

        the parameter name

      • value: string

        the parameter name

      Returns void

    • Apply the given removal policy to this resource

      The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

      The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

      Parameters

      • policy: RemovalPolicy

      Returns void

    • Renders the secret attachment target specifications.

      Returns SecretAttachmentTargetProps

    • Enables automatic cluster rebooting when changes to the cluster's parameter group require a restart to apply.

      Returns void

    • Returns string

    • Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

      Normally, this token will resolve to arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arnComponents.

      Parameters

      • arnAttr: string

        The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes it's the CFN resource's ref.

      • arnComponents: ArnComponents

        The format of the ARN of this resource. You must reference this.physicalName somewhere within the ARN in order for cross-environment references to work.

      Returns string

    • Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

      Normally, this token will resolve to nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

      Parameters

      • nameAttr: string

        The CFN attribute which resolves to the resource's name. Commonly this is the resource's ref.

      Returns string

    • Returns a string representation of this construct.

      Returns string

    • Import an existing DatabaseCluster from properties

      Parameters

      • scope: Construct
      • id: string
      • attrs: ClusterAttributes

      Returns ICluster

    • 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 disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

      Parameters

      • x: any

        Any object

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

    • Returns true if the construct was created by CDK, and false otherwise

      Parameters

      • construct: IConstruct

      Returns boolean

    • Check whether the given construct is a Resource

      Parameters

      • construct: IConstruct

      Returns construct is Resource

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods