Class CfnNamespace
A collection of database objects and users.
Inherited Members
Namespace: Amazon.CDK.AWS.RedshiftServerless
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnNamespace : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnNamespace
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
CloudformationResource: AWS::RedshiftServerless::Namespace
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RedshiftServerless;
var namespaceResourcePolicy;
var cfnNamespace = new CfnNamespace(this, "MyCfnNamespace", new CfnNamespaceProps {
NamespaceName = "namespaceName",
// the properties below are optional
AdminPasswordSecretKmsKeyId = "adminPasswordSecretKmsKeyId",
AdminUsername = "adminUsername",
AdminUserPassword = "adminUserPassword",
DbName = "dbName",
DefaultIamRoleArn = "defaultIamRoleArn",
FinalSnapshotName = "finalSnapshotName",
FinalSnapshotRetentionPeriod = 123,
IamRoles = new [] { "iamRoles" },
KmsKeyId = "kmsKeyId",
LogExports = new [] { "logExports" },
ManageAdminPassword = false,
NamespaceResourcePolicy = namespaceResourcePolicy,
RedshiftIdcApplicationArn = "redshiftIdcApplicationArn",
SnapshotCopyConfigurations = new [] { new SnapshotCopyConfigurationProperty {
DestinationRegion = "destinationRegion",
// the properties below are optional
DestinationKmsKeyId = "destinationKmsKeyId",
SnapshotRetentionPeriod = 123
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnNamespace(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnNamespace(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnNamespace(Construct, String, ICfnNamespaceProps) |
Properties
AdminPasswordSecretKmsKeyId | The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. |
AdminUsername | The username of the administrator for the primary database created in the namespace. |
AdminUserPassword | The password of the administrator for the primary database created in the namespace. |
AttrNamespace | |
AttrNamespaceAdminUsername | The username of the administrator for the first database created in the namespace. |
AttrNamespaceCreationDate | The date of when the namespace was created. |
AttrNamespaceDbName | The name of the first database created in the namespace. |
AttrNamespaceDefaultIamRoleArn | The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. |
AttrNamespaceIamRoles | A list of IAM roles to associate with the namespace. |
AttrNamespaceKmsKeyId | The ID of the AWS Key Management Service key used to encrypt your data. |
AttrNamespaceLogExports | The types of logs the namespace can export. |
AttrNamespaceNamespaceArn | The Amazon Resource Name (ARN) associated with a namespace. |
AttrNamespaceNamespaceId | The unique identifier of a namespace. |
AttrNamespaceNamespaceName | The name of the namespace. |
AttrNamespaceStatus | The status of the namespace. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DbName | The name of the primary database created in the namespace. |
DefaultIamRoleArn | The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. |
FinalSnapshotName | The name of the snapshot to be created before the namespace is deleted. |
FinalSnapshotRetentionPeriod | How long to retain the final snapshot. |
IamRoles | A list of IAM roles to associate with the namespace. |
KmsKeyId | The ID of the AWS Key Management Service key used to encrypt your data. |
LogExports | The types of logs the namespace can export. |
ManageAdminPassword | If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. |
NamespaceName | The name of the namespace. |
NamespaceResourcePolicy | The resource policy that will be attached to the namespace. |
RedshiftIdcApplicationArn | The ARN for the Redshift application that integrates with IAM Identity Center. |
SnapshotCopyConfigurations | The snapshot copy configurations for the namespace. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The map of the key-value pairs used to tag the namespace. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnNamespace(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnNamespace(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnNamespace(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnNamespace(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnNamespace(Construct, String, ICfnNamespaceProps)
public CfnNamespace(Construct scope, string id, ICfnNamespaceProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnNamespaceProps
Resource properties.
Properties
AdminPasswordSecretKmsKeyId
The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
public virtual string AdminPasswordSecretKmsKeyId { get; set; }
Property Value
System.String
AdminUsername
The username of the administrator for the primary database created in the namespace.
public virtual string AdminUsername { get; set; }
Property Value
System.String
AdminUserPassword
The password of the administrator for the primary database created in the namespace.
public virtual string AdminUserPassword { get; set; }
Property Value
System.String
AttrNamespace
public virtual IResolvable AttrNamespace { get; }
Property Value
Remarks
CloudformationAttribute: Namespace
AttrNamespaceAdminUsername
The username of the administrator for the first database created in the namespace.
public virtual string AttrNamespaceAdminUsername { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Namespace.AdminUsername
AttrNamespaceCreationDate
The date of when the namespace was created.
public virtual string AttrNamespaceCreationDate { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Namespace.CreationDate
AttrNamespaceDbName
The name of the first database created in the namespace.
public virtual string AttrNamespaceDbName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Namespace.DbName
AttrNamespaceDefaultIamRoleArn
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
public virtual string AttrNamespaceDefaultIamRoleArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Namespace.DefaultIamRoleArn
AttrNamespaceIamRoles
A list of IAM roles to associate with the namespace.
public virtual string[] AttrNamespaceIamRoles { get; }
Property Value
System.String[]
Remarks
CloudformationAttribute: Namespace.IamRoles
AttrNamespaceKmsKeyId
The ID of the AWS Key Management Service key used to encrypt your data.
public virtual string AttrNamespaceKmsKeyId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Namespace.KmsKeyId
AttrNamespaceLogExports
The types of logs the namespace can export.
public virtual string[] AttrNamespaceLogExports { get; }
Property Value
System.String[]
Remarks
Available export types are User log
, Connection log
, and User activity log
.
CloudformationAttribute: Namespace.LogExports
AttrNamespaceNamespaceArn
The Amazon Resource Name (ARN) associated with a namespace.
public virtual string AttrNamespaceNamespaceArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Namespace.NamespaceArn
AttrNamespaceNamespaceId
The unique identifier of a namespace.
public virtual string AttrNamespaceNamespaceId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Namespace.NamespaceId
AttrNamespaceNamespaceName
The name of the namespace.
public virtual string AttrNamespaceNamespaceName { get; }
Property Value
System.String
Remarks
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 in the Amazon Redshift Database Developer Guide.
CloudformationAttribute: Namespace.NamespaceName
AttrNamespaceStatus
The status of the namespace.
public virtual string AttrNamespaceStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Namespace.Status
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DbName
The name of the primary database created in the namespace.
public virtual string DbName { get; set; }
Property Value
System.String
DefaultIamRoleArn
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
public virtual string DefaultIamRoleArn { get; set; }
Property Value
System.String
FinalSnapshotName
The name of the snapshot to be created before the namespace is deleted.
public virtual string FinalSnapshotName { get; set; }
Property Value
System.String
FinalSnapshotRetentionPeriod
How long to retain the final snapshot.
public virtual Nullable<double> FinalSnapshotRetentionPeriod { get; set; }
Property Value
System.Nullable<System.Double>
IamRoles
A list of IAM roles to associate with the namespace.
public virtual string[] IamRoles { get; set; }
Property Value
System.String[]
KmsKeyId
The ID of the AWS Key Management Service key used to encrypt your data.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
LogExports
The types of logs the namespace can export.
public virtual string[] LogExports { get; set; }
Property Value
System.String[]
ManageAdminPassword
If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials.
public virtual object ManageAdminPassword { get; set; }
Property Value
System.Object
NamespaceName
The name of the namespace.
public virtual string NamespaceName { get; set; }
Property Value
System.String
NamespaceResourcePolicy
The resource policy that will be attached to the namespace.
public virtual object NamespaceResourcePolicy { get; set; }
Property Value
System.Object
RedshiftIdcApplicationArn
The ARN for the Redshift application that integrates with IAM Identity Center.
public virtual string RedshiftIdcApplicationArn { get; set; }
Property Value
System.String
SnapshotCopyConfigurations
The snapshot copy configurations for the namespace.
public virtual object SnapshotCopyConfigurations { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The map of the key-value pairs used to tag the namespace.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>