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 CfnWorkgroup
- type CfnWorkgroupProps
- type CfnWorkgroup_ConfigParameterProperty
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
// `AWS::RedshiftServerless::Namespace.AdminUsername`.
AdminUsername() *string
SetAdminUsername(val *string)
// `AWS::RedshiftServerless::Namespace.AdminUserPassword`.
AdminUserPassword() *string
SetAdminUserPassword(val *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
// `AWS::RedshiftServerless::Namespace.DbName`.
DbName() *string
SetDbName(val *string)
// `AWS::RedshiftServerless::Namespace.DefaultIamRoleArn`.
DefaultIamRoleArn() *string
SetDefaultIamRoleArn(val *string)
// `AWS::RedshiftServerless::Namespace.FinalSnapshotName`.
FinalSnapshotName() *string
SetFinalSnapshotName(val *string)
// `AWS::RedshiftServerless::Namespace.FinalSnapshotRetentionPeriod`.
FinalSnapshotRetentionPeriod() *float64
SetFinalSnapshotRetentionPeriod(val *float64)
// `AWS::RedshiftServerless::Namespace.IamRoles`.
IamRoles() *[]*string
SetIamRoles(val *[]*string)
// `AWS::RedshiftServerless::Namespace.KmsKeyId`.
KmsKeyId() *string
SetKmsKeyId(val *string)
// `AWS::RedshiftServerless::Namespace.LogExports`.
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.NamespaceName`.
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
// `AWS::RedshiftServerless::Namespace.Tags`.
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`.
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"),
},
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 {
// `AWS::RedshiftServerless::Namespace.NamespaceName`.
NamespaceName *string `field:"required" json:"namespaceName" yaml:"namespaceName"`
// `AWS::RedshiftServerless::Namespace.AdminUsername`.
AdminUsername *string `field:"optional" json:"adminUsername" yaml:"adminUsername"`
// `AWS::RedshiftServerless::Namespace.AdminUserPassword`.
AdminUserPassword *string `field:"optional" json:"adminUserPassword" yaml:"adminUserPassword"`
// `AWS::RedshiftServerless::Namespace.DbName`.
DbName *string `field:"optional" json:"dbName" yaml:"dbName"`
// `AWS::RedshiftServerless::Namespace.DefaultIamRoleArn`.
DefaultIamRoleArn *string `field:"optional" json:"defaultIamRoleArn" yaml:"defaultIamRoleArn"`
// `AWS::RedshiftServerless::Namespace.FinalSnapshotName`.
FinalSnapshotName *string `field:"optional" json:"finalSnapshotName" yaml:"finalSnapshotName"`
// `AWS::RedshiftServerless::Namespace.FinalSnapshotRetentionPeriod`.
FinalSnapshotRetentionPeriod *float64 `field:"optional" json:"finalSnapshotRetentionPeriod" yaml:"finalSnapshotRetentionPeriod"`
// `AWS::RedshiftServerless::Namespace.IamRoles`.
IamRoles *[]*string `field:"optional" json:"iamRoles" yaml:"iamRoles"`
// `AWS::RedshiftServerless::Namespace.KmsKeyId`.
KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"`
// `AWS::RedshiftServerless::Namespace.LogExports`.
LogExports *[]*string `field:"optional" json:"logExports" yaml:"logExports"`
// `AWS::RedshiftServerless::Namespace.Tags`.
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"),
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnWorkgroup ¶
type CfnWorkgroup interface {
awscdk.CfnResource
awscdk.IInspectable
// `AWS::RedshiftServerless::Workgroup.BaseCapacity`.
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
// `AWS::RedshiftServerless::Workgroup.ConfigParameters`.
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
// `AWS::RedshiftServerless::Workgroup.EnhancedVpcRouting`.
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
// `AWS::RedshiftServerless::Workgroup.NamespaceName`.
NamespaceName() *string
SetNamespaceName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// `AWS::RedshiftServerless::Workgroup.PubliclyAccessible`.
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
// `AWS::RedshiftServerless::Workgroup.SecurityGroupIds`.
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
// `AWS::RedshiftServerless::Workgroup.SubnetIds`.
SubnetIds() *[]*string
SetSubnetIds(val *[]*string)
// `AWS::RedshiftServerless::Workgroup.Tags`.
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.WorkgroupName`.
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`.
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"),
},
},
})
func NewCfnWorkgroup ¶
func NewCfnWorkgroup(scope awscdk.Construct, id *string, props *CfnWorkgroupProps) CfnWorkgroup
Create a new `AWS::RedshiftServerless::Workgroup`.
type CfnWorkgroupProps ¶
type CfnWorkgroupProps struct {
// `AWS::RedshiftServerless::Workgroup.WorkgroupName`.
WorkgroupName *string `field:"required" json:"workgroupName" yaml:"workgroupName"`
// `AWS::RedshiftServerless::Workgroup.BaseCapacity`.
BaseCapacity *float64 `field:"optional" json:"baseCapacity" yaml:"baseCapacity"`
// `AWS::RedshiftServerless::Workgroup.ConfigParameters`.
ConfigParameters interface{} `field:"optional" json:"configParameters" yaml:"configParameters"`
// `AWS::RedshiftServerless::Workgroup.EnhancedVpcRouting`.
EnhancedVpcRouting interface{} `field:"optional" json:"enhancedVpcRouting" yaml:"enhancedVpcRouting"`
// `AWS::RedshiftServerless::Workgroup.NamespaceName`.
NamespaceName *string `field:"optional" json:"namespaceName" yaml:"namespaceName"`
// `AWS::RedshiftServerless::Workgroup.PubliclyAccessible`.
PubliclyAccessible interface{} `field:"optional" json:"publiclyAccessible" yaml:"publiclyAccessible"`
// `AWS::RedshiftServerless::Workgroup.SecurityGroupIds`.
SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"`
// `AWS::RedshiftServerless::Workgroup.SubnetIds`.
SubnetIds *[]*string `field:"optional" json:"subnetIds" yaml:"subnetIds"`
// `AWS::RedshiftServerless::Workgroup.Tags`.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
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"),
},
},
}
type CfnWorkgroup_ConfigParameterProperty ¶
type CfnWorkgroup_ConfigParameterProperty struct {
// `CfnWorkgroup.ConfigParameterProperty.ParameterKey`.
ParameterKey *string `field:"optional" json:"parameterKey" yaml:"parameterKey"`
// `CfnWorkgroup.ConfigParameterProperty.ParameterValue`.
ParameterValue *string `field:"optional" json:"parameterValue" yaml:"parameterValue"`
}
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"),
}
Source Files
¶
- awsredshiftserverless.go
- awsredshiftserverless_CfnNamespace.go
- awsredshiftserverless_CfnNamespaceProps.go
- awsredshiftserverless_CfnNamespace__runtime_type_checks.go
- awsredshiftserverless_CfnWorkgroup.go
- awsredshiftserverless_CfnWorkgroupProps.go
- awsredshiftserverless_CfnWorkgroup_ConfigParameterProperty.go
- awsredshiftserverless_CfnWorkgroup__runtime_type_checks.go