awsredshiftserverless

package
v2.77.0 Latest Latest
Warning

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

 Go to latest Published: Apr 26, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

README

AWS::RedshiftServerless Construct Library

This module is part of the AWS Cloud Development Kit project.

import redshiftserverless "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::RedshiftServerless.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Documentation

Index

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.

func CfnNamespace_IsCfnResource 

func CfnNamespace_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnNamespace_IsConstruct 

func CfnNamespace_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

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

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

func CfnWorkgroup_CFN_RESOURCE_TYPE_NAME added in v2.32.0 

func CfnWorkgroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnWorkgroup_IsCfnElement added in v2.32.0 

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.

func CfnWorkgroup_IsCfnResource added in v2.32.0 

func CfnWorkgroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnWorkgroup_IsConstruct added in v2.32.0 

func CfnWorkgroup_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

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

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

func NewCfnNamespace_Override 

func NewCfnNamespace_Override(c CfnNamespace, scope constructs.Construct, id *string, props *CfnNamespaceProps)

Create a new `AWS::RedshiftServerless::Namespace`.

func NewCfnWorkgroup_Override added in v2.32.0 

func NewCfnWorkgroup_Override(c CfnWorkgroup, scope constructs.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)
	// The username of the administrator for the first database created in the namespace.
	AttrNamespaceAdminUsername() *string
	// The date of when the namespace was created.
	AttrNamespaceCreationDate() *string
	// The name of the first database created in the namespace.
	AttrNamespaceDbName() *string
	// The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
	AttrNamespaceDefaultIamRoleArn() *string
	// A list of IAM roles to associate with the namespace.
	AttrNamespaceIamRoles() *[]*string
	// The ID of the AWS Key Management Service key used to encrypt your data.
	AttrNamespaceKmsKeyId() *string
	// The types of logs the namespace can export.
	//
	// Available export types are `User log` , `Connection log` , and `User activity log` .
	AttrNamespaceLogExports() *[]*string
	// The Amazon Resource Name (ARN) associated with a namespace.
	AttrNamespaceNamespaceArn() *string
	// The unique identifier of a namespace.
	AttrNamespaceNamespaceId() *string
	// 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.
	AttrNamespaceNamespaceName() *string
	// The status of the namespace.
	AttrNamespaceStatus() *string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	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.
	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.
	LogicalId() *string
	// 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
	SetNamespaceName(val *string)
	// The tree node.
	Node() constructs.Node
	// 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 })`.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// The map of the key-value pairs used to tag the namespace.
	Tags() awscdk.TagManager
	// Deprecated.
	// Deprecated: 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.
	UpdatedProperites() *map[string]interface{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	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.
	AddDependency(target awscdk.CfnResource)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	// Deprecated: use addDependency.
	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.
	//
	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.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	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`). 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:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	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.
	GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Retrieves an array of resources this resource depends on.
	//
	// This assembles dependencies on resources across stacks (including nested stacks)
	// automatically.
	ObtainDependencies() *[]interface{}
	// Get a shallow copy of dependencies between this resource and other resources in the same stack.
	ObtainResourceDependencies() *[]awscdk.CfnResource
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// 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.
	RemoveDependency(target awscdk.CfnResource)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Replaces one dependency with another.
	ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
	// 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.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	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"),
	},
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
})

func NewCfnNamespace 

func NewCfnNamespace(scope constructs.Construct, id *string, props *CfnNamespaceProps) CfnNamespace

Create a new `AWS::RedshiftServerless::Namespace`.

type CfnNamespaceProps 

type CfnNamespaceProps struct {
	// 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:"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"`
	// 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"),
	},
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

type CfnNamespace_NamespaceProperty added in v2.55.0 

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 added in v2.32.0 

type CfnWorkgroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
	AttrWorkgroupBaseCapacity() *float64
	AttrWorkgroupConfigParameters() awscdk.IResolvable
	// The creation date of the workgroup.
	AttrWorkgroupCreationDate() *string
	// The DNS address of the VPC endpoint.
	AttrWorkgroupEndpointAddress() *string
	// The custom port to use when connecting to a workgroup.
	//
	// Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
	AttrWorkgroupEndpointPort() *float64
	AttrWorkgroupEndpointVpcEndpoints() 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.
	AttrWorkgroupEnhancedVpcRouting() awscdk.IResolvable
	// The namespace the workgroup is associated with.
	AttrWorkgroupNamespaceName() *string
	// A value that specifies whether the workgroup can be accessible from a public network.
	AttrWorkgroupPubliclyAccessible() awscdk.IResolvable
	// An array of security group IDs to associate with the workgroup.
	AttrWorkgroupSecurityGroupIds() *[]*string
	// The status of the workgroup.
	AttrWorkgroupStatus() *string
	// An array of subnet IDs the workgroup is associated with.
	AttrWorkgroupSubnetIds() *[]*string
	// The Amazon Resource Name (ARN) that links to the workgroup.
	AttrWorkgroupWorkgroupArn() *string
	// The unique identifier of the workgroup.
	AttrWorkgroupWorkgroupId() *string
	// The name of the workgroup.
	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.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	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.
	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.
	LogicalId() *string
	// The namespace the workgroup is associated with.
	NamespaceName() *string
	SetNamespaceName(val *string)
	// The tree node.
	Node() constructs.Node
	// The custom port to use when connecting to a workgroup.
	//
	// Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
	Port() *float64
	SetPort(val *float64)
	// 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 })`.
	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).
	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
	// Deprecated.
	// Deprecated: 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.
	UpdatedProperites() *map[string]interface{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// The name of the workgroup.
	WorkgroupName() *string
	SetWorkgroupName(val *string)
	// Syntactic sugar for `addOverride(path, undefined)`.
	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.
	AddDependency(target awscdk.CfnResource)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	// Deprecated: use addDependency.
	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.
	//
	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.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	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`). 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:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	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.
	GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Retrieves an array of resources this resource depends on.
	//
	// This assembles dependencies on resources across stacks (including nested stacks)
	// automatically.
	ObtainDependencies() *[]interface{}
	// Get a shallow copy of dependencies between this resource and other resources in the same stack.
	ObtainResourceDependencies() *[]awscdk.CfnResource
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// 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.
	RemoveDependency(target awscdk.CfnResource)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Replaces one dependency with another.
	ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
	// 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.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	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"),
	Port: jsii.Number(123),
	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 added in v2.32.0 

func NewCfnWorkgroup(scope constructs.Construct, id *string, props *CfnWorkgroupProps) CfnWorkgroup

Create a new `AWS::RedshiftServerless::Workgroup`.

type CfnWorkgroupProps added in v2.32.0 

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"`
	// The custom port to use when connecting to a workgroup.
	//
	// Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
	Port *float64 `field:"optional" json:"port" yaml:"port"`
	// 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"`
}

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"),
	Port: jsii.Number(123),
	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 added in v2.32.0 

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 added in v2.55.0 

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 added in v2.55.0 

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 added in v2.55.0 

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 added in v2.55.0 

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 advanced control over a database.
	//
	// The options are `auto_mv` , `datestyle` , `enable_case_sensitivity_identifier` , `enable_user_activity_logging` , `query_group` , , `search_path` , and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see [Query monitoring metrics for Amazon Redshift Serverless](https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless) .
	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

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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