Show / Hide Table of Contents

Class CfnNamespacePropsMixin.NamespaceProperty

A collection of database objects and users.

Inheritance
object
CfnNamespacePropsMixin.NamespaceProperty
Implements
CfnNamespacePropsMixin.INamespaceProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.Mixins.Preview.AWS.RedshiftServerless.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnNamespacePropsMixin.NamespaceProperty : CfnNamespacePropsMixin.INamespaceProperty
Syntax (vb)
Public Class CfnNamespacePropsMixin.NamespaceProperty Implements CfnNamespacePropsMixin.INamespaceProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html

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.Mixins.Preview.AWS.RedshiftServerless.Mixins;

             var namespaceProperty = new NamespaceProperty {
                 AdminPasswordSecretArn = "adminPasswordSecretArn",
                 AdminPasswordSecretKmsKeyId = "adminPasswordSecretKmsKeyId",
                 AdminUsername = "adminUsername",
                 CreationDate = "creationDate",
                 DbName = "dbName",
                 DefaultIamRoleArn = "defaultIamRoleArn",
                 IamRoles = new [] { "iamRoles" },
                 KmsKeyId = "kmsKeyId",
                 LogExports = new [] { "logExports" },
                 NamespaceArn = "namespaceArn",
                 NamespaceId = "namespaceId",
                 NamespaceName = "namespaceName",
                 Status = "status"
             };

Synopsis

Constructors

NamespaceProperty()

A collection of database objects and users.

Properties

AdminPasswordSecretArn

The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

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 first database created in the namespace.

CreationDate

The date of when the namespace was created.

DbName

The name of the first database created in the namespace.

DefaultIamRoleArn

The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

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.

NamespaceArn

The Amazon Resource Name (ARN) associated with a namespace.

NamespaceId

The unique identifier of a namespace.

NamespaceName

The name of the namespace.

Status

The status of the namespace.

Constructors

NamespaceProperty()

A collection of database objects and users.

public NamespaceProperty()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html

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.Mixins.Preview.AWS.RedshiftServerless.Mixins;

             var namespaceProperty = new NamespaceProperty {
                 AdminPasswordSecretArn = "adminPasswordSecretArn",
                 AdminPasswordSecretKmsKeyId = "adminPasswordSecretKmsKeyId",
                 AdminUsername = "adminUsername",
                 CreationDate = "creationDate",
                 DbName = "dbName",
                 DefaultIamRoleArn = "defaultIamRoleArn",
                 IamRoles = new [] { "iamRoles" },
                 KmsKeyId = "kmsKeyId",
                 LogExports = new [] { "logExports" },
                 NamespaceArn = "namespaceArn",
                 NamespaceId = "namespaceId",
                 NamespaceName = "namespaceName",
                 Status = "status"
             };

Properties

AdminPasswordSecretArn

The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

public string? AdminPasswordSecretArn { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-adminpasswordsecretarn

AdminPasswordSecretKmsKeyId

The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.

public string? AdminPasswordSecretKmsKeyId { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-adminpasswordsecretkmskeyid

AdminUsername

The username of the administrator for the first database created in the namespace.

public string? AdminUsername { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-adminusername

CreationDate

The date of when the namespace was created.

public string? CreationDate { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-creationdate

DbName

The name of the first database created in the namespace.

public string? DbName { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-dbname

DefaultIamRoleArn

The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

public string? DefaultIamRoleArn { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-defaultiamrolearn

IamRoles

A list of IAM roles to associate with the namespace.

public string[]? IamRoles { get; set; }
Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-iamroles

KmsKeyId

The ID of the AWS Key Management Service key used to encrypt your data.

public string? KmsKeyId { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-kmskeyid

LogExports

The types of logs the namespace can export.

public string[]? LogExports { get; set; }
Property Value

string[]

Remarks

Available export types are User log, Connection log, and User activity log.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-logexports

NamespaceArn

The Amazon Resource Name (ARN) associated with a namespace.

public string? NamespaceArn { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-namespacearn

NamespaceId

The unique identifier of a namespace.

public string? NamespaceId { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-namespaceid

NamespaceName

The name of the namespace.

public string? NamespaceName { get; set; }
Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-namespacename

Status

The status of the namespace.

public string? Status { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-status

Implements

CfnNamespacePropsMixin.INamespaceProperty
Back to top Generated by DocFX