Documentation
¶
Index ¶
- func CfnNamespace_CFN_RESOURCE_TYPE_NAME() *string
- func CfnNamespace_IsCfnElement(x interface{}) *bool
- func CfnNamespace_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnNamespace_IsConstruct(x interface{}) *bool
- func CfnWorkgroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnWorkgroup_IsCfnElement(x interface{}) *bool
- func CfnWorkgroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnWorkgroup_IsConstruct(x interface{}) *bool
- func NewCfnNamespace_Override(c CfnNamespace, scope awscdk.Construct, id *string, props *CfnNamespaceProps)
- func NewCfnWorkgroup_Override(c CfnWorkgroup, scope awscdk.Construct, id *string, props *CfnWorkgroupProps)
- type CfnNamespace
- type CfnNamespaceProps
- type CfnNamespace_NamespaceProperty
- type CfnWorkgroup
- type CfnWorkgroupProps
- type CfnWorkgroup_ConfigParameterProperty
- type CfnWorkgroup_EndpointProperty
- type CfnWorkgroup_NetworkInterfaceProperty
- type CfnWorkgroup_VpcEndpointProperty
- type CfnWorkgroup_WorkgroupProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnNamespace_CFN_RESOURCE_TYPE_NAME ¶
func CfnNamespace_CFN_RESOURCE_TYPE_NAME() *string
func CfnNamespace_IsCfnElement ¶
func CfnNamespace_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 CfnNamespace_IsCfnResource ¶
func CfnNamespace_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnNamespace_IsConstruct ¶
func CfnNamespace_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnWorkgroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnWorkgroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnWorkgroup_IsCfnElement ¶
func CfnWorkgroup_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 CfnWorkgroup_IsCfnResource ¶
func CfnWorkgroup_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnWorkgroup_IsConstruct ¶
func CfnWorkgroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnNamespace_Override ¶
func NewCfnNamespace_Override(c CfnNamespace, scope awscdk.Construct, id *string, props *CfnNamespaceProps)
Create a new `AWS::RedshiftServerless::Namespace`.
func NewCfnWorkgroup_Override ¶
func NewCfnWorkgroup_Override(c CfnWorkgroup, scope awscdk.Construct, id *string, props *CfnWorkgroupProps)
Create a new `AWS::RedshiftServerless::Workgroup`.
Types ¶
type CfnNamespace ¶
type CfnNamespace interface {
awscdk.CfnResource
awscdk.IInspectable
// The username of the administrator for the primary database created in the namespace.
AdminUsername() *string
SetAdminUsername(val *string)
// The password of the administrator for the primary database created in the namespace.
AdminUserPassword() *string
SetAdminUserPassword(val *string)
AttrNamespaceAdminUsername() *string
AttrNamespaceCreationDate() *string
AttrNamespaceDbName() *string
AttrNamespaceDefaultIamRoleArn() *string
AttrNamespaceIamRoles() *[]*string
AttrNamespaceKmsKeyId() *string
AttrNamespaceLogExports() *[]*string
AttrNamespaceNamespaceArn() *string
AttrNamespaceNamespaceId() *string
AttrNamespaceNamespaceName() *string
AttrNamespaceStatus() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// The name of the primary database created in the namespace.
DbName() *string
SetDbName(val *string)
// The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
DefaultIamRoleArn() *string
SetDefaultIamRoleArn(val *string)
// The name of the snapshot to be created before the namespace is deleted.
FinalSnapshotName() *string
SetFinalSnapshotName(val *string)
// How long to retain the final snapshot.
FinalSnapshotRetentionPeriod() *float64
SetFinalSnapshotRetentionPeriod(val *float64)
// A list of IAM roles to associate with the namespace.
IamRoles() *[]*string
SetIamRoles(val *[]*string)
// The ID of the AWS Key Management Service key used to encrypt your data.
KmsKeyId() *string
SetKmsKeyId(val *string)
// The types of logs the namespace can export.
//
// Available export types are `userlog` , `connectionlog` , and `useractivitylog` .
LogExports() *[]*string
SetLogExports(val *[]*string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// `AWS::RedshiftServerless::Namespace.Namespace`.
Namespace() interface{}
SetNamespace(val interface{})
// The name of the namespace.
NamespaceName() *string
SetNamespaceName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The map of the key-value pairs used to tag the namespace.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::RedshiftServerless::Namespace`.
A collection of database objects and users.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnNamespace := awscdk.Aws_redshiftserverless.NewCfnNamespace(this, jsii.String("MyCfnNamespace"), &cfnNamespaceProps{
namespaceName: jsii.String("namespaceName"),
// the properties below are optional
adminUsername: jsii.String("adminUsername"),
adminUserPassword: jsii.String("adminUserPassword"),
dbName: jsii.String("dbName"),
defaultIamRoleArn: jsii.String("defaultIamRoleArn"),
finalSnapshotName: jsii.String("finalSnapshotName"),
finalSnapshotRetentionPeriod: jsii.Number(123),
iamRoles: []*string{
jsii.String("iamRoles"),
},
kmsKeyId: jsii.String("kmsKeyId"),
logExports: []*string{
jsii.String("logExports"),
},
namespace: &namespaceProperty{
adminUsername: jsii.String("adminUsername"),
creationDate: jsii.String("creationDate"),
dbName: jsii.String("dbName"),
defaultIamRoleArn: jsii.String("defaultIamRoleArn"),
iamRoles: []*string{
jsii.String("iamRoles"),
},
kmsKeyId: jsii.String("kmsKeyId"),
logExports: []*string{
jsii.String("logExports"),
},
namespaceArn: jsii.String("namespaceArn"),
namespaceId: jsii.String("namespaceId"),
namespaceName: jsii.String("namespaceName"),
status: jsii.String("status"),
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnNamespace ¶
func NewCfnNamespace(scope awscdk.Construct, id *string, props *CfnNamespaceProps) CfnNamespace
Create a new `AWS::RedshiftServerless::Namespace`.
type CfnNamespaceProps ¶
type CfnNamespaceProps struct {
// The name of the namespace.
NamespaceName *string `field:"required" json:"namespaceName" yaml:"namespaceName"`
// The username of the administrator for the primary database created in the namespace.
AdminUsername *string `field:"optional" json:"adminUsername" yaml:"adminUsername"`
// The password of the administrator for the primary database created in the namespace.
AdminUserPassword *string `field:"optional" json:"adminUserPassword" yaml:"adminUserPassword"`
// The name of the primary database created in the namespace.
DbName *string `field:"optional" json:"dbName" yaml:"dbName"`
// The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
DefaultIamRoleArn *string `field:"optional" json:"defaultIamRoleArn" yaml:"defaultIamRoleArn"`
// The name of the snapshot to be created before the namespace is deleted.
FinalSnapshotName *string `field:"optional" json:"finalSnapshotName" yaml:"finalSnapshotName"`
// How long to retain the final snapshot.
FinalSnapshotRetentionPeriod *float64 `field:"optional" json:"finalSnapshotRetentionPeriod" yaml:"finalSnapshotRetentionPeriod"`
// A list of IAM roles to associate with the namespace.
IamRoles *[]*string `field:"optional" json:"iamRoles" yaml:"iamRoles"`
// The ID of the AWS Key Management Service key used to encrypt your data.
KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"`
// The types of logs the namespace can export.
//
// Available export types are `userlog` , `connectionlog` , and `useractivitylog` .
LogExports *[]*string `field:"optional" json:"logExports" yaml:"logExports"`
// `AWS::RedshiftServerless::Namespace.Namespace`.
Namespace interface{} `field:"optional" json:"namespace" yaml:"namespace"`
// The map of the key-value pairs used to tag the namespace.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnNamespace`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnNamespaceProps := &cfnNamespaceProps{
namespaceName: jsii.String("namespaceName"),
// the properties below are optional
adminUsername: jsii.String("adminUsername"),
adminUserPassword: jsii.String("adminUserPassword"),
dbName: jsii.String("dbName"),
defaultIamRoleArn: jsii.String("defaultIamRoleArn"),
finalSnapshotName: jsii.String("finalSnapshotName"),
finalSnapshotRetentionPeriod: jsii.Number(123),
iamRoles: []*string{
jsii.String("iamRoles"),
},
kmsKeyId: jsii.String("kmsKeyId"),
logExports: []*string{
jsii.String("logExports"),
},
namespace: &namespaceProperty{
adminUsername: jsii.String("adminUsername"),
creationDate: jsii.String("creationDate"),
dbName: jsii.String("dbName"),
defaultIamRoleArn: jsii.String("defaultIamRoleArn"),
iamRoles: []*string{
jsii.String("iamRoles"),
},
kmsKeyId: jsii.String("kmsKeyId"),
logExports: []*string{
jsii.String("logExports"),
},
namespaceArn: jsii.String("namespaceArn"),
namespaceId: jsii.String("namespaceId"),
namespaceName: jsii.String("namespaceName"),
status: jsii.String("status"),
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnNamespace_NamespaceProperty ¶
type CfnNamespace_NamespaceProperty struct {
// The username of the administrator for the first database created in the namespace.
AdminUsername *string `field:"optional" json:"adminUsername" yaml:"adminUsername"`
// The date of when the namespace was created.
CreationDate *string `field:"optional" json:"creationDate" yaml:"creationDate"`
// The name of the first database created in the namespace.
DbName *string `field:"optional" json:"dbName" yaml:"dbName"`
// The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
DefaultIamRoleArn *string `field:"optional" json:"defaultIamRoleArn" yaml:"defaultIamRoleArn"`
// A list of IAM roles to associate with the namespace.
IamRoles *[]*string `field:"optional" json:"iamRoles" yaml:"iamRoles"`
// The ID of the AWS Key Management Service key used to encrypt your data.
KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"`
// The types of logs the namespace can export.
//
// Available export types are User log, Connection log, and User activity log.
LogExports *[]*string `field:"optional" json:"logExports" yaml:"logExports"`
// The Amazon Resource Name (ARN) associated with a namespace.
NamespaceArn *string `field:"optional" json:"namespaceArn" yaml:"namespaceArn"`
// The unique identifier of a namespace.
NamespaceId *string `field:"optional" json:"namespaceId" yaml:"namespaceId"`
// The name of the namespace.
//
// Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in [Reserved Words](https://docs.aws.amazon.com//redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide.
NamespaceName *string `field:"optional" json:"namespaceName" yaml:"namespaceName"`
// The status of the namespace.
Status *string `field:"optional" json:"status" yaml:"status"`
}
A collection of database objects and users.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
namespaceProperty := &namespaceProperty{
adminUsername: jsii.String("adminUsername"),
creationDate: jsii.String("creationDate"),
dbName: jsii.String("dbName"),
defaultIamRoleArn: jsii.String("defaultIamRoleArn"),
iamRoles: []*string{
jsii.String("iamRoles"),
},
kmsKeyId: jsii.String("kmsKeyId"),
logExports: []*string{
jsii.String("logExports"),
},
namespaceArn: jsii.String("namespaceArn"),
namespaceId: jsii.String("namespaceId"),
namespaceName: jsii.String("namespaceName"),
status: jsii.String("status"),
}
type CfnWorkgroup ¶
type CfnWorkgroup interface {
awscdk.CfnResource
awscdk.IInspectable
AttrWorkgroupBaseCapacity() *float64
AttrWorkgroupCreationDate() *string
AttrWorkgroupEndpointAddress() *string
AttrWorkgroupEndpointPort() *float64
AttrWorkgroupEnhancedVpcRouting() awscdk.IResolvable
AttrWorkgroupNamespaceName() *string
AttrWorkgroupPubliclyAccessible() awscdk.IResolvable
AttrWorkgroupSecurityGroupIds() *[]*string
AttrWorkgroupStatus() *string
AttrWorkgroupSubnetIds() *[]*string
AttrWorkgroupWorkgroupArn() *string
AttrWorkgroupWorkgroupId() *string
AttrWorkgroupWorkgroupName() *string
// The base compute capacity of the workgroup in Redshift Processing Units (RPUs).
BaseCapacity() *float64
SetBaseCapacity(val *float64)
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// A list of parameters to set for finer control over a database.
//
// Available options are `datestyle` , `enable_user_activity_logging` , `query_group` , `search_path` , and `max_query_execution_time` .
ConfigParameters() interface{}
SetConfigParameters(val interface{})
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
EnhancedVpcRouting() interface{}
SetEnhancedVpcRouting(val interface{})
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// The namespace the workgroup is associated with.
NamespaceName() *string
SetNamespaceName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// A value that specifies whether the workgroup can be accessible from a public network.
PubliclyAccessible() interface{}
SetPubliclyAccessible(val interface{})
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// A list of security group IDs to associate with the workgroup.
SecurityGroupIds() *[]*string
SetSecurityGroupIds(val *[]*string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// A list of subnet IDs the workgroup is associated with.
SubnetIds() *[]*string
SetSubnetIds(val *[]*string)
// The map of the key-value pairs used to tag the workgroup.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// `AWS::RedshiftServerless::Workgroup.Workgroup`.
Workgroup() interface{}
SetWorkgroup(val interface{})
// The name of the workgroup.
WorkgroupName() *string
SetWorkgroupName(val *string)
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::RedshiftServerless::Workgroup`.
The collection of compute resources in Amazon Redshift Serverless.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnWorkgroup := awscdk.Aws_redshiftserverless.NewCfnWorkgroup(this, jsii.String("MyCfnWorkgroup"), &cfnWorkgroupProps{
workgroupName: jsii.String("workgroupName"),
// the properties below are optional
baseCapacity: jsii.Number(123),
configParameters: []interface{}{
&configParameterProperty{
parameterKey: jsii.String("parameterKey"),
parameterValue: jsii.String("parameterValue"),
},
},
enhancedVpcRouting: jsii.Boolean(false),
namespaceName: jsii.String("namespaceName"),
publiclyAccessible: jsii.Boolean(false),
securityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
subnetIds: []*string{
jsii.String("subnetIds"),
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
workgroup: &workgroupProperty{
baseCapacity: jsii.Number(123),
configParameters: []interface{}{
&configParameterProperty{
parameterKey: jsii.String("parameterKey"),
parameterValue: jsii.String("parameterValue"),
},
},
creationDate: jsii.String("creationDate"),
endpoint: &endpointProperty{
address: jsii.String("address"),
port: jsii.Number(123),
vpcEndpoints: []interface{}{
&vpcEndpointProperty{
networkInterfaces: []interface{}{
&networkInterfaceProperty{
availabilityZone: jsii.String("availabilityZone"),
networkInterfaceId: jsii.String("networkInterfaceId"),
privateIpAddress: jsii.String("privateIpAddress"),
subnetId: jsii.String("subnetId"),
},
},
vpcEndpointId: jsii.String("vpcEndpointId"),
vpcId: jsii.String("vpcId"),
},
},
},
enhancedVpcRouting: jsii.Boolean(false),
namespaceName: jsii.String("namespaceName"),
publiclyAccessible: jsii.Boolean(false),
securityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
status: jsii.String("status"),
subnetIds: []*string{
jsii.String("subnetIds"),
},
workgroupArn: jsii.String("workgroupArn"),
workgroupId: jsii.String("workgroupId"),
workgroupName: jsii.String("workgroupName"),
},
})
func NewCfnWorkgroup ¶
func NewCfnWorkgroup(scope awscdk.Construct, id *string, props *CfnWorkgroupProps) CfnWorkgroup
Create a new `AWS::RedshiftServerless::Workgroup`.
type CfnWorkgroupProps ¶
type CfnWorkgroupProps struct {
// The name of the workgroup.
WorkgroupName *string `field:"required" json:"workgroupName" yaml:"workgroupName"`
// The base compute capacity of the workgroup in Redshift Processing Units (RPUs).
BaseCapacity *float64 `field:"optional" json:"baseCapacity" yaml:"baseCapacity"`
// A list of parameters to set for finer control over a database.
//
// Available options are `datestyle` , `enable_user_activity_logging` , `query_group` , `search_path` , and `max_query_execution_time` .
ConfigParameters interface{} `field:"optional" json:"configParameters" yaml:"configParameters"`
// The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
EnhancedVpcRouting interface{} `field:"optional" json:"enhancedVpcRouting" yaml:"enhancedVpcRouting"`
// The namespace the workgroup is associated with.
NamespaceName *string `field:"optional" json:"namespaceName" yaml:"namespaceName"`
// A value that specifies whether the workgroup can be accessible from a public network.
PubliclyAccessible interface{} `field:"optional" json:"publiclyAccessible" yaml:"publiclyAccessible"`
// A list of security group IDs to associate with the workgroup.
SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"`
// A list of subnet IDs the workgroup is associated with.
SubnetIds *[]*string `field:"optional" json:"subnetIds" yaml:"subnetIds"`
// The map of the key-value pairs used to tag the workgroup.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// `AWS::RedshiftServerless::Workgroup.Workgroup`.
Workgroup interface{} `field:"optional" json:"workgroup" yaml:"workgroup"`
}
Properties for defining a `CfnWorkgroup`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnWorkgroupProps := &cfnWorkgroupProps{
workgroupName: jsii.String("workgroupName"),
// the properties below are optional
baseCapacity: jsii.Number(123),
configParameters: []interface{}{
&configParameterProperty{
parameterKey: jsii.String("parameterKey"),
parameterValue: jsii.String("parameterValue"),
},
},
enhancedVpcRouting: jsii.Boolean(false),
namespaceName: jsii.String("namespaceName"),
publiclyAccessible: jsii.Boolean(false),
securityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
subnetIds: []*string{
jsii.String("subnetIds"),
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
workgroup: &workgroupProperty{
baseCapacity: jsii.Number(123),
configParameters: []interface{}{
&configParameterProperty{
parameterKey: jsii.String("parameterKey"),
parameterValue: jsii.String("parameterValue"),
},
},
creationDate: jsii.String("creationDate"),
endpoint: &endpointProperty{
address: jsii.String("address"),
port: jsii.Number(123),
vpcEndpoints: []interface{}{
&vpcEndpointProperty{
networkInterfaces: []interface{}{
&networkInterfaceProperty{
availabilityZone: jsii.String("availabilityZone"),
networkInterfaceId: jsii.String("networkInterfaceId"),
privateIpAddress: jsii.String("privateIpAddress"),
subnetId: jsii.String("subnetId"),
},
},
vpcEndpointId: jsii.String("vpcEndpointId"),
vpcId: jsii.String("vpcId"),
},
},
},
enhancedVpcRouting: jsii.Boolean(false),
namespaceName: jsii.String("namespaceName"),
publiclyAccessible: jsii.Boolean(false),
securityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
status: jsii.String("status"),
subnetIds: []*string{
jsii.String("subnetIds"),
},
workgroupArn: jsii.String("workgroupArn"),
workgroupId: jsii.String("workgroupId"),
workgroupName: jsii.String("workgroupName"),
},
}
type CfnWorkgroup_ConfigParameterProperty ¶
type CfnWorkgroup_ConfigParameterProperty struct {
// The key of the parameter.
//
// The options are `datestyle` , `enable_user_activity_logging` , `query_group` , `search_path` , and `max_query_execution_time` .
ParameterKey *string `field:"optional" json:"parameterKey" yaml:"parameterKey"`
// The value of the parameter to set.
ParameterValue *string `field:"optional" json:"parameterValue" yaml:"parameterValue"`
}
A array of parameters to set for more control over a serverless database.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
configParameterProperty := &configParameterProperty{
parameterKey: jsii.String("parameterKey"),
parameterValue: jsii.String("parameterValue"),
}
type CfnWorkgroup_EndpointProperty ¶
type CfnWorkgroup_EndpointProperty struct {
// The DNS address of the VPC endpoint.
Address *string `field:"optional" json:"address" yaml:"address"`
// The port that Amazon Redshift Serverless listens on.
Port *float64 `field:"optional" json:"port" yaml:"port"`
// An array of `VpcEndpoint` objects.
VpcEndpoints interface{} `field:"optional" json:"vpcEndpoints" yaml:"vpcEndpoints"`
}
The VPC endpoint object.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
endpointProperty := &endpointProperty{
address: jsii.String("address"),
port: jsii.Number(123),
vpcEndpoints: []interface{}{
&vpcEndpointProperty{
networkInterfaces: []interface{}{
&networkInterfaceProperty{
availabilityZone: jsii.String("availabilityZone"),
networkInterfaceId: jsii.String("networkInterfaceId"),
privateIpAddress: jsii.String("privateIpAddress"),
subnetId: jsii.String("subnetId"),
},
},
vpcEndpointId: jsii.String("vpcEndpointId"),
vpcId: jsii.String("vpcId"),
},
},
}
type CfnWorkgroup_NetworkInterfaceProperty ¶
type CfnWorkgroup_NetworkInterfaceProperty struct {
// The availability Zone.
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// The unique identifier of the network interface.
NetworkInterfaceId *string `field:"optional" json:"networkInterfaceId" yaml:"networkInterfaceId"`
// The IPv4 address of the network interface within the subnet.
PrivateIpAddress *string `field:"optional" json:"privateIpAddress" yaml:"privateIpAddress"`
// The unique identifier of the subnet.
SubnetId *string `field:"optional" json:"subnetId" yaml:"subnetId"`
}
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
networkInterfaceProperty := &networkInterfaceProperty{
availabilityZone: jsii.String("availabilityZone"),
networkInterfaceId: jsii.String("networkInterfaceId"),
privateIpAddress: jsii.String("privateIpAddress"),
subnetId: jsii.String("subnetId"),
}
type CfnWorkgroup_VpcEndpointProperty ¶
type CfnWorkgroup_VpcEndpointProperty struct {
// One or more network interfaces of the endpoint.
//
// Also known as an interface endpoint.
NetworkInterfaces interface{} `field:"optional" json:"networkInterfaces" yaml:"networkInterfaces"`
// The connection endpoint ID for connecting to Amazon Redshift Serverless.
VpcEndpointId *string `field:"optional" json:"vpcEndpointId" yaml:"vpcEndpointId"`
// The VPC identifier that the endpoint is associated with.
VpcId *string `field:"optional" json:"vpcId" yaml:"vpcId"`
}
The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
vpcEndpointProperty := &vpcEndpointProperty{
networkInterfaces: []interface{}{
&networkInterfaceProperty{
availabilityZone: jsii.String("availabilityZone"),
networkInterfaceId: jsii.String("networkInterfaceId"),
privateIpAddress: jsii.String("privateIpAddress"),
subnetId: jsii.String("subnetId"),
},
},
vpcEndpointId: jsii.String("vpcEndpointId"),
vpcId: jsii.String("vpcId"),
}
type CfnWorkgroup_WorkgroupProperty ¶
type CfnWorkgroup_WorkgroupProperty struct {
// The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
BaseCapacity *float64 `field:"optional" json:"baseCapacity" yaml:"baseCapacity"`
// An array of parameters to set for finer control over a database.
//
// The options are `datestyle` , `enable_user_activity_logging` , `query_group` , `search_path` , and `max_query_execution_time` .
ConfigParameters interface{} `field:"optional" json:"configParameters" yaml:"configParameters"`
// The creation date of the workgroup.
CreationDate *string `field:"optional" json:"creationDate" yaml:"creationDate"`
// The endpoint that is created from the workgroup.
Endpoint interface{} `field:"optional" json:"endpoint" yaml:"endpoint"`
// The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
EnhancedVpcRouting interface{} `field:"optional" json:"enhancedVpcRouting" yaml:"enhancedVpcRouting"`
// The namespace the workgroup is associated with.
NamespaceName *string `field:"optional" json:"namespaceName" yaml:"namespaceName"`
// A value that specifies whether the workgroup can be accessible from a public network.
PubliclyAccessible interface{} `field:"optional" json:"publiclyAccessible" yaml:"publiclyAccessible"`
// An array of security group IDs to associate with the workgroup.
SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"`
// The status of the workgroup.
Status *string `field:"optional" json:"status" yaml:"status"`
// An array of subnet IDs the workgroup is associated with.
SubnetIds *[]*string `field:"optional" json:"subnetIds" yaml:"subnetIds"`
// The Amazon Resource Name (ARN) that links to the workgroup.
WorkgroupArn *string `field:"optional" json:"workgroupArn" yaml:"workgroupArn"`
// The unique identifier of the workgroup.
WorkgroupId *string `field:"optional" json:"workgroupId" yaml:"workgroupId"`
// The name of the workgroup.
WorkgroupName *string `field:"optional" json:"workgroupName" yaml:"workgroupName"`
}
The collection of computing resources from which an endpoint is created.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
workgroupProperty := &workgroupProperty{
baseCapacity: jsii.Number(123),
configParameters: []interface{}{
&configParameterProperty{
parameterKey: jsii.String("parameterKey"),
parameterValue: jsii.String("parameterValue"),
},
},
creationDate: jsii.String("creationDate"),
endpoint: &endpointProperty{
address: jsii.String("address"),
port: jsii.Number(123),
vpcEndpoints: []interface{}{
&vpcEndpointProperty{
networkInterfaces: []interface{}{
&networkInterfaceProperty{
availabilityZone: jsii.String("availabilityZone"),
networkInterfaceId: jsii.String("networkInterfaceId"),
privateIpAddress: jsii.String("privateIpAddress"),
subnetId: jsii.String("subnetId"),
},
},
vpcEndpointId: jsii.String("vpcEndpointId"),
vpcId: jsii.String("vpcId"),
},
},
},
enhancedVpcRouting: jsii.Boolean(false),
namespaceName: jsii.String("namespaceName"),
publiclyAccessible: jsii.Boolean(false),
securityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
status: jsii.String("status"),
subnetIds: []*string{
jsii.String("subnetIds"),
},
workgroupArn: jsii.String("workgroupArn"),
workgroupId: jsii.String("workgroupId"),
workgroupName: jsii.String("workgroupName"),
}
Source Files
¶
- awsredshiftserverless.go
- awsredshiftserverless_CfnNamespace.go
- awsredshiftserverless_CfnNamespaceProps.go
- awsredshiftserverless_CfnNamespace_NamespaceProperty.go
- awsredshiftserverless_CfnNamespace__runtime_type_checks.go
- awsredshiftserverless_CfnWorkgroup.go
- awsredshiftserverless_CfnWorkgroupProps.go
- awsredshiftserverless_CfnWorkgroup_ConfigParameterProperty.go
- awsredshiftserverless_CfnWorkgroup_EndpointProperty.go
- awsredshiftserverless_CfnWorkgroup_NetworkInterfaceProperty.go
- awsredshiftserverless_CfnWorkgroup_VpcEndpointProperty.go
- awsredshiftserverless_CfnWorkgroup_WorkgroupProperty.go
- awsredshiftserverless_CfnWorkgroup__runtime_type_checks.go