Class CfnDataProvider

Provides information that defines a data provider.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDataProvider

Implements

IInspectable

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.DMS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDataProvider : CfnResource, IInspectable, ITaggableV2

Syntax (vb)

Public Class CfnDataProvider Inherits CfnResource Implements IInspectable, ITaggableV2

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html

CloudformationResource: AWS::DMS::DataProvider

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.DMS;

             var cfnDataProvider = new CfnDataProvider(this, "MyCfnDataProvider", new CfnDataProviderProps {
                 Engine = "engine",

                 // the properties below are optional
                 DataProviderIdentifier = "dataProviderIdentifier",
                 DataProviderName = "dataProviderName",
                 Description = "description",
                 ExactSettings = false,
                 Settings = new SettingsProperty {
                     DocDbSettings = new DocDbSettingsProperty {
                         DatabaseName = "databaseName",
                         Port = 123,
                         ServerName = "serverName",

                         // the properties below are optional
                         CertificateArn = "certificateArn",
                         SslMode = "sslMode"
                     },
                     IbmDb2LuwSettings = new IbmDb2LuwSettingsProperty {
                         DatabaseName = "databaseName",
                         Port = 123,
                         ServerName = "serverName",
                         SslMode = "sslMode",

                         // the properties below are optional
                         CertificateArn = "certificateArn"
                     },
                     IbmDb2ZOsSettings = new IbmDb2zOsSettingsProperty {
                         DatabaseName = "databaseName",
                         Port = 123,
                         ServerName = "serverName",
                         SslMode = "sslMode",

                         // the properties below are optional
                         CertificateArn = "certificateArn"
                     },
                     MariaDbSettings = new MariaDbSettingsProperty {
                         Port = 123,
                         ServerName = "serverName",
                         SslMode = "sslMode",

                         // the properties below are optional
                         CertificateArn = "certificateArn"
                     },
                     MicrosoftSqlServerSettings = new MicrosoftSqlServerSettingsProperty {
                         DatabaseName = "databaseName",
                         Port = 123,
                         ServerName = "serverName",
                         SslMode = "sslMode",

                         // the properties below are optional
                         CertificateArn = "certificateArn"
                     },
                     MongoDbSettings = new MongoDbSettingsProperty {
                         Port = 123,
                         ServerName = "serverName",

                         // the properties below are optional
                         AuthMechanism = "authMechanism",
                         AuthSource = "authSource",
                         AuthType = "authType",
                         CertificateArn = "certificateArn",
                         DatabaseName = "databaseName",
                         SslMode = "sslMode"
                     },
                     MySqlSettings = new MySqlSettingsProperty {
                         Port = 123,
                         ServerName = "serverName",
                         SslMode = "sslMode",

                         // the properties below are optional
                         CertificateArn = "certificateArn"
                     },
                     OracleSettings = new OracleSettingsProperty {
                         DatabaseName = "databaseName",
                         Port = 123,
                         ServerName = "serverName",
                         SslMode = "sslMode",

                         // the properties below are optional
                         AsmServer = "asmServer",
                         CertificateArn = "certificateArn",
                         SecretsManagerOracleAsmAccessRoleArn = "secretsManagerOracleAsmAccessRoleArn",
                         SecretsManagerOracleAsmSecretId = "secretsManagerOracleAsmSecretId",
                         SecretsManagerSecurityDbEncryptionAccessRoleArn = "secretsManagerSecurityDbEncryptionAccessRoleArn",
                         SecretsManagerSecurityDbEncryptionSecretId = "secretsManagerSecurityDbEncryptionSecretId"
                     },
                     PostgreSqlSettings = new PostgreSqlSettingsProperty {
                         DatabaseName = "databaseName",
                         Port = 123,
                         ServerName = "serverName",
                         SslMode = "sslMode",

                         // the properties below are optional
                         CertificateArn = "certificateArn"
                     },
                     RedshiftSettings = new RedshiftSettingsProperty {
                         DatabaseName = "databaseName",
                         Port = 123,
                         ServerName = "serverName"
                     }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnDataProvider(Construct, string, ICfnDataProviderProps)

Provides information that defines a data provider.

Properties

AttrDataProviderArn	The Amazon Resource Name (ARN) string that uniquely identifies the data provider.
AttrDataProviderCreationTime	The time the data provider was created.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Provides information that defines a data provider.
DataProviderIdentifier	The identifier of the data provider.
DataProviderName	The name of the data provider.
Description	A description of the data provider.
Engine	The type of database engine for the data provider.
ExactSettings	The property describes the exact settings which can be modified.
Settings	The settings in JSON format for a data provider.
Tags	An array of key-value pairs to apply to this resource.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Provides information that defines a data provider.

Constructors

CfnDataProvider(Construct, string, ICfnDataProviderProps)

Provides information that defines a data provider.

public CfnDataProvider(Construct scope, string id, ICfnDataProviderProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnDataProviderProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html

CloudformationResource: AWS::DMS::DataProvider

ExampleMetadata: fixture=_generated

Properties

AttrDataProviderArn

The Amazon Resource Name (ARN) string that uniquely identifies the data provider.

public virtual string AttrDataProviderArn { get; }

Property Value

string

Remarks

CloudformationAttribute: DataProviderArn

AttrDataProviderCreationTime

The time the data provider was created.

public virtual string AttrDataProviderCreationTime { get; }

Property Value

string

Remarks

CloudformationAttribute: DataProviderCreationTime

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html

CloudformationResource: AWS::DMS::DataProvider

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html

CloudformationResource: AWS::DMS::DataProvider

ExampleMetadata: fixture=_generated

CfnProperties

Provides information that defines a data provider.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html

CloudformationResource: AWS::DMS::DataProvider

ExampleMetadata: fixture=_generated

DataProviderIdentifier

The identifier of the data provider.

public virtual string? DataProviderIdentifier { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html

CloudformationResource: AWS::DMS::DataProvider

ExampleMetadata: fixture=_generated

DataProviderName

The name of the data provider.

public virtual string? DataProviderName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html

CloudformationResource: AWS::DMS::DataProvider

ExampleMetadata: fixture=_generated

Description

A description of the data provider.

public virtual string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html

CloudformationResource: AWS::DMS::DataProvider

ExampleMetadata: fixture=_generated

Engine

The type of database engine for the data provider.

public virtual string Engine { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html

CloudformationResource: AWS::DMS::DataProvider

ExampleMetadata: fixture=_generated

ExactSettings

The property describes the exact settings which can be modified.

public virtual object? ExactSettings { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html

CloudformationResource: AWS::DMS::DataProvider

ExampleMetadata: fixture=_generated

Settings

The settings in JSON format for a data provider.

public virtual object? Settings { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html

CloudformationResource: AWS::DMS::DataProvider

ExampleMetadata: fixture=_generated

Tags

An array of key-value pairs to apply to this resource.

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html

CloudformationResource: AWS::DMS::DataProvider

ExampleMetadata: fixture=_generated

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.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html

CloudformationResource: AWS::DMS::DataProvider

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Provides information that defines a data provider.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html

CloudformationResource: AWS::DMS::DataProvider

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggableV2