awsredshift

package
v1.109.0-devpreview Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 17, 2021 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnClusterParameterGroup_CFN_RESOURCE_TYPE_NAME 

func CfnClusterParameterGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnClusterParameterGroup_IsCfnElement 

func CfnClusterParameterGroup_IsCfnElement(x interface{}) *bool

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

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

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnClusterParameterGroup_IsCfnResource 

func CfnClusterParameterGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnClusterParameterGroup_IsConstruct 

func CfnClusterParameterGroup_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnClusterSecurityGroupIngress_CFN_RESOURCE_TYPE_NAME 

func CfnClusterSecurityGroupIngress_CFN_RESOURCE_TYPE_NAME() *string

func CfnClusterSecurityGroupIngress_IsCfnElement 

func CfnClusterSecurityGroupIngress_IsCfnElement(x interface{}) *bool

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

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

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnClusterSecurityGroupIngress_IsCfnResource 

func CfnClusterSecurityGroupIngress_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnClusterSecurityGroupIngress_IsConstruct 

func CfnClusterSecurityGroupIngress_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnClusterSecurityGroup_CFN_RESOURCE_TYPE_NAME 

func CfnClusterSecurityGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnClusterSecurityGroup_IsCfnElement 

func CfnClusterSecurityGroup_IsCfnElement(x interface{}) *bool

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

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

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnClusterSecurityGroup_IsCfnResource 

func CfnClusterSecurityGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnClusterSecurityGroup_IsConstruct 

func CfnClusterSecurityGroup_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnClusterSubnetGroup_CFN_RESOURCE_TYPE_NAME 

func CfnClusterSubnetGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnClusterSubnetGroup_IsCfnElement 

func CfnClusterSubnetGroup_IsCfnElement(x interface{}) *bool

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

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

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnClusterSubnetGroup_IsCfnResource 

func CfnClusterSubnetGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnClusterSubnetGroup_IsConstruct 

func CfnClusterSubnetGroup_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnCluster_CFN_RESOURCE_TYPE_NAME 

func CfnCluster_CFN_RESOURCE_TYPE_NAME() *string

func CfnCluster_IsCfnElement 

func CfnCluster_IsCfnElement(x interface{}) *bool

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

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

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnCluster_IsCfnResource 

func CfnCluster_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnCluster_IsConstruct 

func CfnCluster_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func ClusterParameterGroup_IsConstruct 

func ClusterParameterGroup_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func ClusterParameterGroup_IsResource 

func ClusterParameterGroup_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func ClusterSubnetGroup_IsConstruct 

func ClusterSubnetGroup_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func ClusterSubnetGroup_IsResource 

func ClusterSubnetGroup_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func Cluster_IsConstruct 

func Cluster_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func Cluster_IsResource 

func Cluster_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func DatabaseSecret_FromSecretArn deprecated 

func DatabaseSecret_FromSecretArn(scope constructs.Construct, id *string, secretArn *string) awssecretsmanager.ISecret

Deprecated: use `fromSecretCompleteArn` or `fromSecretPartialArn`

func DatabaseSecret_FromSecretAttributes 

func DatabaseSecret_FromSecretAttributes(scope constructs.Construct, id *string, attrs *awssecretsmanager.SecretAttributes) awssecretsmanager.ISecret

Import an existing secret into the Stack. Experimental.

func DatabaseSecret_FromSecretCompleteArn 

func DatabaseSecret_FromSecretCompleteArn(scope constructs.Construct, id *string, secretCompleteArn *string) awssecretsmanager.ISecret

Imports a secret by complete ARN.

The complete ARN is the ARN with the Secrets Manager-supplied suffix. Experimental.

func DatabaseSecret_FromSecretName 

func DatabaseSecret_FromSecretName(scope constructs.Construct, id *string, secretName *string) awssecretsmanager.ISecret

Imports a secret by secret name;

the ARN of the Secret will be set to the secret name. A secret with this name must exist in the same account & region. Deprecated: use `fromSecretNameV2`

