This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# Amazon Redshift Serverless
<a name="AWS_RedshiftServerless"></a>

**Resource types**
+ [AWS::RedshiftServerless::Namespace](aws-resource-redshiftserverless-namespace.md)
+ [AWS::RedshiftServerless::Snapshot](aws-resource-redshiftserverless-snapshot.md)
+ [AWS::RedshiftServerless::Workgroup](aws-resource-redshiftserverless-workgroup.md)

# AWS::RedshiftServerless::Namespace
<a name="aws-resource-redshiftserverless-namespace"></a>

A collection of database objects and users.

## Syntax
<a name="aws-resource-redshiftserverless-namespace-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-redshiftserverless-namespace-syntax.json"></a>

```
{
  "Type" : "AWS::RedshiftServerless::Namespace",
  "Properties" : {
      "[AdminPasswordSecretKmsKeyId](#cfn-redshiftserverless-namespace-adminpasswordsecretkmskeyid)" : String,
      "[AdminUsername](#cfn-redshiftserverless-namespace-adminusername)" : String,
      "[AdminUserPassword](#cfn-redshiftserverless-namespace-adminuserpassword)" : String,
      "[DbName](#cfn-redshiftserverless-namespace-dbname)" : String,
      "[DefaultIamRoleArn](#cfn-redshiftserverless-namespace-defaultiamrolearn)" : String,
      "[FinalSnapshotName](#cfn-redshiftserverless-namespace-finalsnapshotname)" : String,
      "[FinalSnapshotRetentionPeriod](#cfn-redshiftserverless-namespace-finalsnapshotretentionperiod)" : Integer,
      "[IamRoles](#cfn-redshiftserverless-namespace-iamroles)" : [ String, ... ],
      "[KmsKeyId](#cfn-redshiftserverless-namespace-kmskeyid)" : String,
      "[LogExports](#cfn-redshiftserverless-namespace-logexports)" : [ String, ... ],
      "[ManageAdminPassword](#cfn-redshiftserverless-namespace-manageadminpassword)" : Boolean,
      "[NamespaceName](#cfn-redshiftserverless-namespace-namespacename)" : String,
      "[NamespaceResourcePolicy](#cfn-redshiftserverless-namespace-namespaceresourcepolicy)" : Json,
      "[RedshiftIdcApplicationArn](#cfn-redshiftserverless-namespace-redshiftidcapplicationarn)" : String,
      "[SnapshotCopyConfigurations](#cfn-redshiftserverless-namespace-snapshotcopyconfigurations)" : [ SnapshotCopyConfiguration, ... ],
      "[Tags](#cfn-redshiftserverless-namespace-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-redshiftserverless-namespace-syntax.yaml"></a>

```
Type: AWS::RedshiftServerless::Namespace
Properties:
  [AdminPasswordSecretKmsKeyId](#cfn-redshiftserverless-namespace-adminpasswordsecretkmskeyid): String
  [AdminUsername](#cfn-redshiftserverless-namespace-adminusername): String
  [AdminUserPassword](#cfn-redshiftserverless-namespace-adminuserpassword): String
  [DbName](#cfn-redshiftserverless-namespace-dbname): String
  [DefaultIamRoleArn](#cfn-redshiftserverless-namespace-defaultiamrolearn): String
  [FinalSnapshotName](#cfn-redshiftserverless-namespace-finalsnapshotname): String
  [FinalSnapshotRetentionPeriod](#cfn-redshiftserverless-namespace-finalsnapshotretentionperiod): Integer
  [IamRoles](#cfn-redshiftserverless-namespace-iamroles): 
    - String
  [KmsKeyId](#cfn-redshiftserverless-namespace-kmskeyid): String
  [LogExports](#cfn-redshiftserverless-namespace-logexports): 
    - String
  [ManageAdminPassword](#cfn-redshiftserverless-namespace-manageadminpassword): Boolean
  [NamespaceName](#cfn-redshiftserverless-namespace-namespacename): String
  [NamespaceResourcePolicy](#cfn-redshiftserverless-namespace-namespaceresourcepolicy): Json
  [RedshiftIdcApplicationArn](#cfn-redshiftserverless-namespace-redshiftidcapplicationarn): String
  [SnapshotCopyConfigurations](#cfn-redshiftserverless-namespace-snapshotcopyconfigurations): 
    - SnapshotCopyConfiguration
  [Tags](#cfn-redshiftserverless-namespace-tags): 
    - Tag
```

## Properties
<a name="aws-resource-redshiftserverless-namespace-properties"></a>

`AdminPasswordSecretKmsKeyId`  <a name="cfn-redshiftserverless-namespace-adminpasswordsecretkmskeyid"></a>
The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if `ManageAdminPassword` is `true`.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AdminUsername`  <a name="cfn-redshiftserverless-namespace-adminusername"></a>
The username of the administrator for the primary database created in the namespace.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z][a-zA-Z_0-9+.@-]*`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AdminUserPassword`  <a name="cfn-redshiftserverless-namespace-adminuserpassword"></a>
The password of the administrator for the primary database created in the namespace.  
*Required*: No  
*Type*: String  
*Pattern*: `^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[^\x00-\x20\x22\x27\x2f\x40\x5c\x7f-\uffff]+`  
*Minimum*: `8`  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DbName`  <a name="cfn-redshiftserverless-namespace-dbname"></a>
The name of the primary database created in the namespace.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z][a-zA-Z_0-9+.@-]*`  
*Maximum*: `127`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DefaultIamRoleArn`  <a name="cfn-redshiftserverless-namespace-defaultiamrolearn"></a>
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FinalSnapshotName`  <a name="cfn-redshiftserverless-namespace-finalsnapshotname"></a>
The name of the snapshot to be created before the namespace is deleted.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-z][a-z0-9]*(-[a-z0-9]+)*`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FinalSnapshotRetentionPeriod`  <a name="cfn-redshiftserverless-namespace-finalsnapshotretentionperiod"></a>
How long to retain the final snapshot.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IamRoles`  <a name="cfn-redshiftserverless-namespace-iamroles"></a>
A list of IAM roles to associate with the namespace.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `0`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KmsKeyId`  <a name="cfn-redshiftserverless-namespace-kmskeyid"></a>
The ID of the AWS Key Management Service key used to encrypt your data.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LogExports`  <a name="cfn-redshiftserverless-namespace-logexports"></a>
The types of logs the namespace can export. Available export types are `userlog`, `connectionlog`, and `useractivitylog`.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `0`  
*Maximum*: `16`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ManageAdminPassword`  <a name="cfn-redshiftserverless-namespace-manageadminpassword"></a>
If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. You can't use `AdminUserPassword` if `ManageAdminPassword` is true. If `ManageAdminPassword` is `false` or not set, Amazon Redshift uses `AdminUserPassword` for the admin user account's password.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NamespaceName`  <a name="cfn-redshiftserverless-namespace-namespacename"></a>
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.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-z0-9-]+$`  
*Minimum*: `3`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`NamespaceResourcePolicy`  <a name="cfn-redshiftserverless-namespace-namespaceresourcepolicy"></a>
The resource policy that will be attached to the namespace.  
*Required*: No  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RedshiftIdcApplicationArn`  <a name="cfn-redshiftserverless-namespace-redshiftidcapplicationarn"></a>
The ARN for the Redshift application that integrates with IAM Identity Center.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SnapshotCopyConfigurations`  <a name="cfn-redshiftserverless-namespace-snapshotcopyconfigurations"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [SnapshotCopyConfiguration](aws-properties-redshiftserverless-namespace-snapshotcopyconfiguration.md)  
*Minimum*: `0`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-redshiftserverless-namespace-tags"></a>
The map of the key-value pairs used to tag the namespace.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-redshiftserverless-namespace-tag.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-redshiftserverless-namespace-return-values"></a>

### Ref
<a name="aws-resource-redshiftserverless-namespace-return-values-ref"></a>

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the NamespaceName, such as `sample-namespace.` For more information about using the Ref function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-redshiftserverless-namespace-return-values-fn--getatt"></a>

GetAtt returns a value for a specified attribute of this type. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). The following are the available attributes and sample return values.

#### 
<a name="aws-resource-redshiftserverless-namespace-return-values-fn--getatt-fn--getatt"></a>

`Namespace.AdminUsername`  <a name="Namespace.AdminUsername-fn::getatt"></a>
The username of the administrator for the first database created in the namespace.

`Namespace.CreationDate`  <a name="Namespace.CreationDate-fn::getatt"></a>
The date of when the namespace was created.

`Namespace.DbName`  <a name="Namespace.DbName-fn::getatt"></a>
The name of the first database created in the namespace.

`Namespace.DefaultIamRoleArn`  <a name="Namespace.DefaultIamRoleArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

`Namespace.IamRoles`  <a name="Namespace.IamRoles-fn::getatt"></a>
A list of IAM roles to associate with the namespace.

`Namespace.KmsKeyId`  <a name="Namespace.KmsKeyId-fn::getatt"></a>
The ID of the AWS Key Management Service key used to encrypt your data.

`Namespace.LogExports`  <a name="Namespace.LogExports-fn::getatt"></a>
The types of logs the namespace can export. Available export types are `User log`, `Connection log`, and `User activity log`.

`Namespace.NamespaceArn`  <a name="Namespace.NamespaceArn-fn::getatt"></a>
The Amazon Resource Name (ARN) associated with a namespace.

`Namespace.NamespaceId`  <a name="Namespace.NamespaceId-fn::getatt"></a>
The unique identifier of a namespace.

`Namespace.NamespaceName`  <a name="Namespace.NamespaceName-fn::getatt"></a>
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.

`Namespace.Status`  <a name="Namespace.Status-fn::getatt"></a>
The status of the namespace.

# AWS::RedshiftServerless::Namespace Namespace
<a name="aws-properties-redshiftserverless-namespace-namespace"></a>

A collection of database objects and users.

## Syntax
<a name="aws-properties-redshiftserverless-namespace-namespace-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-redshiftserverless-namespace-namespace-syntax.json"></a>

```
{
  "[AdminPasswordSecretArn](#cfn-redshiftserverless-namespace-namespace-adminpasswordsecretarn)" : String,
  "[AdminPasswordSecretKmsKeyId](#cfn-redshiftserverless-namespace-namespace-adminpasswordsecretkmskeyid)" : String,
  "[AdminUsername](#cfn-redshiftserverless-namespace-namespace-adminusername)" : String,
  "[CreationDate](#cfn-redshiftserverless-namespace-namespace-creationdate)" : String,
  "[DbName](#cfn-redshiftserverless-namespace-namespace-dbname)" : String,
  "[DefaultIamRoleArn](#cfn-redshiftserverless-namespace-namespace-defaultiamrolearn)" : String,
  "[IamRoles](#cfn-redshiftserverless-namespace-namespace-iamroles)" : [ String, ... ],
  "[KmsKeyId](#cfn-redshiftserverless-namespace-namespace-kmskeyid)" : String,
  "[LogExports](#cfn-redshiftserverless-namespace-namespace-logexports)" : [ String, ... ],
  "[NamespaceArn](#cfn-redshiftserverless-namespace-namespace-namespacearn)" : String,
  "[NamespaceId](#cfn-redshiftserverless-namespace-namespace-namespaceid)" : String,
  "[NamespaceName](#cfn-redshiftserverless-namespace-namespace-namespacename)" : String,
  "[Status](#cfn-redshiftserverless-namespace-namespace-status)" : String
}
```

### YAML
<a name="aws-properties-redshiftserverless-namespace-namespace-syntax.yaml"></a>

```
  [AdminPasswordSecretArn](#cfn-redshiftserverless-namespace-namespace-adminpasswordsecretarn): String
  [AdminPasswordSecretKmsKeyId](#cfn-redshiftserverless-namespace-namespace-adminpasswordsecretkmskeyid): String
  [AdminUsername](#cfn-redshiftserverless-namespace-namespace-adminusername): String
  [CreationDate](#cfn-redshiftserverless-namespace-namespace-creationdate): String
  [DbName](#cfn-redshiftserverless-namespace-namespace-dbname): String
  [DefaultIamRoleArn](#cfn-redshiftserverless-namespace-namespace-defaultiamrolearn): String
  [IamRoles](#cfn-redshiftserverless-namespace-namespace-iamroles): 
    - String
  [KmsKeyId](#cfn-redshiftserverless-namespace-namespace-kmskeyid): String
  [LogExports](#cfn-redshiftserverless-namespace-namespace-logexports): 
    - String
  [NamespaceArn](#cfn-redshiftserverless-namespace-namespace-namespacearn): String
  [NamespaceId](#cfn-redshiftserverless-namespace-namespace-namespaceid): String
  [NamespaceName](#cfn-redshiftserverless-namespace-namespace-namespacename): String
  [Status](#cfn-redshiftserverless-namespace-namespace-status): String
```

## Properties
<a name="aws-properties-redshiftserverless-namespace-namespace-properties"></a>

`AdminPasswordSecretArn`  <a name="cfn-redshiftserverless-namespace-namespace-adminpasswordsecretarn"></a>
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AdminPasswordSecretKmsKeyId`  <a name="cfn-redshiftserverless-namespace-namespace-adminpasswordsecretkmskeyid"></a>
The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AdminUsername`  <a name="cfn-redshiftserverless-namespace-namespace-adminusername"></a>
The username of the administrator for the first database created in the namespace.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CreationDate`  <a name="cfn-redshiftserverless-namespace-namespace-creationdate"></a>
The date of when the namespace was created.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DbName`  <a name="cfn-redshiftserverless-namespace-namespace-dbname"></a>
The name of the first database created in the namespace.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z][a-zA-Z_0-9+.@-]*`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DefaultIamRoleArn`  <a name="cfn-redshiftserverless-namespace-namespace-defaultiamrolearn"></a>
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IamRoles`  <a name="cfn-redshiftserverless-namespace-namespace-iamroles"></a>
A list of IAM roles to associate with the namespace.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `0`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KmsKeyId`  <a name="cfn-redshiftserverless-namespace-namespace-kmskeyid"></a>
The ID of the AWS Key Management Service key used to encrypt your data.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LogExports`  <a name="cfn-redshiftserverless-namespace-namespace-logexports"></a>
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `0`  
*Maximum*: `16`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NamespaceArn`  <a name="cfn-redshiftserverless-namespace-namespace-namespacearn"></a>
The Amazon Resource Name (ARN) associated with a namespace.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NamespaceId`  <a name="cfn-redshiftserverless-namespace-namespace-namespaceid"></a>
The unique identifier of a namespace.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NamespaceName`  <a name="cfn-redshiftserverless-namespace-namespace-namespacename"></a>
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.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-z0-9-]+$`  
*Minimum*: `3`  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-redshiftserverless-namespace-namespace-status"></a>
The status of the namespace.  
*Required*: No  
*Type*: String  
*Allowed values*: `AVAILABLE | MODIFYING | DELETING`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::RedshiftServerless::Namespace SnapshotCopyConfiguration
<a name="aws-properties-redshiftserverless-namespace-snapshotcopyconfiguration"></a>

The object that you configure to copy snapshots from one namespace to a namespace in another AWS Region.

## Syntax
<a name="aws-properties-redshiftserverless-namespace-snapshotcopyconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-redshiftserverless-namespace-snapshotcopyconfiguration-syntax.json"></a>

```
{
  "[DestinationKmsKeyId](#cfn-redshiftserverless-namespace-snapshotcopyconfiguration-destinationkmskeyid)" : String,
  "[DestinationRegion](#cfn-redshiftserverless-namespace-snapshotcopyconfiguration-destinationregion)" : String,
  "[SnapshotRetentionPeriod](#cfn-redshiftserverless-namespace-snapshotcopyconfiguration-snapshotretentionperiod)" : Integer
}
```

### YAML
<a name="aws-properties-redshiftserverless-namespace-snapshotcopyconfiguration-syntax.yaml"></a>

```
  [DestinationKmsKeyId](#cfn-redshiftserverless-namespace-snapshotcopyconfiguration-destinationkmskeyid): String
  [DestinationRegion](#cfn-redshiftserverless-namespace-snapshotcopyconfiguration-destinationregion): String
  [SnapshotRetentionPeriod](#cfn-redshiftserverless-namespace-snapshotcopyconfiguration-snapshotretentionperiod): Integer
```

## Properties
<a name="aws-properties-redshiftserverless-namespace-snapshotcopyconfiguration-properties"></a>

`DestinationKmsKeyId`  <a name="cfn-redshiftserverless-namespace-snapshotcopyconfiguration-destinationkmskeyid"></a>
The ID of the KMS key to use to encrypt your snapshots in the destination AWS Region.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DestinationRegion`  <a name="cfn-redshiftserverless-namespace-snapshotcopyconfiguration-destinationregion"></a>
The destination AWS Region to copy snapshots to.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SnapshotRetentionPeriod`  <a name="cfn-redshiftserverless-namespace-snapshotcopyconfiguration-snapshotretentionperiod"></a>
The retention period of snapshots that are copied to the destination AWS Region.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::RedshiftServerless::Namespace Tag
<a name="aws-properties-redshiftserverless-namespace-tag"></a>

A map of key-value pairs.

## Syntax
<a name="aws-properties-redshiftserverless-namespace-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-redshiftserverless-namespace-tag-syntax.json"></a>

```
{
  "[Key](#cfn-redshiftserverless-namespace-tag-key)" : String,
  "[Value](#cfn-redshiftserverless-namespace-tag-value)" : String
}
```

### YAML
<a name="aws-properties-redshiftserverless-namespace-tag-syntax.yaml"></a>

```
  [Key](#cfn-redshiftserverless-namespace-tag-key): String
  [Value](#cfn-redshiftserverless-namespace-tag-value): String
```

## Properties
<a name="aws-properties-redshiftserverless-namespace-tag-properties"></a>

`Key`  <a name="cfn-redshiftserverless-namespace-tag-key"></a>
The key to use in the tag.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-redshiftserverless-namespace-tag-value"></a>
The value of the tag.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::RedshiftServerless::Snapshot
<a name="aws-resource-redshiftserverless-snapshot"></a>

A snapshot object that contains databases.

## Syntax
<a name="aws-resource-redshiftserverless-snapshot-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-redshiftserverless-snapshot-syntax.json"></a>

```
{
  "Type" : "AWS::RedshiftServerless::Snapshot",
  "Properties" : {
      "[NamespaceName](#cfn-redshiftserverless-snapshot-namespacename)" : String,
      "[RetentionPeriod](#cfn-redshiftserverless-snapshot-retentionperiod)" : Integer,
      "[SnapshotName](#cfn-redshiftserverless-snapshot-snapshotname)" : String,
      "[Tags](#cfn-redshiftserverless-snapshot-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-redshiftserverless-snapshot-syntax.yaml"></a>

```
Type: AWS::RedshiftServerless::Snapshot
Properties:
  [NamespaceName](#cfn-redshiftserverless-snapshot-namespacename): String
  [RetentionPeriod](#cfn-redshiftserverless-snapshot-retentionperiod): Integer
  [SnapshotName](#cfn-redshiftserverless-snapshot-snapshotname): String
  [Tags](#cfn-redshiftserverless-snapshot-tags): 
    - Tag
```

## Properties
<a name="aws-resource-redshiftserverless-snapshot-properties"></a>

`NamespaceName`  <a name="cfn-redshiftserverless-snapshot-namespacename"></a>
The name of the namepsace.  
*Required*: No  
*Type*: String  
*Pattern*: `^(?=^[a-z0-9-]+$).{3,64}$`  
*Minimum*: `3`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RetentionPeriod`  <a name="cfn-redshiftserverless-snapshot-retentionperiod"></a>
The retention period of the snapshot created by the scheduled action.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SnapshotName`  <a name="cfn-redshiftserverless-snapshot-snapshotname"></a>
The name of the snapshot.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?=^[a-z0-9-]+$).{3,64}$`  
*Minimum*: `3`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-redshiftserverless-snapshot-tags"></a>
An array of [Tag objects](https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html) to associate with the snapshot.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-redshiftserverless-snapshot-tag.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-redshiftserverless-snapshot-return-values"></a>

### Ref
<a name="aws-resource-redshiftserverless-snapshot-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-redshiftserverless-snapshot-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-redshiftserverless-snapshot-return-values-fn--getatt-fn--getatt"></a>

`OwnerAccount`  <a name="OwnerAccount-fn::getatt"></a>
The owner AWS; account of the snapshot.

`Snapshot.AdminUsername`  <a name="Snapshot.AdminUsername-fn::getatt"></a>
The username of the database within a snapshot.

`Snapshot.KmsKeyId`  <a name="Snapshot.KmsKeyId-fn::getatt"></a>
The unique identifier of the KMS key used to encrypt the snapshot.

`Snapshot.NamespaceArn`  <a name="Snapshot.NamespaceArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

`Snapshot.NamespaceName`  <a name="Snapshot.NamespaceName-fn::getatt"></a>
The name of the namepsace.

`Snapshot.OwnerAccount`  <a name="Snapshot.OwnerAccount-fn::getatt"></a>
The owner AWS; account of the snapshot.

`Snapshot.RetentionPeriod`  <a name="Snapshot.RetentionPeriod-fn::getatt"></a>
The retention period of the snapshot created by the scheduled action.

`Snapshot.SnapshotArn`  <a name="Snapshot.SnapshotArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the snapshot.

`Snapshot.SnapshotCreateTime`  <a name="Snapshot.SnapshotCreateTime-fn::getatt"></a>
The timestamp of when the snapshot was created.

`Snapshot.SnapshotName`  <a name="Snapshot.SnapshotName-fn::getatt"></a>
The name of the snapshot.

`Snapshot.Status`  <a name="Snapshot.Status-fn::getatt"></a>
The status of the snapshot.

# AWS::RedshiftServerless::Snapshot Snapshot
<a name="aws-properties-redshiftserverless-snapshot-snapshot"></a>

A snapshot object that contains databases.

## Syntax
<a name="aws-properties-redshiftserverless-snapshot-snapshot-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-redshiftserverless-snapshot-snapshot-syntax.json"></a>

```
{
  "[AdminUsername](#cfn-redshiftserverless-snapshot-snapshot-adminusername)" : String,
  "[KmsKeyId](#cfn-redshiftserverless-snapshot-snapshot-kmskeyid)" : String,
  "[NamespaceArn](#cfn-redshiftserverless-snapshot-snapshot-namespacearn)" : String,
  "[NamespaceName](#cfn-redshiftserverless-snapshot-snapshot-namespacename)" : String,
  "[OwnerAccount](#cfn-redshiftserverless-snapshot-snapshot-owneraccount)" : String,
  "[RetentionPeriod](#cfn-redshiftserverless-snapshot-snapshot-retentionperiod)" : Integer,
  "[SnapshotArn](#cfn-redshiftserverless-snapshot-snapshot-snapshotarn)" : String,
  "[SnapshotCreateTime](#cfn-redshiftserverless-snapshot-snapshot-snapshotcreatetime)" : String,
  "[SnapshotName](#cfn-redshiftserverless-snapshot-snapshot-snapshotname)" : String,
  "[Status](#cfn-redshiftserverless-snapshot-snapshot-status)" : String
}
```

### YAML
<a name="aws-properties-redshiftserverless-snapshot-snapshot-syntax.yaml"></a>

```
  [AdminUsername](#cfn-redshiftserverless-snapshot-snapshot-adminusername): String
  [KmsKeyId](#cfn-redshiftserverless-snapshot-snapshot-kmskeyid): String
  [NamespaceArn](#cfn-redshiftserverless-snapshot-snapshot-namespacearn): String
  [NamespaceName](#cfn-redshiftserverless-snapshot-snapshot-namespacename): String
  [OwnerAccount](#cfn-redshiftserverless-snapshot-snapshot-owneraccount): String
  [RetentionPeriod](#cfn-redshiftserverless-snapshot-snapshot-retentionperiod): Integer
  [SnapshotArn](#cfn-redshiftserverless-snapshot-snapshot-snapshotarn): String
  [SnapshotCreateTime](#cfn-redshiftserverless-snapshot-snapshot-snapshotcreatetime): String
  [SnapshotName](#cfn-redshiftserverless-snapshot-snapshot-snapshotname): String
  [Status](#cfn-redshiftserverless-snapshot-snapshot-status): String
```

## Properties
<a name="aws-properties-redshiftserverless-snapshot-snapshot-properties"></a>

`AdminUsername`  <a name="cfn-redshiftserverless-snapshot-snapshot-adminusername"></a>
The username of the database within a snapshot.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KmsKeyId`  <a name="cfn-redshiftserverless-snapshot-snapshot-kmskeyid"></a>
The unique identifier of the KMS key used to encrypt the snapshot.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NamespaceArn`  <a name="cfn-redshiftserverless-snapshot-snapshot-namespacearn"></a>
The Amazon Resource Name (ARN) of the namespace the snapshot was created from.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NamespaceName`  <a name="cfn-redshiftserverless-snapshot-snapshot-namespacename"></a>
The name of the namepsace.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-z0-9-]+$`  
*Minimum*: `3`  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OwnerAccount`  <a name="cfn-redshiftserverless-snapshot-snapshot-owneraccount"></a>
The owner AWS; account of the snapshot.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RetentionPeriod`  <a name="cfn-redshiftserverless-snapshot-snapshot-retentionperiod"></a>
Property description not available.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SnapshotArn`  <a name="cfn-redshiftserverless-snapshot-snapshot-snapshotarn"></a>
The Amazon Resource Name (ARN) of the snapshot.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SnapshotCreateTime`  <a name="cfn-redshiftserverless-snapshot-snapshot-snapshotcreatetime"></a>
The timestamp of when the snapshot was created.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SnapshotName`  <a name="cfn-redshiftserverless-snapshot-snapshot-snapshotname"></a>
The name of the snapshot.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-z0-9-]+$`  
*Minimum*: `3`  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-redshiftserverless-snapshot-snapshot-status"></a>
The status of the snapshot.  
*Required*: No  
*Type*: String  
*Allowed values*: `AVAILABLE | CREATING | DELETED | CANCELLED | FAILED | COPYING`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::RedshiftServerless::Snapshot Tag
<a name="aws-properties-redshiftserverless-snapshot-tag"></a>

A map of key-value pairs.

## Syntax
<a name="aws-properties-redshiftserverless-snapshot-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-redshiftserverless-snapshot-tag-syntax.json"></a>

```
{
  "[Key](#cfn-redshiftserverless-snapshot-tag-key)" : String,
  "[Value](#cfn-redshiftserverless-snapshot-tag-value)" : String
}
```

### YAML
<a name="aws-properties-redshiftserverless-snapshot-tag-syntax.yaml"></a>

```
  [Key](#cfn-redshiftserverless-snapshot-tag-key): String
  [Value](#cfn-redshiftserverless-snapshot-tag-value): String
```

## Properties
<a name="aws-properties-redshiftserverless-snapshot-tag-properties"></a>

`Key`  <a name="cfn-redshiftserverless-snapshot-tag-key"></a>
The key to use in the tag.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Value`  <a name="cfn-redshiftserverless-snapshot-tag-value"></a>
The value of the tag.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::RedshiftServerless::Workgroup
<a name="aws-resource-redshiftserverless-workgroup"></a>

The collection of compute resources in Amazon Redshift Serverless.

## Syntax
<a name="aws-resource-redshiftserverless-workgroup-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-redshiftserverless-workgroup-syntax.json"></a>

```
{
  "Type" : "AWS::RedshiftServerless::Workgroup",
  "Properties" : {
      "[BaseCapacity](#cfn-redshiftserverless-workgroup-basecapacity)" : Integer,
      "[ConfigParameters](#cfn-redshiftserverless-workgroup-configparameters)" : [ ConfigParameter, ... ],
      "[EnhancedVpcRouting](#cfn-redshiftserverless-workgroup-enhancedvpcrouting)" : Boolean,
      "[MaxCapacity](#cfn-redshiftserverless-workgroup-maxcapacity)" : Integer,
      "[NamespaceName](#cfn-redshiftserverless-workgroup-namespacename)" : String,
      "[Port](#cfn-redshiftserverless-workgroup-port)" : Integer,
      "[PricePerformanceTarget](#cfn-redshiftserverless-workgroup-priceperformancetarget)" : PerformanceTarget,
      "[PubliclyAccessible](#cfn-redshiftserverless-workgroup-publiclyaccessible)" : Boolean,
      "[RecoveryPointId](#cfn-redshiftserverless-workgroup-recoverypointid)" : String,
      "[SecurityGroupIds](#cfn-redshiftserverless-workgroup-securitygroupids)" : [ String, ... ],
      "[SnapshotArn](#cfn-redshiftserverless-workgroup-snapshotarn)" : String,
      "[SnapshotName](#cfn-redshiftserverless-workgroup-snapshotname)" : String,
      "[SnapshotOwnerAccount](#cfn-redshiftserverless-workgroup-snapshotowneraccount)" : String,
      "[SubnetIds](#cfn-redshiftserverless-workgroup-subnetids)" : [ String, ... ],
      "[Tags](#cfn-redshiftserverless-workgroup-tags)" : [ Tag, ... ],
      "[TrackName](#cfn-redshiftserverless-workgroup-trackname)" : String,
      "[Workgroup](#cfn-redshiftserverless-workgroup-workgroup)" : Workgroup,
      "[WorkgroupName](#cfn-redshiftserverless-workgroup-workgroupname)" : String
    }
}
```

### YAML
<a name="aws-resource-redshiftserverless-workgroup-syntax.yaml"></a>

```
Type: AWS::RedshiftServerless::Workgroup
Properties:
  [BaseCapacity](#cfn-redshiftserverless-workgroup-basecapacity): Integer
  [ConfigParameters](#cfn-redshiftserverless-workgroup-configparameters): 
    - ConfigParameter
  [EnhancedVpcRouting](#cfn-redshiftserverless-workgroup-enhancedvpcrouting): Boolean
  [MaxCapacity](#cfn-redshiftserverless-workgroup-maxcapacity): Integer
  [NamespaceName](#cfn-redshiftserverless-workgroup-namespacename): String
  [Port](#cfn-redshiftserverless-workgroup-port): Integer
  [PricePerformanceTarget](#cfn-redshiftserverless-workgroup-priceperformancetarget): 
    PerformanceTarget
  [PubliclyAccessible](#cfn-redshiftserverless-workgroup-publiclyaccessible): Boolean
  [RecoveryPointId](#cfn-redshiftserverless-workgroup-recoverypointid): String
  [SecurityGroupIds](#cfn-redshiftserverless-workgroup-securitygroupids): 
    - String
  [SnapshotArn](#cfn-redshiftserverless-workgroup-snapshotarn): String
  [SnapshotName](#cfn-redshiftserverless-workgroup-snapshotname): String
  [SnapshotOwnerAccount](#cfn-redshiftserverless-workgroup-snapshotowneraccount): String
  [SubnetIds](#cfn-redshiftserverless-workgroup-subnetids): 
    - String
  [Tags](#cfn-redshiftserverless-workgroup-tags): 
    - Tag
  [TrackName](#cfn-redshiftserverless-workgroup-trackname): String
  [Workgroup](#cfn-redshiftserverless-workgroup-workgroup): 
    Workgroup
  [WorkgroupName](#cfn-redshiftserverless-workgroup-workgroupname): String
```

## Properties
<a name="aws-resource-redshiftserverless-workgroup-properties"></a>

`BaseCapacity`  <a name="cfn-redshiftserverless-workgroup-basecapacity"></a>
The base compute capacity of the workgroup in Redshift Processing Units (RPUs).  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConfigParameters`  <a name="cfn-redshiftserverless-workgroup-configparameters"></a>
The key of the parameter. The options are `auto_mv`, `datestyle`, `enable_case_sensitive_identifier`, `enable_user_activity_logging`, `query_group`, `search_path`, `require_ssl`, `use_fips_ssl`, 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).  
*Required*: No  
*Type*: Array of [ConfigParameter](aws-properties-redshiftserverless-workgroup-configparameter.md)  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnhancedVpcRouting`  <a name="cfn-redshiftserverless-workgroup-enhancedvpcrouting"></a>
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaxCapacity`  <a name="cfn-redshiftserverless-workgroup-maxcapacity"></a>
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NamespaceName`  <a name="cfn-redshiftserverless-workgroup-namespacename"></a>
The namespace the workgroup is associated with.  
*Required*: No  
*Type*: String  
*Pattern*: `^(?=^[a-z0-9-]+$).{3,64}$`  
*Minimum*: `3`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Port`  <a name="cfn-redshiftserverless-workgroup-port"></a>
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PricePerformanceTarget`  <a name="cfn-redshiftserverless-workgroup-priceperformancetarget"></a>
An object that represents the price performance target settings for the workgroup.  
*Required*: No  
*Type*: [PerformanceTarget](aws-properties-redshiftserverless-workgroup-performancetarget.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PubliclyAccessible`  <a name="cfn-redshiftserverless-workgroup-publiclyaccessible"></a>
A value that specifies whether the workgroup can be accessible from a public network.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RecoveryPointId`  <a name="cfn-redshiftserverless-workgroup-recoverypointid"></a>
The recovery point id to restore from.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecurityGroupIds`  <a name="cfn-redshiftserverless-workgroup-securitygroupids"></a>
A list of security group IDs to associate with the workgroup.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `0 | 1`  
*Maximum*: `255 | 32`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SnapshotArn`  <a name="cfn-redshiftserverless-workgroup-snapshotarn"></a>
The Amazon Resource Name (ARN) of the snapshot to restore from.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SnapshotName`  <a name="cfn-redshiftserverless-workgroup-snapshotname"></a>
The snapshot name to restore from.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SnapshotOwnerAccount`  <a name="cfn-redshiftserverless-workgroup-snapshotowneraccount"></a>
The Amazon Web Services account that owns the snapshot.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SubnetIds`  <a name="cfn-redshiftserverless-workgroup-subnetids"></a>
A list of subnet IDs the workgroup is associated with.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `0 | 1`  
*Maximum*: `255 | 32`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-redshiftserverless-workgroup-tags"></a>
The map of the key-value pairs used to tag the workgroup.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-redshiftserverless-workgroup-tag.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrackName`  <a name="cfn-redshiftserverless-workgroup-trackname"></a>
An optional parameter for the name of the track for the workgroup. If you don't provide a track name, the workgroup is assigned to the current track.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_]+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Workgroup`  <a name="cfn-redshiftserverless-workgroup-workgroup"></a>
The collection of computing resources from which an endpoint is created.  
*Required*: No  
*Type*: [Workgroup](aws-properties-redshiftserverless-workgroup-workgroup.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WorkgroupName`  <a name="cfn-redshiftserverless-workgroup-workgroupname"></a>
The name of the workgroup.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?=^[a-z0-9-]+$).{3,64}$`  
*Minimum*: `3`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-redshiftserverless-workgroup-return-values"></a>

### Ref
<a name="aws-resource-redshiftserverless-workgroup-return-values-ref"></a>

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the WorkgroupName, such as `sample-workgroup.` For more information about using the Ref function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-redshiftserverless-workgroup-return-values-fn--getatt"></a>

GetAtt returns a value for a specified attribute of this type. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). The following are the available attributes and sample return values.

#### 
<a name="aws-resource-redshiftserverless-workgroup-return-values-fn--getatt-fn--getatt"></a>

`Workgroup.BaseCapacity`  <a name="Workgroup.BaseCapacity-fn::getatt"></a>
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).

`Workgroup.ConfigParameters`  <a name="Workgroup.ConfigParameters-fn::getatt"></a>
Property description not available.

`Workgroup.CreationDate`  <a name="Workgroup.CreationDate-fn::getatt"></a>
The creation date of the workgroup.

`Workgroup.Endpoint.Address`  <a name="Workgroup.Endpoint.Address-fn::getatt"></a>
The DNS address of the VPC endpoint.

`Workgroup.Endpoint.Port`  <a name="Workgroup.Endpoint.Port-fn::getatt"></a>
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

`Workgroup.EnhancedVpcRouting`  <a name="Workgroup.EnhancedVpcRouting-fn::getatt"></a>
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

`Workgroup.MaxCapacity`  <a name="Workgroup.MaxCapacity-fn::getatt"></a>
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.

`Workgroup.NamespaceName`  <a name="Workgroup.NamespaceName-fn::getatt"></a>
The namespace the workgroup is associated with.

`Workgroup.PubliclyAccessible`  <a name="Workgroup.PubliclyAccessible-fn::getatt"></a>
A value that specifies whether the workgroup can be accessible from a public network.

`Workgroup.SecurityGroupIds`  <a name="Workgroup.SecurityGroupIds-fn::getatt"></a>
An array of security group IDs to associate with the workgroup.

`Workgroup.Status`  <a name="Workgroup.Status-fn::getatt"></a>
The status of the workgroup.

`Workgroup.SubnetIds`  <a name="Workgroup.SubnetIds-fn::getatt"></a>
An array of subnet IDs the workgroup is associated with.

`Workgroup.TrackName`  <a name="Workgroup.TrackName-fn::getatt"></a>
An optional parameter for the name of the track for the workgroup. If you don't provide a track name, the workgroup is assigned to the current track.

`Workgroup.WorkgroupArn`  <a name="Workgroup.WorkgroupArn-fn::getatt"></a>
The Amazon Resource Name (ARN) that links to the workgroup.

`Workgroup.WorkgroupId`  <a name="Workgroup.WorkgroupId-fn::getatt"></a>
The unique identifier of the workgroup.

`Workgroup.WorkgroupName`  <a name="Workgroup.WorkgroupName-fn::getatt"></a>
The name of the workgroup.

# AWS::RedshiftServerless::Workgroup ConfigParameter
<a name="aws-properties-redshiftserverless-workgroup-configparameter"></a>

A array of parameters to set for more control over a serverless database.

## Syntax
<a name="aws-properties-redshiftserverless-workgroup-configparameter-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-redshiftserverless-workgroup-configparameter-syntax.json"></a>

```
{
  "[ParameterKey](#cfn-redshiftserverless-workgroup-configparameter-parameterkey)" : String,
  "[ParameterValue](#cfn-redshiftserverless-workgroup-configparameter-parametervalue)" : String
}
```

### YAML
<a name="aws-properties-redshiftserverless-workgroup-configparameter-syntax.yaml"></a>

```
  [ParameterKey](#cfn-redshiftserverless-workgroup-configparameter-parameterkey): String
  [ParameterValue](#cfn-redshiftserverless-workgroup-configparameter-parametervalue): String
```

## Properties
<a name="aws-properties-redshiftserverless-workgroup-configparameter-properties"></a>

`ParameterKey`  <a name="cfn-redshiftserverless-workgroup-configparameter-parameterkey"></a>
The key of the parameter. The options are `auto_mv`, `datestyle`, `enable_case_sensitive_identifier`, `enable_user_activity_logging`, `query_group`, `search_path`, `require_ssl`, `use_fips_ssl`, 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).  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ParameterValue`  <a name="cfn-redshiftserverless-workgroup-configparameter-parametervalue"></a>
The value of the parameter to set.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `15000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::RedshiftServerless::Workgroup Endpoint
<a name="aws-properties-redshiftserverless-workgroup-endpoint"></a>

The VPC endpoint object.

## Syntax
<a name="aws-properties-redshiftserverless-workgroup-endpoint-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-redshiftserverless-workgroup-endpoint-syntax.json"></a>

```
{
  "[Address](#cfn-redshiftserverless-workgroup-endpoint-address)" : String,
  "[Port](#cfn-redshiftserverless-workgroup-endpoint-port)" : Integer,
  "[VpcEndpoints](#cfn-redshiftserverless-workgroup-endpoint-vpcendpoints)" : [ VpcEndpoint, ... ]
}
```

### YAML
<a name="aws-properties-redshiftserverless-workgroup-endpoint-syntax.yaml"></a>

```
  [Address](#cfn-redshiftserverless-workgroup-endpoint-address): String
  [Port](#cfn-redshiftserverless-workgroup-endpoint-port): Integer
  [VpcEndpoints](#cfn-redshiftserverless-workgroup-endpoint-vpcendpoints): 
    - VpcEndpoint
```

## Properties
<a name="aws-properties-redshiftserverless-workgroup-endpoint-properties"></a>

`Address`  <a name="cfn-redshiftserverless-workgroup-endpoint-address"></a>
The DNS address of the VPC endpoint.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Port`  <a name="cfn-redshiftserverless-workgroup-endpoint-port"></a>
The port that Amazon Redshift Serverless listens on.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcEndpoints`  <a name="cfn-redshiftserverless-workgroup-endpoint-vpcendpoints"></a>
An array of `VpcEndpoint` objects.  
*Required*: No  
*Type*: Array of [VpcEndpoint](aws-properties-redshiftserverless-workgroup-vpcendpoint.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::RedshiftServerless::Workgroup NetworkInterface
<a name="aws-properties-redshiftserverless-workgroup-networkinterface"></a>

Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint. 

## Syntax
<a name="aws-properties-redshiftserverless-workgroup-networkinterface-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-redshiftserverless-workgroup-networkinterface-syntax.json"></a>

```
{
  "[AvailabilityZone](#cfn-redshiftserverless-workgroup-networkinterface-availabilityzone)" : String,
  "[NetworkInterfaceId](#cfn-redshiftserverless-workgroup-networkinterface-networkinterfaceid)" : String,
  "[PrivateIpAddress](#cfn-redshiftserverless-workgroup-networkinterface-privateipaddress)" : String,
  "[SubnetId](#cfn-redshiftserverless-workgroup-networkinterface-subnetid)" : String
}
```

### YAML
<a name="aws-properties-redshiftserverless-workgroup-networkinterface-syntax.yaml"></a>

```
  [AvailabilityZone](#cfn-redshiftserverless-workgroup-networkinterface-availabilityzone): String
  [NetworkInterfaceId](#cfn-redshiftserverless-workgroup-networkinterface-networkinterfaceid): String
  [PrivateIpAddress](#cfn-redshiftserverless-workgroup-networkinterface-privateipaddress): String
  [SubnetId](#cfn-redshiftserverless-workgroup-networkinterface-subnetid): String
```

## Properties
<a name="aws-properties-redshiftserverless-workgroup-networkinterface-properties"></a>

`AvailabilityZone`  <a name="cfn-redshiftserverless-workgroup-networkinterface-availabilityzone"></a>
The availability Zone.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NetworkInterfaceId`  <a name="cfn-redshiftserverless-workgroup-networkinterface-networkinterfaceid"></a>
The unique identifier of the network interface.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PrivateIpAddress`  <a name="cfn-redshiftserverless-workgroup-networkinterface-privateipaddress"></a>
The IPv4 address of the network interface within the subnet.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SubnetId`  <a name="cfn-redshiftserverless-workgroup-networkinterface-subnetid"></a>
The unique identifier of the subnet.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::RedshiftServerless::Workgroup PerformanceTarget
<a name="aws-properties-redshiftserverless-workgroup-performancetarget"></a>

An object that represents the price performance target settings for the workgroup.

## Syntax
<a name="aws-properties-redshiftserverless-workgroup-performancetarget-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-redshiftserverless-workgroup-performancetarget-syntax.json"></a>

```
{
  "[Level](#cfn-redshiftserverless-workgroup-performancetarget-level)" : Integer,
  "[Status](#cfn-redshiftserverless-workgroup-performancetarget-status)" : String
}
```

### YAML
<a name="aws-properties-redshiftserverless-workgroup-performancetarget-syntax.yaml"></a>

```
  [Level](#cfn-redshiftserverless-workgroup-performancetarget-level): Integer
  [Status](#cfn-redshiftserverless-workgroup-performancetarget-status): String
```

## Properties
<a name="aws-properties-redshiftserverless-workgroup-performancetarget-properties"></a>

`Level`  <a name="cfn-redshiftserverless-workgroup-performancetarget-level"></a>
The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW\$1COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH\$1PERFORMANCE.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-redshiftserverless-workgroup-performancetarget-status"></a>
Whether the price performance target is enabled for the workgroup.  
*Required*: No  
*Type*: String  
*Allowed values*: `ENABLED | DISABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::RedshiftServerless::Workgroup Tag
<a name="aws-properties-redshiftserverless-workgroup-tag"></a>

A map of key-value pairs.

## Syntax
<a name="aws-properties-redshiftserverless-workgroup-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-redshiftserverless-workgroup-tag-syntax.json"></a>

```
{
  "[Key](#cfn-redshiftserverless-workgroup-tag-key)" : String,
  "[Value](#cfn-redshiftserverless-workgroup-tag-value)" : String
}
```

### YAML
<a name="aws-properties-redshiftserverless-workgroup-tag-syntax.yaml"></a>

```
  [Key](#cfn-redshiftserverless-workgroup-tag-key): String
  [Value](#cfn-redshiftserverless-workgroup-tag-value): String
```

## Properties
<a name="aws-properties-redshiftserverless-workgroup-tag-properties"></a>

`Key`  <a name="cfn-redshiftserverless-workgroup-tag-key"></a>
The key to use in the tag.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-redshiftserverless-workgroup-tag-value"></a>
The value of the tag.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::RedshiftServerless::Workgroup VpcEndpoint
<a name="aws-properties-redshiftserverless-workgroup-vpcendpoint"></a>

The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.

## Syntax
<a name="aws-properties-redshiftserverless-workgroup-vpcendpoint-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-redshiftserverless-workgroup-vpcendpoint-syntax.json"></a>

```
{
  "[NetworkInterfaces](#cfn-redshiftserverless-workgroup-vpcendpoint-networkinterfaces)" : [ NetworkInterface, ... ],
  "[VpcEndpointId](#cfn-redshiftserverless-workgroup-vpcendpoint-vpcendpointid)" : String,
  "[VpcId](#cfn-redshiftserverless-workgroup-vpcendpoint-vpcid)" : String
}
```

### YAML
<a name="aws-properties-redshiftserverless-workgroup-vpcendpoint-syntax.yaml"></a>

```
  [NetworkInterfaces](#cfn-redshiftserverless-workgroup-vpcendpoint-networkinterfaces): 
    - NetworkInterface
  [VpcEndpointId](#cfn-redshiftserverless-workgroup-vpcendpoint-vpcendpointid): String
  [VpcId](#cfn-redshiftserverless-workgroup-vpcendpoint-vpcid): String
```

## Properties
<a name="aws-properties-redshiftserverless-workgroup-vpcendpoint-properties"></a>

`NetworkInterfaces`  <a name="cfn-redshiftserverless-workgroup-vpcendpoint-networkinterfaces"></a>
One or more network interfaces of the endpoint. Also known as an interface endpoint.  
*Required*: No  
*Type*: Array of [NetworkInterface](aws-properties-redshiftserverless-workgroup-networkinterface.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcEndpointId`  <a name="cfn-redshiftserverless-workgroup-vpcendpoint-vpcendpointid"></a>
The connection endpoint ID for connecting to Amazon Redshift Serverless.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcId`  <a name="cfn-redshiftserverless-workgroup-vpcendpoint-vpcid"></a>
The VPC identifier that the endpoint is associated with.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::RedshiftServerless::Workgroup Workgroup
<a name="aws-properties-redshiftserverless-workgroup-workgroup"></a>

The collection of computing resources from which an endpoint is created.

## Syntax
<a name="aws-properties-redshiftserverless-workgroup-workgroup-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-redshiftserverless-workgroup-workgroup-syntax.json"></a>

```
{
  "[BaseCapacity](#cfn-redshiftserverless-workgroup-workgroup-basecapacity)" : Integer,
  "[ConfigParameters](#cfn-redshiftserverless-workgroup-workgroup-configparameters)" : [ ConfigParameter, ... ],
  "[CreationDate](#cfn-redshiftserverless-workgroup-workgroup-creationdate)" : String,
  "[Endpoint](#cfn-redshiftserverless-workgroup-workgroup-endpoint)" : Endpoint,
  "[EnhancedVpcRouting](#cfn-redshiftserverless-workgroup-workgroup-enhancedvpcrouting)" : Boolean,
  "[MaxCapacity](#cfn-redshiftserverless-workgroup-workgroup-maxcapacity)" : Integer,
  "[NamespaceName](#cfn-redshiftserverless-workgroup-workgroup-namespacename)" : String,
  "[PricePerformanceTarget](#cfn-redshiftserverless-workgroup-workgroup-priceperformancetarget)" : PerformanceTarget,
  "[PubliclyAccessible](#cfn-redshiftserverless-workgroup-workgroup-publiclyaccessible)" : Boolean,
  "[SecurityGroupIds](#cfn-redshiftserverless-workgroup-workgroup-securitygroupids)" : [ String, ... ],
  "[Status](#cfn-redshiftserverless-workgroup-workgroup-status)" : String,
  "[SubnetIds](#cfn-redshiftserverless-workgroup-workgroup-subnetids)" : [ String, ... ],
  "[TrackName](#cfn-redshiftserverless-workgroup-workgroup-trackname)" : String,
  "[WorkgroupArn](#cfn-redshiftserverless-workgroup-workgroup-workgrouparn)" : String,
  "[WorkgroupId](#cfn-redshiftserverless-workgroup-workgroup-workgroupid)" : String,
  "[WorkgroupName](#cfn-redshiftserverless-workgroup-workgroup-workgroupname)" : String
}
```

### YAML
<a name="aws-properties-redshiftserverless-workgroup-workgroup-syntax.yaml"></a>

```
  [BaseCapacity](#cfn-redshiftserverless-workgroup-workgroup-basecapacity): Integer
  [ConfigParameters](#cfn-redshiftserverless-workgroup-workgroup-configparameters): 
    - ConfigParameter
  [CreationDate](#cfn-redshiftserverless-workgroup-workgroup-creationdate): String
  [Endpoint](#cfn-redshiftserverless-workgroup-workgroup-endpoint): 
    Endpoint
  [EnhancedVpcRouting](#cfn-redshiftserverless-workgroup-workgroup-enhancedvpcrouting): Boolean
  [MaxCapacity](#cfn-redshiftserverless-workgroup-workgroup-maxcapacity): Integer
  [NamespaceName](#cfn-redshiftserverless-workgroup-workgroup-namespacename): String
  [PricePerformanceTarget](#cfn-redshiftserverless-workgroup-workgroup-priceperformancetarget): 
    PerformanceTarget
  [PubliclyAccessible](#cfn-redshiftserverless-workgroup-workgroup-publiclyaccessible): Boolean
  [SecurityGroupIds](#cfn-redshiftserverless-workgroup-workgroup-securitygroupids): 
    - String
  [Status](#cfn-redshiftserverless-workgroup-workgroup-status): String
  [SubnetIds](#cfn-redshiftserverless-workgroup-workgroup-subnetids): 
    - String
  [TrackName](#cfn-redshiftserverless-workgroup-workgroup-trackname): String
  [WorkgroupArn](#cfn-redshiftserverless-workgroup-workgroup-workgrouparn): String
  [WorkgroupId](#cfn-redshiftserverless-workgroup-workgroup-workgroupid): String
  [WorkgroupName](#cfn-redshiftserverless-workgroup-workgroup-workgroupname): String
```

## Properties
<a name="aws-properties-redshiftserverless-workgroup-workgroup-properties"></a>

`BaseCapacity`  <a name="cfn-redshiftserverless-workgroup-workgroup-basecapacity"></a>
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConfigParameters`  <a name="cfn-redshiftserverless-workgroup-workgroup-configparameters"></a>
An array of parameters to set for advanced control over a database. The options are `auto_mv`, `datestyle`, `enable_case_sensitive_identifier`, `enable_user_activity_logging`, `query_group`, `search_path`, `require_ssl`, `use_fips_ssl`, and either `wlm_json_configuration` or query monitoring metrics that let you define performance boundaries. You can either specify individual query monitoring metrics (such as `max_scan_row_count`, `max_query_execution_time`) or use `wlm_json_configuration` to define query queues with rules, but not both. If you're using `wlm_json_configuration`, the maximum size of `parameterValue` is 8000 characters. 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).  
*Required*: No  
*Type*: Array of [ConfigParameter](aws-properties-redshiftserverless-workgroup-configparameter.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CreationDate`  <a name="cfn-redshiftserverless-workgroup-workgroup-creationdate"></a>
The creation date of the workgroup.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Endpoint`  <a name="cfn-redshiftserverless-workgroup-workgroup-endpoint"></a>
The endpoint that is created from the workgroup.  
*Required*: No  
*Type*: [Endpoint](aws-properties-redshiftserverless-workgroup-endpoint.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnhancedVpcRouting`  <a name="cfn-redshiftserverless-workgroup-workgroup-enhancedvpcrouting"></a>
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaxCapacity`  <a name="cfn-redshiftserverless-workgroup-workgroup-maxcapacity"></a>
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NamespaceName`  <a name="cfn-redshiftserverless-workgroup-workgroup-namespacename"></a>
The namespace the workgroup is associated with.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-z0-9-]+$`  
*Minimum*: `3`  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PricePerformanceTarget`  <a name="cfn-redshiftserverless-workgroup-workgroup-priceperformancetarget"></a>
An object that represents the price performance target settings for the workgroup.  
*Required*: No  
*Type*: [PerformanceTarget](aws-properties-redshiftserverless-workgroup-performancetarget.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PubliclyAccessible`  <a name="cfn-redshiftserverless-workgroup-workgroup-publiclyaccessible"></a>
A value that specifies whether the workgroup can be accessible from a public network.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecurityGroupIds`  <a name="cfn-redshiftserverless-workgroup-workgroup-securitygroupids"></a>
An array of security group IDs to associate with the workgroup.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `0`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-redshiftserverless-workgroup-workgroup-status"></a>
The status of the workgroup.  
*Required*: No  
*Type*: String  
*Allowed values*: `CREATING | AVAILABLE | MODIFYING | DELETING`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SubnetIds`  <a name="cfn-redshiftserverless-workgroup-workgroup-subnetids"></a>
An array of subnet IDs the workgroup is associated with.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `0`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrackName`  <a name="cfn-redshiftserverless-workgroup-workgroup-trackname"></a>
The name of the track for the workgroup.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_]+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WorkgroupArn`  <a name="cfn-redshiftserverless-workgroup-workgroup-workgrouparn"></a>
The Amazon Resource Name (ARN) that links to the workgroup.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WorkgroupId`  <a name="cfn-redshiftserverless-workgroup-workgroup-workgroupid"></a>
The unique identifier of the workgroup.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WorkgroupName`  <a name="cfn-redshiftserverless-workgroup-workgroup-workgroupname"></a>
The name of the workgroup.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-z0-9-]*$`  
*Minimum*: `3`  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)