Package software.amazon.awscdk.services.sagemaker

Interface CfnCluster.ClusterAccountingDatabaseProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCluster.ClusterAccountingDatabaseProperty.Jsii$Proxy

Enclosing class:

CfnCluster

@Stability(Stable)
public static interface CfnCluster.ClusterAccountingDatabaseProperty
extends software.amazon.jsii.JsiiSerializable

External MySQL-compatible accounting database that a Slurm cluster's slurmdbd connects to.

Database credentials are supplied out-of-band through the referenced Secrets Manager secret. Supported only with Continuous node provisioning.

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.sagemaker.*;
 ClusterAccountingDatabaseProperty clusterAccountingDatabaseProperty = ClusterAccountingDatabaseProperty.builder()
         .endpoint("endpoint")
         .secretArn("secretArn")
         // the properties below are optional
         .name("name")
         .port(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusteraccountingdatabase.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCluster.ClusterAccountingDatabaseProperty.Builder	A builder for CfnCluster.ClusterAccountingDatabaseProperty
static final class	CfnCluster.ClusterAccountingDatabaseProperty.Jsii$Proxy	An implementation for CfnCluster.ClusterAccountingDatabaseProperty

Method Summary

Modifier and Type	Method	Description
static CfnCluster.ClusterAccountingDatabaseProperty.Builder	builder()
String	getEndpoint()	Hostname or endpoint of the accounting database, such as an RDS endpoint.
default String	getName()	Name of the accounting database schema.
default Number	getPort()	TCP port of the accounting database.
String	getSecretArn()	ARN of the Secrets Manager secret holding the database credentials.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndpoint

@Stability(Stable)
@NotNull
String getEndpoint()

Hostname or endpoint of the accounting database, such as an RDS endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusteraccountingdatabase.html#cfn-sagemaker-cluster-clusteraccountingdatabase-endpoint

getSecretArn

@Stability(Stable)
@NotNull
String getSecretArn()

ARN of the Secrets Manager secret holding the database credentials.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusteraccountingdatabase.html#cfn-sagemaker-cluster-clusteraccountingdatabase-secretarn

getName

@Stability(Stable)
@Nullable
default String getName()

Name of the accounting database schema.

Defaults to slurm_acct_db when omitted.

Default: - "slurm_acct_db"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusteraccountingdatabase.html#cfn-sagemaker-cluster-clusteraccountingdatabase-name

getPort

@Stability(Stable)
@Nullable
default Number getPort()

TCP port of the accounting database.

Defaults to 3306 when omitted.

Default: - 3306

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusteraccountingdatabase.html#cfn-sagemaker-cluster-clusteraccountingdatabase-port

builder

@Stability(Stable)
static CfnCluster.ClusterAccountingDatabaseProperty.Builder builder()

Returns:

a CfnCluster.ClusterAccountingDatabaseProperty.Builder of CfnCluster.ClusterAccountingDatabaseProperty