@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:39.476Z") public class CfnNamespace extends CfnResource implements IInspectable
A collection of database objects and users.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.redshiftserverless.*; CfnNamespace cfnNamespace = CfnNamespace.Builder.create(this, "MyCfnNamespace") .namespaceName("namespaceName") // the properties below are optional .adminUsername("adminUsername") .adminUserPassword("adminUserPassword") .dbName("dbName") .defaultIamRoleArn("defaultIamRoleArn") .finalSnapshotName("finalSnapshotName") .finalSnapshotRetentionPeriod(123) .iamRoles(List.of("iamRoles")) .kmsKeyId("kmsKeyId") .logExports(List.of("logExports")) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnNamespace.Builder
A fluent builder for
CfnNamespace . |
static interface |
CfnNamespace.NamespaceProperty
A collection of database objects and users.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnNamespace(Construct scope,
java.lang.String id,
CfnNamespaceProps props)
Create a new `AWS::RedshiftServerless::Namespace`.
|
protected |
CfnNamespace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnNamespace(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAdminUsername()
The username of the administrator for the primary database created in the namespace.
|
java.lang.String |
getAdminUserPassword()
The password of the administrator for the primary database created in the namespace.
|
java.lang.String |
getAttrNamespaceAdminUsername()
The username of the administrator for the first database created in the namespace.
|
java.lang.String |
getAttrNamespaceCreationDate()
The date of when the namespace was created.
|
java.lang.String |
getAttrNamespaceDbName()
The name of the first database created in the namespace.
|
java.lang.String |
getAttrNamespaceDefaultIamRoleArn()
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
|
java.util.List<java.lang.String> |
getAttrNamespaceIamRoles()
A list of IAM roles to associate with the namespace.
|
java.lang.String |
getAttrNamespaceKmsKeyId()
The ID of the AWS Key Management Service key used to encrypt your data.
|
java.util.List<java.lang.String> |
getAttrNamespaceLogExports()
The types of logs the namespace can export.
|
java.lang.String |
getAttrNamespaceNamespaceArn()
The Amazon Resource Name (ARN) associated with a namespace.
|
java.lang.String |
getAttrNamespaceNamespaceId()
The unique identifier of a namespace.
|
java.lang.String |
getAttrNamespaceNamespaceName()
The name of the namespace.
|
java.lang.String |
getAttrNamespaceStatus()
The status of the namespace.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDbName()
The name of the primary database created in the namespace.
|
java.lang.String |
getDefaultIamRoleArn()
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
|
java.lang.String |
getFinalSnapshotName()
The name of the snapshot to be created before the namespace is deleted.
|
java.lang.Number |
getFinalSnapshotRetentionPeriod()
How long to retain the final snapshot.
|
java.util.List<java.lang.String> |
getIamRoles()
A list of IAM roles to associate with the namespace.
|
java.lang.String |
getKmsKeyId()
The ID of the AWS Key Management Service key used to encrypt your data.
|
java.util.List<java.lang.String> |
getLogExports()
The types of logs the namespace can export.
|
java.lang.String |
getNamespaceName()
The name of the namespace.
|
TagManager |
getTags()
The map of the key-value pairs used to tag the namespace.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAdminUsername(java.lang.String value)
The username of the administrator for the primary database created in the namespace.
|
void |
setAdminUserPassword(java.lang.String value)
The password of the administrator for the primary database created in the namespace.
|
void |
setDbName(java.lang.String value)
The name of the primary database created in the namespace.
|
void |
setDefaultIamRoleArn(java.lang.String value)
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
|
void |
setFinalSnapshotName(java.lang.String value)
The name of the snapshot to be created before the namespace is deleted.
|
void |
setFinalSnapshotRetentionPeriod(java.lang.Number value)
How long to retain the final snapshot.
|
void |
setIamRoles(java.util.List<java.lang.String> value)
A list of IAM roles to associate with the namespace.
|
void |
setKmsKeyId(java.lang.String value)
The ID of the AWS Key Management Service key used to encrypt your data.
|
void |
setLogExports(java.util.List<java.lang.String> value)
The types of logs the namespace can export.
|
void |
setNamespaceName(java.lang.String value)
The name of the namespace.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnNamespace(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnNamespace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnNamespace(Construct scope, java.lang.String id, CfnNamespaceProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrNamespaceAdminUsername()
public java.lang.String getAttrNamespaceCreationDate()
public java.lang.String getAttrNamespaceDbName()
public java.lang.String getAttrNamespaceDefaultIamRoleArn()
public java.util.List<java.lang.String> getAttrNamespaceIamRoles()
public java.lang.String getAttrNamespaceKmsKeyId()
public java.util.List<java.lang.String> getAttrNamespaceLogExports()
Available export types are User log
, Connection log
, and User activity log
.
public java.lang.String getAttrNamespaceNamespaceArn()
public java.lang.String getAttrNamespaceNamespaceId()
public java.lang.String getAttrNamespaceNamespaceName()
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.
public java.lang.String getAttrNamespaceStatus()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getNamespaceName()
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.
public void setNamespaceName(java.lang.String value)
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.
public java.lang.String getAdminUsername()
public void setAdminUsername(java.lang.String value)
public java.lang.String getAdminUserPassword()
public void setAdminUserPassword(java.lang.String value)
public java.lang.String getDbName()
public void setDbName(java.lang.String value)
public java.lang.String getDefaultIamRoleArn()
public void setDefaultIamRoleArn(java.lang.String value)
public java.lang.String getFinalSnapshotName()
public void setFinalSnapshotName(java.lang.String value)
public java.lang.Number getFinalSnapshotRetentionPeriod()
public void setFinalSnapshotRetentionPeriod(java.lang.Number value)
public java.util.List<java.lang.String> getIamRoles()
public void setIamRoles(java.util.List<java.lang.String> value)
public java.lang.String getKmsKeyId()
public void setKmsKeyId(java.lang.String value)
public java.util.List<java.lang.String> getLogExports()
Available export types are userlog
, connectionlog
, and useractivitylog
.
public void setLogExports(java.util.List<java.lang.String> value)
Available export types are userlog
, connectionlog
, and useractivitylog
.