Class: AWSCDK::RedshiftServerless::CfnWorkgroup
- Inherits:
-
CfnResource
- Object
- CfnResource
- AWSCDK::RedshiftServerless::CfnWorkgroup
- Includes:
- IInspectable, ITaggable, Interfaces::AWSRedshiftserverless::IWorkgroupRef
- Defined in:
- redshift_serverless/cfn_workgroup.rb
Overview
The collection of compute resources in Amazon Redshift Serverless.
Class Method Summary collapse
-
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
-
.is_cfn_workgroup(x) ⇒ Boolean
Checks whether the given object is a CfnWorkgroup.
- .jsii_overridable_methods ⇒ Object
Instance Method Summary collapse
-
#add_deletion_override(path) ⇒ void
Syntactic sugar for
addOverride(path, undefined). -
#add_dependency(target) ⇒ void
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
-
#add_depends_on(target) ⇒ void
deprecated
Deprecated.
use addDependency
-
#add_metadata(key, value) ⇒ void
Add a value to the CloudFormation Resource Metadata.
-
#add_override(path, value) ⇒ void
Adds an override to the synthesized CloudFormation resource.
-
#add_property_deletion_override(property_path) ⇒ void
Adds an override that deletes the value of a property from the resource definition.
-
#add_property_override(property_path, value) ⇒ void
Adds an override to a resource property.
-
#apply_cross_stack_reference_strength(strength) ⇒ void
Sets the cross-stack reference strength for this resource.
-
#apply_removal_policy(policy = nil, options = nil) ⇒ void
Sets the deletion policy of the resource based on the removal policy specified.
- #attr_workgroup ⇒ AWSCDK::IResolvable
-
#attr_workgroup_base_capacity ⇒ Numeric
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
- #attr_workgroup_config_parameters ⇒ AWSCDK::IResolvable
-
#attr_workgroup_creation_date ⇒ String
The creation date of the workgroup.
- #attr_workgroup_endpoint ⇒ AWSCDK::IResolvable
-
#attr_workgroup_endpoint_address ⇒ String
The DNS address of the VPC endpoint.
-
#attr_workgroup_endpoint_port ⇒ Numeric
The custom port to use when connecting to a workgroup.
- #attr_workgroup_endpoint_vpc_endpoints ⇒ AWSCDK::IResolvable
-
#attr_workgroup_enhanced_vpc_routing ⇒ AWSCDK::IResolvable
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
-
#attr_workgroup_max_capacity ⇒ Numeric
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.
-
#attr_workgroup_namespace_name ⇒ String
The namespace the workgroup is associated with.
-
#attr_workgroup_publicly_accessible ⇒ AWSCDK::IResolvable
A value that specifies whether the workgroup can be accessible from a public network.
-
#attr_workgroup_security_group_ids ⇒ Array<String>
An array of security group IDs to associate with the workgroup.
-
#attr_workgroup_status ⇒ String
The status of the workgroup.
-
#attr_workgroup_subnet_ids ⇒ Array<String>
An array of subnet IDs the workgroup is associated with.
-
#attr_workgroup_track_name ⇒ String
The name of the track for the workgroup.
-
#attr_workgroup_workgroup_arn ⇒ String
The Amazon Resource Name (ARN) that links to the workgroup.
-
#attr_workgroup_workgroup_id ⇒ String
The unique identifier of the workgroup.
-
#attr_workgroup_workgroup_name ⇒ String
The name of the workgroup.
-
#base_capacity ⇒ Numeric?
The base compute capacity of the workgroup in Redshift Processing Units (RPUs).
- #base_capacity=(value) ⇒ Object
-
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
- #cfn_properties ⇒ Hash{String => Object}
- #cfn_property_name(cdk_property_name) ⇒ String?
- #cfn_property_names ⇒ Hash{String => String}
-
#cfn_resource_type ⇒ String
AWS resource type.
-
#config_parameters ⇒ AWSCDK::IResolvable, ...
The key of the parameter.
- #config_parameters=(value) ⇒ Object
- #creation_stack ⇒ Array<String>
-
#enhanced_vpc_routing ⇒ Boolean, ...
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
- #enhanced_vpc_routing=(value) ⇒ Object
- #env ⇒ AWSCDK::Interfaces::ResourceEnvironment
-
#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference
Returns a token for an runtime attribute of this resource.
-
#get_metadata(key) ⇒ Object
Retrieve a value value from the CloudFormation Resource Metadata.
-
#initialize(scope, id, props) ⇒ CfnWorkgroup
constructor
Create a new
AWS::RedshiftServerless::Workgroup. -
#inspect(inspector) ⇒ void
Examines the CloudFormation resource and discloses attributes.
-
#logical_id ⇒ String
The logical ID for this CloudFormation stack element.
-
#max_capacity ⇒ Numeric?
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.
- #max_capacity=(value) ⇒ Object
-
#namespace_name ⇒ String?
The namespace the workgroup is associated with.
- #namespace_name=(value) ⇒ Object
-
#node ⇒ Constructs::Node
The tree node.
-
#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>
Retrieves an array of resources this resource depends on.
-
#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>
Get a shallow copy of dependencies between this resource and other resources in the same stack.
-
#override_logical_id(new_logical_id) ⇒ void
Overrides the auto-generated logical ID with a specific ID.
-
#port ⇒ Numeric?
The custom port to use when connecting to a workgroup.
- #port=(value) ⇒ Object
-
#price_performance_target ⇒ AWSCDK::IResolvable, ...
An object that represents the price performance target settings for the workgroup.
- #price_performance_target=(value) ⇒ Object
-
#publicly_accessible ⇒ Boolean, ...
A value that specifies whether the workgroup can be accessible from a public network.
- #publicly_accessible=(value) ⇒ Object
-
#recovery_point_id ⇒ String?
The recovery point id to restore from.
- #recovery_point_id=(value) ⇒ Object
-
#ref ⇒ String
Return a string that will be resolved to a CloudFormation
{ Ref }for this element. -
#remove_dependency(target) ⇒ void
Indicates that this resource no longer depends on another resource.
- #render_properties(props) ⇒ Hash{String => Object}
-
#replace_dependency(target, new_target) ⇒ void
Replaces one dependency with another.
-
#security_group_ids ⇒ Array<String>?
A list of security group IDs to associate with the workgroup.
- #security_group_ids=(value) ⇒ Object
-
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
-
#snapshot_arn ⇒ String?
The Amazon Resource Name (ARN) of the snapshot to restore from.
- #snapshot_arn=(value) ⇒ Object
-
#snapshot_name ⇒ String?
The snapshot name to restore from.
- #snapshot_name=(value) ⇒ Object
-
#snapshot_owner_account ⇒ String?
The Amazon Web Services account that owns the snapshot.
- #snapshot_owner_account=(value) ⇒ Object
-
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
-
#subnet_ids ⇒ Array<String>?
A list of subnet IDs the workgroup is associated with.
- #subnet_ids=(value) ⇒ Object
-
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
-
#tags_raw ⇒ Array<AWSCDK::CfnTag>?
The map of the key-value pairs used to tag the workgroup.
- #tags_raw=(value) ⇒ Object
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#track_name ⇒ String?
An optional parameter for the name of the track for the workgroup.
- #track_name=(value) ⇒ Object
-
#updated_properites ⇒ Hash{String => Object}
deprecated
Deprecated.
use
updatedPropertiesReturn properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource. -
#updated_properties ⇒ Hash{String => Object}
Return properties modified after initiation.
- #validate_properties(_properties) ⇒ void
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
-
#workgroup ⇒ AWSCDK::IResolvable, ...
The collection of computing resources from which an endpoint is created.
- #workgroup=(value) ⇒ Object
-
#workgroup_name ⇒ String
The name of the workgroup.
- #workgroup_name=(value) ⇒ Object
-
#workgroup_ref ⇒ AWSCDK::Interfaces::AWSRedshiftserverless::WorkgroupReference
A reference to a Workgroup resource.
Constructor Details
#initialize(scope, id, props) ⇒ CfnWorkgroup
Create a new AWS::RedshiftServerless::Workgroup.
18 19 20 21 22 23 24 |
# File 'redshift_serverless/cfn_workgroup.rb', line 18 def initialize(scope, id, props) props = props.is_a?(Hash) ? ::AWSCDK::RedshiftServerless::CfnWorkgroupProps.new(**props.transform_keys(&:to_sym)) : props Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope") Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id") Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmVkc2hpZnRzZXJ2ZXJsZXNzLkNmbldvcmtncm91cFByb3BzIn0=")), "props") Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
207 208 209 |
# File 'redshift_serverless/cfn_workgroup.rb', line 207 def self.CFN_RESOURCE_TYPE_NAME() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_redshiftserverless.CfnWorkgroup", "CFN_RESOURCE_TYPE_NAME") end |
.is_cfn_workgroup(x) ⇒ Boolean
Checks whether the given object is a CfnWorkgroup.
109 110 111 112 |
# File 'redshift_serverless/cfn_workgroup.rb', line 109 def self.is_cfn_workgroup(x) Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_redshiftserverless.CfnWorkgroup", "isCfnWorkgroup", [x]) end |
.jsii_overridable_methods ⇒ Object
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
# File 'redshift_serverless/cfn_workgroup.rb', line 26 def self.jsii_overridable_methods { :node => { kind: :property, name: "node", is_optional: false }, :creation_stack => { kind: :property, name: "creationStack", is_optional: false }, :logical_id => { kind: :property, name: "logicalId", is_optional: false }, :stack => { kind: :property, name: "stack", is_optional: false }, :ref => { kind: :property, name: "ref", is_optional: false }, :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false }, :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false }, :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false }, :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false }, :env => { kind: :property, name: "env", is_optional: false }, :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false }, :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false }, :attr_workgroup => { kind: :property, name: "attrWorkgroup", is_optional: false }, :attr_workgroup_base_capacity => { kind: :property, name: "attrWorkgroupBaseCapacity", is_optional: false }, :attr_workgroup_config_parameters => { kind: :property, name: "attrWorkgroupConfigParameters", is_optional: false }, :attr_workgroup_creation_date => { kind: :property, name: "attrWorkgroupCreationDate", is_optional: false }, :attr_workgroup_endpoint => { kind: :property, name: "attrWorkgroupEndpoint", is_optional: false }, :attr_workgroup_endpoint_address => { kind: :property, name: "attrWorkgroupEndpointAddress", is_optional: false }, :attr_workgroup_endpoint_port => { kind: :property, name: "attrWorkgroupEndpointPort", is_optional: false }, :attr_workgroup_endpoint_vpc_endpoints => { kind: :property, name: "attrWorkgroupEndpointVpcEndpoints", is_optional: false }, :attr_workgroup_enhanced_vpc_routing => { kind: :property, name: "attrWorkgroupEnhancedVpcRouting", is_optional: false }, :attr_workgroup_max_capacity => { kind: :property, name: "attrWorkgroupMaxCapacity", is_optional: false }, :attr_workgroup_namespace_name => { kind: :property, name: "attrWorkgroupNamespaceName", is_optional: false }, :attr_workgroup_publicly_accessible => { kind: :property, name: "attrWorkgroupPubliclyAccessible", is_optional: false }, :attr_workgroup_security_group_ids => { kind: :property, name: "attrWorkgroupSecurityGroupIds", is_optional: false }, :attr_workgroup_status => { kind: :property, name: "attrWorkgroupStatus", is_optional: false }, :attr_workgroup_subnet_ids => { kind: :property, name: "attrWorkgroupSubnetIds", is_optional: false }, :attr_workgroup_track_name => { kind: :property, name: "attrWorkgroupTrackName", is_optional: false }, :attr_workgroup_workgroup_arn => { kind: :property, name: "attrWorkgroupWorkgroupArn", is_optional: false }, :attr_workgroup_workgroup_id => { kind: :property, name: "attrWorkgroupWorkgroupId", is_optional: false }, :attr_workgroup_workgroup_name => { kind: :property, name: "attrWorkgroupWorkgroupName", is_optional: false }, :tags => { kind: :property, name: "tags", is_optional: false }, :workgroup_ref => { kind: :property, name: "workgroupRef", is_optional: false }, :workgroup_name => { kind: :property, name: "workgroupName", is_optional: false }, :base_capacity => { kind: :property, name: "baseCapacity", is_optional: true }, :config_parameters => { kind: :property, name: "configParameters", is_optional: true }, :enhanced_vpc_routing => { kind: :property, name: "enhancedVpcRouting", is_optional: true }, :max_capacity => { kind: :property, name: "maxCapacity", is_optional: true }, :namespace_name => { kind: :property, name: "namespaceName", is_optional: true }, :port => { kind: :property, name: "port", is_optional: true }, :price_performance_target => { kind: :property, name: "pricePerformanceTarget", is_optional: true }, :publicly_accessible => { kind: :property, name: "publiclyAccessible", is_optional: true }, :recovery_point_id => { kind: :property, name: "recoveryPointId", is_optional: true }, :security_group_ids => { kind: :property, name: "securityGroupIds", is_optional: true }, :snapshot_arn => { kind: :property, name: "snapshotArn", is_optional: true }, :snapshot_name => { kind: :property, name: "snapshotName", is_optional: true }, :snapshot_owner_account => { kind: :property, name: "snapshotOwnerAccount", is_optional: true }, :subnet_ids => { kind: :property, name: "subnetIds", is_optional: true }, :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true }, :track_name => { kind: :property, name: "trackName", is_optional: true }, :workgroup => { kind: :property, name: "workgroup", is_optional: true }, :to_string => { kind: :method, name: "toString", is_optional: false }, :with => { kind: :method, name: "with", is_optional: false }, :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false }, :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false }, :add_dependency => { kind: :method, name: "addDependency", is_optional: false }, :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false }, :add_metadata => { kind: :method, name: "addMetadata", is_optional: false }, :add_override => { kind: :method, name: "addOverride", is_optional: false }, :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false }, :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false }, :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false }, :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false }, :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false }, :get_att => { kind: :method, name: "getAtt", is_optional: false }, :get_metadata => { kind: :method, name: "getMetadata", is_optional: false }, :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false }, :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false }, :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false }, :render_properties => { kind: :method, name: "renderProperties", is_optional: false }, :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false }, :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false }, :validate_properties => { kind: :method, name: "validateProperties", is_optional: false }, :inspect => { kind: :method, name: "inspect", is_optional: false }, } end |
Instance Method Details
#add_deletion_override(path) ⇒ void
This method returns an undefined value.
Syntactic sugar for addOverride(path, undefined).
609 610 611 612 |
# File 'redshift_serverless/cfn_workgroup.rb', line 609 def add_deletion_override(path) Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") jsii_call_method("addDeletionOverride", [path]) end |
#add_dependency(target) ⇒ void
This method returns an undefined value.
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.
621 622 623 624 |
# File 'redshift_serverless/cfn_workgroup.rb', line 621 def add_dependency(target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") jsii_call_method("addDependency", [target]) end |
#add_depends_on(target) ⇒ void
use addDependency
This method returns an undefined value.
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
631 632 633 634 |
# File 'redshift_serverless/cfn_workgroup.rb', line 631 def add_depends_on(target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") jsii_call_method("addDependsOn", [target]) end |
#add_metadata(key, value) ⇒ void
This method returns an undefined value.
Add a value to the CloudFormation Resource Metadata.
642 643 644 645 646 |
# File 'redshift_serverless/cfn_workgroup.rb', line 642 def (key, value) Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value") jsii_call_method("addMetadata", [key, value]) end |
#add_override(path, value) ⇒ void
This method returns an undefined value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use add_property_override 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,
# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to add_override 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.
699 700 701 702 703 |
# File 'redshift_serverless/cfn_workgroup.rb', line 699 def add_override(path, value) Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value") jsii_call_method("addOverride", [path, value]) end |
#add_property_deletion_override(property_path) ⇒ void
This method returns an undefined value.
Adds an override that deletes the value of a property from the resource definition.
709 710 711 712 |
# File 'redshift_serverless/cfn_workgroup.rb', line 709 def add_property_deletion_override(property_path) Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath") jsii_call_method("addPropertyDeletionOverride", [property_path]) end |
#add_property_override(property_path, value) ⇒ void
This method returns an undefined value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
721 722 723 724 725 |
# File 'redshift_serverless/cfn_workgroup.rb', line 721 def add_property_override(property_path, value) Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath") Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value") jsii_call_method("addPropertyOverride", [property_path, value]) end |
#apply_cross_stack_reference_strength(strength) ⇒ void
This method returns an undefined value.
Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
734 735 736 737 |
# File 'redshift_serverless/cfn_workgroup.rb', line 734 def apply_cross_stack_reference_strength(strength) Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength") jsii_call_method("applyCrossStackReferenceStrength", [strength]) end |
#apply_removal_policy(policy = nil, options = nil) ⇒ void
This method returns an undefined value.
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). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT). A list of resources that support this policy
can be found in the following link:
756 757 758 759 760 761 |
# File 'redshift_serverless/cfn_workgroup.rb', line 756 def apply_removal_policy(policy = nil, = nil) Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil? = .is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless .nil? jsii_call_method("applyRemovalPolicy", [policy, ]) end |
#attr_workgroup ⇒ AWSCDK::IResolvable
212 213 214 |
# File 'redshift_serverless/cfn_workgroup.rb', line 212 def attr_workgroup() jsii_get_property("attrWorkgroup") end |
#attr_workgroup_base_capacity ⇒ Numeric
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
219 220 221 |
# File 'redshift_serverless/cfn_workgroup.rb', line 219 def attr_workgroup_base_capacity() jsii_get_property("attrWorkgroupBaseCapacity") end |
#attr_workgroup_config_parameters ⇒ AWSCDK::IResolvable
224 225 226 |
# File 'redshift_serverless/cfn_workgroup.rb', line 224 def attr_workgroup_config_parameters() jsii_get_property("attrWorkgroupConfigParameters") end |
#attr_workgroup_creation_date ⇒ String
The creation date of the workgroup.
231 232 233 |
# File 'redshift_serverless/cfn_workgroup.rb', line 231 def attr_workgroup_creation_date() jsii_get_property("attrWorkgroupCreationDate") end |
#attr_workgroup_endpoint ⇒ AWSCDK::IResolvable
236 237 238 |
# File 'redshift_serverless/cfn_workgroup.rb', line 236 def attr_workgroup_endpoint() jsii_get_property("attrWorkgroupEndpoint") end |
#attr_workgroup_endpoint_address ⇒ String
The DNS address of the VPC endpoint.
243 244 245 |
# File 'redshift_serverless/cfn_workgroup.rb', line 243 def attr_workgroup_endpoint_address() jsii_get_property("attrWorkgroupEndpointAddress") end |
#attr_workgroup_endpoint_port ⇒ Numeric
The custom port to use when connecting to a workgroup.
Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
252 253 254 |
# File 'redshift_serverless/cfn_workgroup.rb', line 252 def attr_workgroup_endpoint_port() jsii_get_property("attrWorkgroupEndpointPort") end |
#attr_workgroup_endpoint_vpc_endpoints ⇒ AWSCDK::IResolvable
257 258 259 |
# File 'redshift_serverless/cfn_workgroup.rb', line 257 def attr_workgroup_endpoint_vpc_endpoints() jsii_get_property("attrWorkgroupEndpointVpcEndpoints") end |
#attr_workgroup_enhanced_vpc_routing ⇒ AWSCDK::IResolvable
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
264 265 266 |
# File 'redshift_serverless/cfn_workgroup.rb', line 264 def attr_workgroup_enhanced_vpc_routing() jsii_get_property("attrWorkgroupEnhancedVpcRouting") end |
#attr_workgroup_max_capacity ⇒ Numeric
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.
The max capacity is specified in RPUs.
273 274 275 |
# File 'redshift_serverless/cfn_workgroup.rb', line 273 def attr_workgroup_max_capacity() jsii_get_property("attrWorkgroupMaxCapacity") end |
#attr_workgroup_namespace_name ⇒ String
The namespace the workgroup is associated with.
280 281 282 |
# File 'redshift_serverless/cfn_workgroup.rb', line 280 def attr_workgroup_namespace_name() jsii_get_property("attrWorkgroupNamespaceName") end |
#attr_workgroup_publicly_accessible ⇒ AWSCDK::IResolvable
A value that specifies whether the workgroup can be accessible from a public network.
287 288 289 |
# File 'redshift_serverless/cfn_workgroup.rb', line 287 def attr_workgroup_publicly_accessible() jsii_get_property("attrWorkgroupPubliclyAccessible") end |
#attr_workgroup_security_group_ids ⇒ Array<String>
An array of security group IDs to associate with the workgroup.
294 295 296 |
# File 'redshift_serverless/cfn_workgroup.rb', line 294 def attr_workgroup_security_group_ids() jsii_get_property("attrWorkgroupSecurityGroupIds") end |
#attr_workgroup_status ⇒ String
The status of the workgroup.
301 302 303 |
# File 'redshift_serverless/cfn_workgroup.rb', line 301 def attr_workgroup_status() jsii_get_property("attrWorkgroupStatus") end |
#attr_workgroup_subnet_ids ⇒ Array<String>
An array of subnet IDs the workgroup is associated with.
308 309 310 |
# File 'redshift_serverless/cfn_workgroup.rb', line 308 def attr_workgroup_subnet_ids() jsii_get_property("attrWorkgroupSubnetIds") end |
#attr_workgroup_track_name ⇒ String
The name of the track for the workgroup.
315 316 317 |
# File 'redshift_serverless/cfn_workgroup.rb', line 315 def attr_workgroup_track_name() jsii_get_property("attrWorkgroupTrackName") end |
#attr_workgroup_workgroup_arn ⇒ String
The Amazon Resource Name (ARN) that links to the workgroup.
322 323 324 |
# File 'redshift_serverless/cfn_workgroup.rb', line 322 def attr_workgroup_workgroup_arn() jsii_get_property("attrWorkgroupWorkgroupArn") end |
#attr_workgroup_workgroup_id ⇒ String
The unique identifier of the workgroup.
329 330 331 |
# File 'redshift_serverless/cfn_workgroup.rb', line 329 def attr_workgroup_workgroup_id() jsii_get_property("attrWorkgroupWorkgroupId") end |
#attr_workgroup_workgroup_name ⇒ String
The name of the workgroup.
336 337 338 |
# File 'redshift_serverless/cfn_workgroup.rb', line 336 def attr_workgroup_workgroup_name() jsii_get_property("attrWorkgroupWorkgroupName") end |
#base_capacity ⇒ Numeric?
The base compute capacity of the workgroup in Redshift Processing Units (RPUs).
369 370 371 |
# File 'redshift_serverless/cfn_workgroup.rb', line 369 def base_capacity() jsii_get_property("baseCapacity") end |
#base_capacity=(value) ⇒ Object
373 374 375 376 |
# File 'redshift_serverless/cfn_workgroup.rb', line 373 def base_capacity=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "baseCapacity") unless value.nil? jsii_set_property("baseCapacity", value) end |
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
160 161 162 |
# File 'redshift_serverless/cfn_workgroup.rb', line 160 def () jsii_get_property("cfnOptions") end |
#cfn_properties ⇒ Hash{String => Object}
165 166 167 |
# File 'redshift_serverless/cfn_workgroup.rb', line 165 def cfn_properties() jsii_get_property("cfnProperties") end |
#cfn_property_name(cdk_property_name) ⇒ String?
765 766 767 768 |
# File 'redshift_serverless/cfn_workgroup.rb', line 765 def cfn_property_name(cdk_property_name) Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName") jsii_call_method("cfnPropertyName", [cdk_property_name]) end |
#cfn_property_names ⇒ Hash{String => String}
170 171 172 |
# File 'redshift_serverless/cfn_workgroup.rb', line 170 def cfn_property_names() jsii_get_property("cfnPropertyNames") end |
#cfn_resource_type ⇒ String
AWS resource type.
177 178 179 |
# File 'redshift_serverless/cfn_workgroup.rb', line 177 def cfn_resource_type() jsii_get_property("cfnResourceType") end |
#config_parameters ⇒ AWSCDK::IResolvable, ...
The key of the parameter.
381 382 383 |
# File 'redshift_serverless/cfn_workgroup.rb', line 381 def config_parameters() jsii_get_property("configParameters") end |
#config_parameters=(value) ⇒ Object
385 386 387 388 |
# File 'redshift_serverless/cfn_workgroup.rb', line 385 def config_parameters=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmVkc2hpZnRzZXJ2ZXJsZXNzLkNmbldvcmtncm91cC5Db25maWdQYXJhbWV0ZXJQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "configParameters") unless value.nil? jsii_set_property("configParameters", value) end |
#creation_stack ⇒ Array<String>
122 123 124 |
# File 'redshift_serverless/cfn_workgroup.rb', line 122 def creation_stack() jsii_get_property("creationStack") end |
#enhanced_vpc_routing ⇒ Boolean, ...
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
393 394 395 |
# File 'redshift_serverless/cfn_workgroup.rb', line 393 def enhanced_vpc_routing() jsii_get_property("enhancedVpcRouting") end |
#enhanced_vpc_routing=(value) ⇒ Object
397 398 399 400 |
# File 'redshift_serverless/cfn_workgroup.rb', line 397 def enhanced_vpc_routing=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enhancedVpcRouting") unless value.nil? jsii_set_property("enhancedVpcRouting", value) end |
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
182 183 184 |
# File 'redshift_serverless/cfn_workgroup.rb', line 182 def env() jsii_get_property("env") end |
#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference
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.
778 779 780 781 782 |
# File 'redshift_serverless/cfn_workgroup.rb', line 778 def get_att(attribute_name, type_hint = nil) Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName") Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil? jsii_call_method("getAtt", [attribute_name, type_hint]) end |
#get_metadata(key) ⇒ Object
Retrieve a value value from the CloudFormation Resource Metadata.
789 790 791 792 |
# File 'redshift_serverless/cfn_workgroup.rb', line 789 def (key) Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") jsii_call_method("getMetadata", [key]) end |
#inspect(inspector) ⇒ void
This method returns an undefined value.
Examines the CloudFormation resource and discloses attributes.
859 860 861 862 |
# File 'redshift_serverless/cfn_workgroup.rb', line 859 def inspect(inspector) Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector") jsii_call_method("inspect", [inspector]) end |
#logical_id ⇒ 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 override_logical_id(new_logical_id).
134 135 136 |
# File 'redshift_serverless/cfn_workgroup.rb', line 134 def logical_id() jsii_get_property("logicalId") end |
#max_capacity ⇒ Numeric?
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.
405 406 407 |
# File 'redshift_serverless/cfn_workgroup.rb', line 405 def max_capacity() jsii_get_property("maxCapacity") end |
#max_capacity=(value) ⇒ Object
409 410 411 412 |
# File 'redshift_serverless/cfn_workgroup.rb', line 409 def max_capacity=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxCapacity") unless value.nil? jsii_set_property("maxCapacity", value) end |
#namespace_name ⇒ String?
The namespace the workgroup is associated with.
417 418 419 |
# File 'redshift_serverless/cfn_workgroup.rb', line 417 def namespace_name() jsii_get_property("namespaceName") end |
#namespace_name=(value) ⇒ Object
421 422 423 424 |
# File 'redshift_serverless/cfn_workgroup.rb', line 421 def namespace_name=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "namespaceName") unless value.nil? jsii_set_property("namespaceName", value) end |
#node ⇒ Constructs::Node
The tree node.
117 118 119 |
# File 'redshift_serverless/cfn_workgroup.rb', line 117 def node() jsii_get_property("node") end |
#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
800 801 802 |
# File 'redshift_serverless/cfn_workgroup.rb', line 800 def obtain_dependencies() jsii_call_method("obtainDependencies", []) end |
#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>
Get a shallow copy of dependencies between this resource and other resources in the same stack.
807 808 809 |
# File 'redshift_serverless/cfn_workgroup.rb', line 807 def obtain_resource_dependencies() jsii_call_method("obtainResourceDependencies", []) end |
#override_logical_id(new_logical_id) ⇒ void
This method returns an undefined value.
Overrides the auto-generated logical ID with a specific ID.
600 601 602 603 |
# File 'redshift_serverless/cfn_workgroup.rb', line 600 def override_logical_id(new_logical_id) Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId") jsii_call_method("overrideLogicalId", [new_logical_id]) end |
#port ⇒ Numeric?
The custom port to use when connecting to a workgroup.
429 430 431 |
# File 'redshift_serverless/cfn_workgroup.rb', line 429 def port() jsii_get_property("port") end |
#port=(value) ⇒ Object
433 434 435 436 |
# File 'redshift_serverless/cfn_workgroup.rb', line 433 def port=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "port") unless value.nil? jsii_set_property("port", value) end |
#price_performance_target ⇒ AWSCDK::IResolvable, ...
An object that represents the price performance target settings for the workgroup.
441 442 443 |
# File 'redshift_serverless/cfn_workgroup.rb', line 441 def price_performance_target() jsii_get_property("pricePerformanceTarget") end |
#price_performance_target=(value) ⇒ Object
445 446 447 448 449 |
# File 'redshift_serverless/cfn_workgroup.rb', line 445 def price_performance_target=(value) value = value.is_a?(Hash) ? ::AWSCDK::RedshiftServerless::CfnWorkgroup::PerformanceTargetProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZWRzaGlmdHNlcnZlcmxlc3MuQ2ZuV29ya2dyb3VwLlBlcmZvcm1hbmNlVGFyZ2V0UHJvcGVydHkifV19fQ==")), "pricePerformanceTarget") unless value.nil? jsii_set_property("pricePerformanceTarget", value) end |
#publicly_accessible ⇒ Boolean, ...
A value that specifies whether the workgroup can be accessible from a public network.
454 455 456 |
# File 'redshift_serverless/cfn_workgroup.rb', line 454 def publicly_accessible() jsii_get_property("publiclyAccessible") end |
#publicly_accessible=(value) ⇒ Object
458 459 460 461 |
# File 'redshift_serverless/cfn_workgroup.rb', line 458 def publicly_accessible=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "publiclyAccessible") unless value.nil? jsii_set_property("publiclyAccessible", value) end |
#recovery_point_id ⇒ String?
The recovery point id to restore from.
466 467 468 |
# File 'redshift_serverless/cfn_workgroup.rb', line 466 def recovery_point_id() jsii_get_property("recoveryPointId") end |
#recovery_point_id=(value) ⇒ Object
470 471 472 473 |
# File 'redshift_serverless/cfn_workgroup.rb', line 470 def recovery_point_id=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "recoveryPointId") unless value.nil? jsii_set_property("recoveryPointId", value) end |
#ref ⇒ String
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 }).
153 154 155 |
# File 'redshift_serverless/cfn_workgroup.rb', line 153 def ref() jsii_get_property("ref") end |
#remove_dependency(target) ⇒ void
This method returns an undefined value.
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
818 819 820 821 |
# File 'redshift_serverless/cfn_workgroup.rb', line 818 def remove_dependency(target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") jsii_call_method("removeDependency", [target]) end |
#render_properties(props) ⇒ Hash{String => Object}
825 826 827 828 |
# File 'redshift_serverless/cfn_workgroup.rb', line 825 def render_properties(props) Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props") jsii_call_method("renderProperties", [props]) end |
#replace_dependency(target, new_target) ⇒ void
This method returns an undefined value.
Replaces one dependency with another.
835 836 837 838 839 |
# File 'redshift_serverless/cfn_workgroup.rb', line 835 def replace_dependency(target, new_target) Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target") Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget") jsii_call_method("replaceDependency", [target, new_target]) end |
#security_group_ids ⇒ Array<String>?
A list of security group IDs to associate with the workgroup.
478 479 480 |
# File 'redshift_serverless/cfn_workgroup.rb', line 478 def security_group_ids() jsii_get_property("securityGroupIds") end |
#security_group_ids=(value) ⇒ Object
482 483 484 485 |
# File 'redshift_serverless/cfn_workgroup.rb', line 482 def security_group_ids=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityGroupIds") unless value.nil? jsii_set_property("securityGroupIds", value) end |
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
844 845 846 |
# File 'redshift_serverless/cfn_workgroup.rb', line 844 def should_synthesize() jsii_call_method("shouldSynthesize", []) end |
#snapshot_arn ⇒ String?
The Amazon Resource Name (ARN) of the snapshot to restore from.
490 491 492 |
# File 'redshift_serverless/cfn_workgroup.rb', line 490 def snapshot_arn() jsii_get_property("snapshotArn") end |
#snapshot_arn=(value) ⇒ Object
494 495 496 497 |
# File 'redshift_serverless/cfn_workgroup.rb', line 494 def snapshot_arn=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "snapshotArn") unless value.nil? jsii_set_property("snapshotArn", value) end |
#snapshot_name ⇒ String?
The snapshot name to restore from.
502 503 504 |
# File 'redshift_serverless/cfn_workgroup.rb', line 502 def snapshot_name() jsii_get_property("snapshotName") end |
#snapshot_name=(value) ⇒ Object
506 507 508 509 |
# File 'redshift_serverless/cfn_workgroup.rb', line 506 def snapshot_name=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "snapshotName") unless value.nil? jsii_set_property("snapshotName", value) end |
#snapshot_owner_account ⇒ String?
The Amazon Web Services account that owns the snapshot.
514 515 516 |
# File 'redshift_serverless/cfn_workgroup.rb', line 514 def snapshot_owner_account() jsii_get_property("snapshotOwnerAccount") end |
#snapshot_owner_account=(value) ⇒ Object
518 519 520 521 |
# File 'redshift_serverless/cfn_workgroup.rb', line 518 def snapshot_owner_account=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "snapshotOwnerAccount") unless value.nil? jsii_set_property("snapshotOwnerAccount", value) end |
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
143 144 145 |
# File 'redshift_serverless/cfn_workgroup.rb', line 143 def stack() jsii_get_property("stack") end |
#subnet_ids ⇒ Array<String>?
A list of subnet IDs the workgroup is associated with.
526 527 528 |
# File 'redshift_serverless/cfn_workgroup.rb', line 526 def subnet_ids() jsii_get_property("subnetIds") end |
#subnet_ids=(value) ⇒ Object
530 531 532 533 |
# File 'redshift_serverless/cfn_workgroup.rb', line 530 def subnet_ids=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "subnetIds") unless value.nil? jsii_set_property("subnetIds", value) end |
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
343 344 345 |
# File 'redshift_serverless/cfn_workgroup.rb', line 343 def () jsii_get_property("tags") end |
#tags_raw ⇒ Array<AWSCDK::CfnTag>?
The map of the key-value pairs used to tag the workgroup.
538 539 540 |
# File 'redshift_serverless/cfn_workgroup.rb', line 538 def () jsii_get_property("tagsRaw") end |
#tags_raw=(value) ⇒ Object
542 543 544 545 546 |
# File 'redshift_serverless/cfn_workgroup.rb', line 542 def (value) value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil? jsii_set_property("tagsRaw", value) end |
#to_string ⇒ String
Returns a string representation of this construct.
576 577 578 |
# File 'redshift_serverless/cfn_workgroup.rb', line 576 def to_string() jsii_call_method("toString", []) end |
#track_name ⇒ String?
An optional parameter for the name of the track for the workgroup.
551 552 553 |
# File 'redshift_serverless/cfn_workgroup.rb', line 551 def track_name() jsii_get_property("trackName") end |
#track_name=(value) ⇒ Object
555 556 557 558 |
# File 'redshift_serverless/cfn_workgroup.rb', line 555 def track_name=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "trackName") unless value.nil? jsii_set_property("trackName", value) end |
#updated_properites ⇒ Hash{String => Object}
use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.
Deprecated.
190 191 192 |
# File 'redshift_serverless/cfn_workgroup.rb', line 190 def updated_properites() jsii_get_property("updatedProperites") end |
#updated_properties ⇒ Hash{String => Object}
Return properties modified after initiation.
Resources that expose mutable properties should override this function to collect and return the properties object for this resource.
200 201 202 |
# File 'redshift_serverless/cfn_workgroup.rb', line 200 def updated_properties() jsii_get_property("updatedProperties") end |
#validate_properties(_properties) ⇒ void
This method returns an undefined value.
850 851 852 853 |
# File 'redshift_serverless/cfn_workgroup.rb', line 850 def validate_properties(_properties) Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties") jsii_call_method("validateProperties", [_properties]) end |
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
589 590 591 592 593 594 |
# File 'redshift_serverless/cfn_workgroup.rb', line 589 def with(*mixins) mixins.each_with_index do |item, index| Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]") end jsii_call_method("with", [*mixins]) end |
#workgroup ⇒ AWSCDK::IResolvable, ...
The collection of computing resources from which an endpoint is created.
563 564 565 |
# File 'redshift_serverless/cfn_workgroup.rb', line 563 def workgroup() jsii_get_property("workgroup") end |
#workgroup=(value) ⇒ Object
567 568 569 570 571 |
# File 'redshift_serverless/cfn_workgroup.rb', line 567 def workgroup=(value) value = value.is_a?(Hash) ? ::AWSCDK::RedshiftServerless::CfnWorkgroup::WorkgroupProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZWRzaGlmdHNlcnZlcmxlc3MuQ2ZuV29ya2dyb3VwLldvcmtncm91cFByb3BlcnR5In1dfX0=")), "workgroup") unless value.nil? jsii_set_property("workgroup", value) end |
#workgroup_name ⇒ String
The name of the workgroup.
357 358 359 |
# File 'redshift_serverless/cfn_workgroup.rb', line 357 def workgroup_name() jsii_get_property("workgroupName") end |
#workgroup_name=(value) ⇒ Object
361 362 363 364 |
# File 'redshift_serverless/cfn_workgroup.rb', line 361 def workgroup_name=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workgroupName") jsii_set_property("workgroupName", value) end |
#workgroup_ref ⇒ AWSCDK::Interfaces::AWSRedshiftserverless::WorkgroupReference
A reference to a Workgroup resource.
350 351 352 |
# File 'redshift_serverless/cfn_workgroup.rb', line 350 def workgroup_ref() jsii_get_property("workgroupRef") end |