func DatabaseSecret_FromSecretNameV2 

func DatabaseSecret_FromSecretNameV2(scope constructs.Construct, id *string, secretName *string) awssecretsmanager.ISecret

Imports a secret by secret name.

A secret with this name must exist in the same account & region. Replaces the deprecated `fromSecretName`. Experimental.

func DatabaseSecret_FromSecretPartialArn 

func DatabaseSecret_FromSecretPartialArn(scope constructs.Construct, id *string, secretPartialArn *string) awssecretsmanager.ISecret

Imports a secret by partial ARN.

The partial ARN is the ARN without the Secrets Manager-supplied suffix. Experimental.

func DatabaseSecret_IsConstruct 

func DatabaseSecret_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func DatabaseSecret_IsResource 

func DatabaseSecret_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func NewCfnClusterParameterGroup_Override 

func NewCfnClusterParameterGroup_Override(c CfnClusterParameterGroup, scope awscdk.Construct, id *string, props *CfnClusterParameterGroupProps)

Create a new `AWS::Redshift::ClusterParameterGroup`.

func NewCfnClusterSecurityGroupIngress_Override 

func NewCfnClusterSecurityGroupIngress_Override(c CfnClusterSecurityGroupIngress, scope awscdk.Construct, id *string, props *CfnClusterSecurityGroupIngressProps)

Create a new `AWS::Redshift::ClusterSecurityGroupIngress`.

func NewCfnClusterSecurityGroup_Override 

func NewCfnClusterSecurityGroup_Override(c CfnClusterSecurityGroup, scope awscdk.Construct, id *string, props *CfnClusterSecurityGroupProps)

Create a new `AWS::Redshift::ClusterSecurityGroup`.

func NewCfnClusterSubnetGroup_Override 

func NewCfnClusterSubnetGroup_Override(c CfnClusterSubnetGroup, scope awscdk.Construct, id *string, props *CfnClusterSubnetGroupProps)

Create a new `AWS::Redshift::ClusterSubnetGroup`.

func NewCfnCluster_Override 

func NewCfnCluster_Override(c CfnCluster, scope awscdk.Construct, id *string, props *CfnClusterProps)

Create a new `AWS::Redshift::Cluster`.

func NewClusterParameterGroup_Override 

func NewClusterParameterGroup_Override(c ClusterParameterGroup, scope constructs.Construct, id *string, props *ClusterParameterGroupProps)

Experimental.

func NewClusterSubnetGroup_Override 

func NewClusterSubnetGroup_Override(c ClusterSubnetGroup, scope constructs.Construct, id *string, props *ClusterSubnetGroupProps)

Experimental.

func NewCluster_Override 

func NewCluster_Override(c Cluster, scope constructs.Construct, id *string, props *ClusterProps)

Experimental.

func NewDatabaseSecret_Override 

func NewDatabaseSecret_Override(d DatabaseSecret, scope constructs.Construct, id *string, props *DatabaseSecretProps)

Experimental.

func NewEndpoint_Override 

func NewEndpoint_Override(e Endpoint, address *string, port *float64)

Experimental.

Types

type CfnCluster 

