Package software.amazon.awscdk.services.dms

Class CfnDataProvider.OracleSettingsProperty.Builder

java.lang.Object

software.amazon.awscdk.services.dms.CfnDataProvider.OracleSettingsProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDataProvider.OracleSettingsProperty>

Enclosing interface:

CfnDataProvider.OracleSettingsProperty

@Stability(Stable)
public static final class CfnDataProvider.OracleSettingsProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataProvider.OracleSettingsProperty>

A builder for CfnDataProvider.OracleSettingsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDataProvider.OracleSettingsProperty.Builder	asmServer(String asmServer)	Sets the value of CfnDataProvider.OracleSettingsProperty.getAsmServer()
CfnDataProvider.OracleSettingsProperty	build()	Builds the configured instance.
CfnDataProvider.OracleSettingsProperty.Builder	certificateArn(String certificateArn)	Sets the value of CfnDataProvider.OracleSettingsProperty.getCertificateArn()
CfnDataProvider.OracleSettingsProperty.Builder	databaseName(String databaseName)	Sets the value of CfnDataProvider.OracleSettingsProperty.getDatabaseName()
CfnDataProvider.OracleSettingsProperty.Builder	port(Number port)	Sets the value of CfnDataProvider.OracleSettingsProperty.getPort()
CfnDataProvider.OracleSettingsProperty.Builder	secretsManagerOracleAsmAccessRoleArn(String secretsManagerOracleAsmAccessRoleArn)	Sets the value of CfnDataProvider.OracleSettingsProperty.getSecretsManagerOracleAsmAccessRoleArn()
CfnDataProvider.OracleSettingsProperty.Builder	secretsManagerOracleAsmSecretId(String secretsManagerOracleAsmSecretId)	Sets the value of CfnDataProvider.OracleSettingsProperty.getSecretsManagerOracleAsmSecretId()
CfnDataProvider.OracleSettingsProperty.Builder	secretsManagerSecurityDbEncryptionAccessRoleArn(String secretsManagerSecurityDbEncryptionAccessRoleArn)	Sets the value of CfnDataProvider.OracleSettingsProperty.getSecretsManagerSecurityDbEncryptionAccessRoleArn()
CfnDataProvider.OracleSettingsProperty.Builder	secretsManagerSecurityDbEncryptionSecretId(String secretsManagerSecurityDbEncryptionSecretId)	Sets the value of CfnDataProvider.OracleSettingsProperty.getSecretsManagerSecurityDbEncryptionSecretId()
CfnDataProvider.OracleSettingsProperty.Builder	serverName(String serverName)	Sets the value of CfnDataProvider.OracleSettingsProperty.getServerName()
CfnDataProvider.OracleSettingsProperty.Builder	sslMode(String sslMode)	Sets the value of CfnDataProvider.OracleSettingsProperty.getSslMode()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

databaseName

@Stability(Stable)
public CfnDataProvider.OracleSettingsProperty.Builder databaseName(String databaseName)

Sets the value of CfnDataProvider.OracleSettingsProperty.getDatabaseName()

Parameters:

databaseName - Database name for the endpoint. This parameter is required.

Returns:

this

port

@Stability(Stable)
public CfnDataProvider.OracleSettingsProperty.Builder port(Number port)

Sets the value of CfnDataProvider.OracleSettingsProperty.getPort()

Parameters:

port - Endpoint TCP port. This parameter is required.

Returns:

this

serverName

@Stability(Stable)
public CfnDataProvider.OracleSettingsProperty.Builder serverName(String serverName)

Sets the value of CfnDataProvider.OracleSettingsProperty.getServerName()

Parameters:

serverName - Fully qualified domain name of the endpoint. This parameter is required. For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances , in the [Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) .Address field.

Returns:

this

sslMode

@Stability(Stable)
public CfnDataProvider.OracleSettingsProperty.Builder sslMode(String sslMode)

Sets the value of CfnDataProvider.OracleSettingsProperty.getSslMode()

Parameters:

sslMode - the value to be set. This parameter is required.

Returns:

this

asmServer

@Stability(Stable)
public CfnDataProvider.OracleSettingsProperty.Builder asmServer(String asmServer)

Sets the value of CfnDataProvider.OracleSettingsProperty.getAsmServer()

Parameters:

asmServer - For an Oracle source endpoint, your ASM server address. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database .

Returns:

this

certificateArn

@Stability(Stable)
public CfnDataProvider.OracleSettingsProperty.Builder certificateArn(String certificateArn)

Sets the value of CfnDataProvider.OracleSettingsProperty.getCertificateArn()

Parameters:

certificateArn - the value to be set.

Returns:

this

secretsManagerOracleAsmAccessRoleArn

@Stability(Stable)
public CfnDataProvider.OracleSettingsProperty.Builder secretsManagerOracleAsmAccessRoleArn(String secretsManagerOracleAsmAccessRoleArn)

Sets the value of CfnDataProvider.OracleSettingsProperty.getSecretsManagerOracleAsmAccessRoleArn()

Parameters:

secretsManagerOracleAsmAccessRoleArn - Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the SecretsManagerOracleAsmSecret . This SecretsManagerOracleAsmSecret has the secret value that allows access to the Oracle ASM of the endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerOracleAsmSecretId . Or you can specify clear-text values for AsmUser , AsmPassword , and AsmServerName . You can't specify both. For more information on creating this SecretsManagerOracleAsmSecret and the SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .

Returns:

this

secretsManagerOracleAsmSecretId

@Stability(Stable)
public CfnDataProvider.OracleSettingsProperty.Builder secretsManagerOracleAsmSecretId(String secretsManagerOracleAsmSecretId)

Sets the value of CfnDataProvider.OracleSettingsProperty.getSecretsManagerOracleAsmSecretId()

Parameters:

secretsManagerOracleAsmSecretId - Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.

Returns:

this

secretsManagerSecurityDbEncryptionAccessRoleArn

@Stability(Stable)
public CfnDataProvider.OracleSettingsProperty.Builder secretsManagerSecurityDbEncryptionAccessRoleArn(String secretsManagerSecurityDbEncryptionAccessRoleArn)

Sets the value of CfnDataProvider.OracleSettingsProperty.getSecretsManagerSecurityDbEncryptionAccessRoleArn()

Parameters:

secretsManagerSecurityDbEncryptionAccessRoleArn - the value to be set.

Returns:

this

secretsManagerSecurityDbEncryptionSecretId

@Stability(Stable)
public CfnDataProvider.OracleSettingsProperty.Builder secretsManagerSecurityDbEncryptionSecretId(String secretsManagerSecurityDbEncryptionSecretId)

Sets the value of CfnDataProvider.OracleSettingsProperty.getSecretsManagerSecurityDbEncryptionSecretId()

Parameters:

secretsManagerSecurityDbEncryptionSecretId - the value to be set.

Returns:

this

build

@Stability(Stable)
public CfnDataProvider.OracleSettingsProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDataProvider.OracleSettingsProperty>

Returns:

a new instance of CfnDataProvider.OracleSettingsProperty

Throws:

NullPointerException - if any required attribute was not provided