type CfnCluster interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AllowVersionUpgrade() interface{}
	SetAllowVersionUpgrade(val interface{})
	AttrEndpointAddress() *string
	AttrEndpointPort() *string
	AutomatedSnapshotRetentionPeriod() *float64
	SetAutomatedSnapshotRetentionPeriod(val *float64)
	AvailabilityZone() *string
	SetAvailabilityZone(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ClusterIdentifier() *string
	SetClusterIdentifier(val *string)
	ClusterParameterGroupName() *string
	SetClusterParameterGroupName(val *string)
	ClusterSecurityGroups() *[]*string
	SetClusterSecurityGroups(val *[]*string)
	ClusterSubnetGroupName() *string
	SetClusterSubnetGroupName(val *string)
	ClusterType() *string
	SetClusterType(val *string)
	ClusterVersion() *string
	SetClusterVersion(val *string)
	CreationStack() *[]*string
	DbName() *string
	SetDbName(val *string)
	ElasticIp() *string
	SetElasticIp(val *string)
	Encrypted() interface{}
	SetEncrypted(val interface{})
	HsmClientCertificateIdentifier() *string
	SetHsmClientCertificateIdentifier(val *string)
	HsmConfigurationIdentifier() *string
	SetHsmConfigurationIdentifier(val *string)
	IamRoles() *[]*string
	SetIamRoles(val *[]*string)
	KmsKeyId() *string
	SetKmsKeyId(val *string)
	LoggingProperties() interface{}
	SetLoggingProperties(val interface{})
	LogicalId() *string
	MasterUsername() *string
	SetMasterUsername(val *string)
	MasterUserPassword() *string
	SetMasterUserPassword(val *string)
	Node() awscdk.ConstructNode
	NodeType() *string
	SetNodeType(val *string)
	NumberOfNodes() *float64
	SetNumberOfNodes(val *float64)
	OwnerAccount() *string
	SetOwnerAccount(val *string)
	Port() *float64
	SetPort(val *float64)
	PreferredMaintenanceWindow() *string
	SetPreferredMaintenanceWindow(val *string)
	PubliclyAccessible() interface{}
	SetPubliclyAccessible(val interface{})
	Ref() *string
	SnapshotClusterIdentifier() *string
	SetSnapshotClusterIdentifier(val *string)
	SnapshotIdentifier() *string
	SetSnapshotIdentifier(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	VpcSecurityGroupIds() *[]*string
	SetVpcSecurityGroupIds(val *[]*string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Redshift::Cluster`.

func NewCfnCluster 

func NewCfnCluster(scope awscdk.Construct, id *string, props *CfnClusterProps) CfnCluster

Create a new `AWS::Redshift::Cluster`.

type CfnClusterParameterGroup 

type CfnClusterParameterGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	ParameterGroupFamily() *string
	SetParameterGroupFamily(val *string)
	Parameters() interface{}
	SetParameters(val interface{})
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Redshift::ClusterParameterGroup`.

func NewCfnClusterParameterGroup 

func NewCfnClusterParameterGroup(scope awscdk.Construct, id *string, props *CfnClusterParameterGroupProps) CfnClusterParameterGroup

Create a new `AWS::Redshift::ClusterParameterGroup`.

type CfnClusterParameterGroupProps 

type CfnClusterParameterGroupProps struct {
	// `AWS::Redshift::ClusterParameterGroup.Description`.
	Description *string `json:"description"`
	// `AWS::Redshift::ClusterParameterGroup.ParameterGroupFamily`.
	ParameterGroupFamily *string `json:"parameterGroupFamily"`
	// `AWS::Redshift::ClusterParameterGroup.Parameters`.
	Parameters interface{} `json:"parameters"`
	// `AWS::Redshift::ClusterParameterGroup.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::Redshift::ClusterParameterGroup`.

type CfnClusterParameterGroup_ParameterProperty 

type CfnClusterParameterGroup_ParameterProperty struct {
	// `CfnClusterParameterGroup.ParameterProperty.ParameterName`.
	ParameterName *string `json:"parameterName"`
	// `CfnClusterParameterGroup.ParameterProperty.ParameterValue`.
	ParameterValue *string `json:"parameterValue"`
}

type CfnClusterProps 

type CfnClusterProps struct {
	// `AWS::Redshift::Cluster.ClusterType`.
	ClusterType *string `json:"clusterType"`
	// `AWS::Redshift::Cluster.DBName`.
	DbName *string `json:"dbName"`
	// `AWS::Redshift::Cluster.MasterUsername`.
	MasterUsername *string `json:"masterUsername"`
	// `AWS::Redshift::Cluster.MasterUserPassword`.
	MasterUserPassword *string `json:"masterUserPassword"`
	// `AWS::Redshift::Cluster.NodeType`.
	NodeType *string `json:"nodeType"`
	// `AWS::Redshift::Cluster.AllowVersionUpgrade`.
	AllowVersionUpgrade interface{} `json:"allowVersionUpgrade"`
	// `AWS::Redshift::Cluster.AutomatedSnapshotRetentionPeriod`.
	AutomatedSnapshotRetentionPeriod *float64 `json:"automatedSnapshotRetentionPeriod"`
	// `AWS::Redshift::Cluster.AvailabilityZone`.
	AvailabilityZone *string `json:"availabilityZone"`
	// `AWS::Redshift::Cluster.ClusterIdentifier`.
	ClusterIdentifier *string `json:"clusterIdentifier"`
	// `AWS::Redshift::Cluster.ClusterParameterGroupName`.
	ClusterParameterGroupName *string `json:"clusterParameterGroupName"`
	// `AWS::Redshift::Cluster.ClusterSecurityGroups`.
	ClusterSecurityGroups *[]*string `json:"clusterSecurityGroups"`
	// `AWS::Redshift::Cluster.ClusterSubnetGroupName`.
	ClusterSubnetGroupName *string `json:"clusterSubnetGroupName"`
	// `AWS::Redshift::Cluster.ClusterVersion`.
	ClusterVersion *string `json:"clusterVersion"`
	// `AWS::Redshift::Cluster.ElasticIp`.
	ElasticIp *string `json:"elasticIp"`
	// `AWS::Redshift::Cluster.Encrypted`.
	Encrypted interface{} `json:"encrypted"`
	// `AWS::Redshift::Cluster.HsmClientCertificateIdentifier`.
	HsmClientCertificateIdentifier *string `json:"hsmClientCertificateIdentifier"`
	// `AWS::Redshift::Cluster.HsmConfigurationIdentifier`.
	HsmConfigurationIdentifier *string `json:"hsmConfigurationIdentifier"`
	// `AWS::Redshift::Cluster.IamRoles`.
	IamRoles *[]*string `json:"iamRoles"`
	// `AWS::Redshift::Cluster.KmsKeyId`.
	KmsKeyId *string `json:"kmsKeyId"`
	// `AWS::Redshift::Cluster.LoggingProperties`.
	LoggingProperties interface{} `json:"loggingProperties"`
	// `AWS::Redshift::Cluster.NumberOfNodes`.
	NumberOfNodes *float64 `json:"numberOfNodes"`
	// `AWS::Redshift::Cluster.OwnerAccount`.
	OwnerAccount *string `json:"ownerAccount"`
	// `AWS::Redshift::Cluster.Port`.
	Port *float64 `json:"port"`
	// `AWS::Redshift::Cluster.PreferredMaintenanceWindow`.
	PreferredMaintenanceWindow *string `json:"preferredMaintenanceWindow"`
	// `AWS::Redshift::Cluster.PubliclyAccessible`.
	PubliclyAccessible interface{} `json:"publiclyAccessible"`
	// `AWS::Redshift::Cluster.SnapshotClusterIdentifier`.
	SnapshotClusterIdentifier *string `json:"snapshotClusterIdentifier"`
	// `AWS::Redshift::Cluster.SnapshotIdentifier`.
	SnapshotIdentifier *string `json:"snapshotIdentifier"`
	// `AWS::Redshift::Cluster.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// `AWS::Redshift::Cluster.VpcSecurityGroupIds`.
	VpcSecurityGroupIds *[]*string `json:"vpcSecurityGroupIds"`
}

Properties for defining a `AWS::Redshift::Cluster`.

type CfnClusterSecurityGroup 

type CfnClusterSecurityGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Redshift::ClusterSecurityGroup`.

func NewCfnClusterSecurityGroup 

func NewCfnClusterSecurityGroup(scope awscdk.Construct, id *string, props *CfnClusterSecurityGroupProps) CfnClusterSecurityGroup

Create a new `AWS::Redshift::ClusterSecurityGroup`.

type CfnClusterSecurityGroupIngress 

type CfnClusterSecurityGroupIngress interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Cidrip() *string
	SetCidrip(val *string)
	ClusterSecurityGroupName() *string
	SetClusterSecurityGroupName(val *string)
	CreationStack() *[]*string
	Ec2SecurityGroupName() *string
	SetEc2SecurityGroupName(val *string)
	Ec2SecurityGroupOwnerId() *string
	SetEc2SecurityGroupOwnerId(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Redshift::ClusterSecurityGroupIngress`.

func NewCfnClusterSecurityGroupIngress 

func NewCfnClusterSecurityGroupIngress(scope awscdk.Construct, id *string, props *CfnClusterSecurityGroupIngressProps) CfnClusterSecurityGroupIngress

Create a new `AWS::Redshift::ClusterSecurityGroupIngress`.

type CfnClusterSecurityGroupIngressProps 

type CfnClusterSecurityGroupIngressProps struct {
	// `AWS::Redshift::ClusterSecurityGroupIngress.ClusterSecurityGroupName`.
	ClusterSecurityGroupName *string `json:"clusterSecurityGroupName"`
	// `AWS::Redshift::ClusterSecurityGroupIngress.CIDRIP`.
	Cidrip *string `json:"cidrip"`
	// `AWS::Redshift::ClusterSecurityGroupIngress.EC2SecurityGroupName`.
	Ec2SecurityGroupName *string `json:"ec2SecurityGroupName"`
	// `AWS::Redshift::ClusterSecurityGroupIngress.EC2SecurityGroupOwnerId`.
	Ec2SecurityGroupOwnerId *string `json:"ec2SecurityGroupOwnerId"`
}

Properties for defining a `AWS::Redshift::ClusterSecurityGroupIngress`.

type CfnClusterSecurityGroupProps 

type CfnClusterSecurityGroupProps struct {
	// `AWS::Redshift::ClusterSecurityGroup.Description`.
	Description *string `json:"description"`
	// `AWS::Redshift::ClusterSecurityGroup.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::Redshift::ClusterSecurityGroup`.

type CfnClusterSubnetGroup 

type CfnClusterSubnetGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	SubnetIds() *[]*string
	SetSubnetIds(val *[]*string)
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Redshift::ClusterSubnetGroup`.

func NewCfnClusterSubnetGroup 

func NewCfnClusterSubnetGroup(scope awscdk.Construct, id *string, props *CfnClusterSubnetGroupProps) CfnClusterSubnetGroup

Create a new `AWS::Redshift::ClusterSubnetGroup`.

type CfnClusterSubnetGroupProps 

type CfnClusterSubnetGroupProps struct {
	// `AWS::Redshift::ClusterSubnetGroup.Description`.
	Description *string `json:"description"`
	// `AWS::Redshift::ClusterSubnetGroup.SubnetIds`.
	SubnetIds *[]*string `json:"subnetIds"`
	// `AWS::Redshift::ClusterSubnetGroup.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::Redshift::ClusterSubnetGroup`.

type CfnCluster_LoggingPropertiesProperty 

type CfnCluster_LoggingPropertiesProperty struct {
	// `CfnCluster.LoggingPropertiesProperty.BucketName`.
	BucketName *string `json:"bucketName"`
	// `CfnCluster.LoggingPropertiesProperty.S3KeyPrefix`.
	S3KeyPrefix *string `json:"s3KeyPrefix"`
}

type Cluster 

type Cluster interface {
	awscdk.Resource
	ICluster
	ClusterEndpoint() Endpoint
	ClusterName() *string
	Connections() awsec2.Connections
	Env() *awscdk.ResourceEnvironment
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Secret() awssecretsmanager.ISecret
	Stack() awscdk.Stack
	AddRotationMultiUser(id *string, options *RotationMultiUserOptions) awssecretsmanager.SecretRotation
	AddRotationSingleUser(automaticallyAfter awscdk.Duration) awssecretsmanager.SecretRotation
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	AsSecretAttachmentTarget() *awssecretsmanager.SecretAttachmentTargetProps
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Create a Redshift cluster a given number of nodes. Experimental.

func NewCluster 

func NewCluster(scope constructs.Construct, id *string, props *ClusterProps) Cluster

Experimental.

type ClusterAttributes 

type ClusterAttributes struct {
	// Cluster endpoint address.
	// Experimental.
	ClusterEndpointAddress *string `json:"clusterEndpointAddress"`
	// Cluster endpoint port.
	// Experimental.
	ClusterEndpointPort *float64 `json:"clusterEndpointPort"`
	// Identifier for the cluster.
	// Experimental.
	ClusterName *string `json:"clusterName"`
	// The security groups of the redshift cluster.
	// Experimental.
	SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"`
}

Properties that describe an existing cluster instance. Experimental.

type ClusterParameterGroup 

type ClusterParameterGroup interface {
	awscdk.Resource
	IClusterParameterGroup
	ClusterParameterGroupName() *string
	Env() *awscdk.ResourceEnvironment
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

A cluster parameter group. Experimental.

func NewClusterParameterGroup 

func NewClusterParameterGroup(scope constructs.Construct, id *string, props *ClusterParameterGroupProps) ClusterParameterGroup

Experimental.

type ClusterParameterGroupProps 

type ClusterParameterGroupProps struct {
	// The parameters in this parameter group.
	// Experimental.
	Parameters *map[string]*string `json:"parameters"`
	// Description for this parameter group.
	// Experimental.
	Description *string `json:"description"`
}

Properties for a parameter group. Experimental.

type ClusterProps 

type ClusterProps struct {
	// Username and password for the administrative user.
	// Experimental.
	MasterUser *Login `json:"masterUser"`
	// The VPC to place the cluster in.
	// Experimental.
	Vpc awsec2.IVpc `json:"vpc"`
	// An optional identifier for the cluster.
	// Experimental.
	ClusterName *string `json:"clusterName"`
	// Settings for the individual instances that are launched.
	// Experimental.
	ClusterType ClusterType `json:"clusterType"`
	// Name of a database which is automatically created inside the cluster.
	// Experimental.
	DefaultDatabaseName *string `json:"defaultDatabaseName"`
	// Whether to enable encryption of data at rest in the cluster.
	// Experimental.
	Encrypted *bool `json:"encrypted"`
	// The KMS key to use for encryption of data at rest.
	// Experimental.
	EncryptionKey awskms.IKey `json:"encryptionKey"`
	// Bucket to send logs to.
	//
	// Logging information includes queries and connection attempts, for the specified Amazon Redshift cluster.
	// Experimental.
	LoggingBucket awss3.IBucket `json:"loggingBucket"`
	// Prefix used for logging.
	// Experimental.
	LoggingKeyPrefix *string `json:"loggingKeyPrefix"`
	// The node type to be provisioned for the cluster.
	// Experimental.
	NodeType NodeType `json:"nodeType"`
	// Number of compute nodes in the cluster. Only specify this property for multi-node clusters.
	//
	// Value must be at least 2 and no more than 100.
	// Experimental.
	NumberOfNodes *float64 `json:"numberOfNodes"`
	// Additional parameters to pass to the database engine https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html.
	// Experimental.
	ParameterGroup IClusterParameterGroup `json:"parameterGroup"`
	// What port to listen on.
	// Experimental.
	Port *float64 `json:"port"`
	// A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC).
	//
	// Example: 'Sun:23:45-Mon:00:15'
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
	//
	// Experimental.
	PreferredMaintenanceWindow *string `json:"preferredMaintenanceWindow"`
	// Whether to make cluster publicly accessible.
	// Experimental.
	PubliclyAccessible *bool `json:"publiclyAccessible"`
	// The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.
	// Experimental.
	RemovalPolicy awscdk.RemovalPolicy `json:"removalPolicy"`
	// A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services.
	//
	// Specify a maximum of 10 roles.
	// Experimental.
	Roles *[]awsiam.IRole `json:"roles"`
	// Security group.
	// Experimental.
	SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"`
	// A cluster subnet group to use with this cluster.
	// Experimental.
	SubnetGroup IClusterSubnetGroup `json:"subnetGroup"`
	// Where to place the instances within the VPC.
	// Experimental.
	VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets"`
}

Properties for a new database cluster. Experimental.

type ClusterSubnetGroup 

type ClusterSubnetGroup interface {
	awscdk.Resource
	IClusterSubnetGroup
	ClusterSubnetGroupName() *string
	Env() *awscdk.ResourceEnvironment
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Class for creating a Redshift cluster subnet group. Experimental.

func NewClusterSubnetGroup 

func NewClusterSubnetGroup(scope constructs.Construct, id *string, props *ClusterSubnetGroupProps) ClusterSubnetGroup

Experimental.

type ClusterSubnetGroupProps 

type ClusterSubnetGroupProps struct {
	// Description of the subnet group.
	// Experimental.
	Description *string `json:"description"`
	// The VPC to place the subnet group in.
	// Experimental.
	Vpc awsec2.IVpc `json:"vpc"`
	// The removal policy to apply when the subnet group are removed from the stack or replaced during an update.
	// Experimental.
	RemovalPolicy awscdk.RemovalPolicy `json:"removalPolicy"`
	// Which subnets within the VPC to associate with this group.
	// Experimental.
	VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets"`
}

Properties for creating a ClusterSubnetGroup. Experimental.

type ClusterType 

type ClusterType string

What cluster type to use.

Used by {@link ClusterProps.clusterType} Experimental. 

const (
	ClusterType_SINGLE_NODE ClusterType = "SINGLE_NODE"
	ClusterType_MULTI_NODE  ClusterType = "MULTI_NODE"
)

type DatabaseSecret 

type DatabaseSecret interface {
	awssecretsmanager.Secret
	ArnForPolicies() *string
	AutoCreatePolicy() *bool
	EncryptionKey() awskms.IKey
	Env() *awscdk.ResourceEnvironment
	Node() awscdk.ConstructNode
	PhysicalName() *string
	SecretArn() *string
	SecretFullArn() *string
	SecretName() *string
	SecretValue() awscdk.SecretValue
	Stack() awscdk.Stack
	AddReplicaRegion(region *string, encryptionKey awskms.IKey)
	AddRotationSchedule(id *string, options *awssecretsmanager.RotationScheduleOptions) awssecretsmanager.RotationSchedule
	AddTargetAttachment(id *string, options *awssecretsmanager.AttachedSecretOptions) awssecretsmanager.SecretTargetAttachment
	AddToResourcePolicy(statement awsiam.PolicyStatement) *awsiam.AddToResourcePolicyResult
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	Attach(target awssecretsmanager.ISecretAttachmentTarget) awssecretsmanager.ISecret
	DenyAccountRootDelete()
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	GrantRead(grantee awsiam.IGrantable, versionStages *[]*string) awsiam.Grant
	GrantWrite(grantee awsiam.IGrantable) awsiam.Grant
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	SecretValueFromJson(jsonField *string) awscdk.SecretValue
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

A database secret. Experimental.

func NewDatabaseSecret 

func NewDatabaseSecret(scope constructs.Construct, id *string, props *DatabaseSecretProps) DatabaseSecret

Experimental.

type DatabaseSecretProps 

type DatabaseSecretProps struct {
	// The username.
	// Experimental.
	Username *string `json:"username"`
	// The KMS key to use to encrypt the secret.
	// Experimental.
	EncryptionKey awskms.IKey `json:"encryptionKey"`
}

Construction properties for a DatabaseSecret. Experimental.

type Endpoint 

type Endpoint interface {
	Hostname() *string
	Port() *float64
	SocketAddress() *string
}

Connection endpoint of a redshift cluster.

Consists of a combination of hostname and port. Experimental.

func NewEndpoint 

func NewEndpoint(address *string, port *float64) Endpoint

Experimental.

type ICluster 

type ICluster interface {
	awsec2.IConnectable
	awscdk.IResource
	awssecretsmanager.ISecretAttachmentTarget
	// The endpoint to use for read/write operations.
	// Experimental.
	ClusterEndpoint() Endpoint
	// Name of the cluster.
	// Experimental.
	ClusterName() *string
}

Create a Redshift Cluster with a given number of nodes.

Implemented by {@link Cluster} via {@link ClusterBase}. Experimental.

func Cluster_FromClusterAttributes 

func Cluster_FromClusterAttributes(scope constructs.Construct, id *string, attrs *ClusterAttributes) ICluster

Import an existing DatabaseCluster from properties. Experimental.

type IClusterParameterGroup 

type IClusterParameterGroup interface {
	awscdk.IResource
	// The name of this parameter group.
	// Experimental.
	ClusterParameterGroupName() *string
}

A parameter group. Experimental.

func ClusterParameterGroup_FromClusterParameterGroupName 

func ClusterParameterGroup_FromClusterParameterGroupName(scope constructs.Construct, id *string, clusterParameterGroupName *string) IClusterParameterGroup

Imports a parameter group. Experimental.

type IClusterSubnetGroup 

type IClusterSubnetGroup interface {
	awscdk.IResource
	// The name of the cluster subnet group.
	// Experimental.
	ClusterSubnetGroupName() *string
}

Interface for a cluster subnet group. Experimental.

func ClusterSubnetGroup_FromClusterSubnetGroupName 

func ClusterSubnetGroup_FromClusterSubnetGroupName(scope constructs.Construct, id *string, clusterSubnetGroupName *string) IClusterSubnetGroup

Imports an existing subnet group by name. Experimental.

type Login 

type Login struct {
	// Username.
	// Experimental.
	MasterUsername *string `json:"masterUsername"`
	// KMS encryption key to encrypt the generated secret.
	// Experimental.
	EncryptionKey awskms.IKey `json:"encryptionKey"`
	// Password.
	//
	// Do not put passwords in your CDK code directly.
	// Experimental.
	MasterPassword awscdk.SecretValue `json:"masterPassword"`
}

Username and password combination. Experimental.

type NodeType 

type NodeType string

Possible Node Types to use in the cluster used for defining {@link ClusterProps.nodeType}. Experimental. 

const (
	NodeType_DS2_XLARGE   NodeType = "DS2_XLARGE"
	NodeType_DS2_8XLARGE  NodeType = "DS2_8XLARGE"
	NodeType_DC1_LARGE    NodeType = "DC1_LARGE"
	NodeType_DC1_8XLARGE  NodeType = "DC1_8XLARGE"
	NodeType_DC2_LARGE    NodeType = "DC2_LARGE"
	NodeType_DC2_8XLARGE  NodeType = "DC2_8XLARGE"
	NodeType_RA3_XLPLUS   NodeType = "RA3_XLPLUS"
	NodeType_RA3_4XLARGE  NodeType = "RA3_4XLARGE"
	NodeType_RA3_16XLARGE NodeType = "RA3_16XLARGE"
)

type RotationMultiUserOptions 

type RotationMultiUserOptions struct {
	// The secret to rotate.
	//
	// It must be a JSON string with the following format:
	// “`
	// {
	//    "engine": <required: database engine>,
	//    "host": <required: instance host name>,
	//    "username": <required: username>,
	//    "password": <required: password>,
	//    "dbname": <optional: database name>,
	//    "port": <optional: if not specified, default port will be used>,
	//    "masterarn": <required: the arn of the master secret which will be used to create users/change passwords>
	// }
	// “`
	// Experimental.
	Secret awssecretsmanager.ISecret `json:"secret"`
	// Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.
	// Experimental.
	AutomaticallyAfter awscdk.Duration `json:"automaticallyAfter"`
}

Options to add the multi user rotation. Experimental.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.