Package com.pulumi.aws.dms
Class DataProvider
- java.lang.Object
-
- com.pulumi.resources.Resource
-
- com.pulumi.resources.CustomResource
-
- com.pulumi.aws.dms.DataProvider
-
public class DataProvider extends com.pulumi.resources.CustomResourceManages an AWS DMS (Database Migration) Data Provider. A data provider stores the database engine and connection settings for a database used in a migration project. Creating a data provider does not create a database. ## Example Usage ### Basic Usage
### MySQL Data Providerpackage generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.dms.DataProvider; import com.pulumi.aws.dms.DataProviderArgs; import com.pulumi.aws.dms.inputs.DataProviderSettingsArgs; import com.pulumi.aws.dms.inputs.DataProviderSettingsPostgresqlSettingsArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new DataProvider("example", DataProviderArgs.builder() .settings(DataProviderSettingsArgs.builder() .postgresqlSettings(DataProviderSettingsPostgresqlSettingsArgs.builder() .serverName("example.com") .port(5432) .databaseName("example") .sslMode("none") .build()) .build()) .engine("postgres") .build()); } }
## Import ### Identity Schema #### Required * `arn` (String) ARN of the data provider. Using `pulumi import`, import a DMS data provider using its full ARN. For example: ```sh $ pulumi import aws:dms/dataProvider:DataProvider example arn:aws:dms:us-east-1:123456789012:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS ```package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.dms.DataProvider; import com.pulumi.aws.dms.DataProviderArgs; import com.pulumi.aws.dms.inputs.DataProviderSettingsArgs; import com.pulumi.aws.dms.inputs.DataProviderSettingsMysqlSettingsArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new DataProvider("example", DataProviderArgs.builder() .settings(DataProviderSettingsArgs.builder() .mysqlSettings(DataProviderSettingsMysqlSettingsArgs.builder() .serverName("mysql.example.com") .port(3306) .sslMode("require") .build()) .build()) .name("example-mysql") .description("Example MySQL data provider") .engine("mysql") .tags(Map.of("Environment", "example")) .build()); } }
-
-
Constructor Summary
Constructors Constructor Description DataProvider(java.lang.String name)DataProvider(java.lang.String name, DataProviderArgs args)DataProvider(java.lang.String name, DataProviderArgs args, com.pulumi.resources.CustomResourceOptions options)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.pulumi.core.Output<java.lang.String>arn()com.pulumi.core.Output<java.lang.String>creationTime()com.pulumi.core.Output<java.util.Optional<java.lang.String>>description()com.pulumi.core.Output<java.lang.String>engine()static DataProviderget(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DataProviderState state, com.pulumi.resources.CustomResourceOptions options)Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.com.pulumi.core.Output<java.lang.String>name()com.pulumi.core.Output<java.lang.String>region()com.pulumi.core.Output<DataProviderSettings>settings()com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>tags()com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>tagsAll()com.pulumi.core.Output<java.lang.Boolean>virtual()
-
-
-
Constructor Detail
-
DataProvider
public DataProvider(java.lang.String name)
- Parameters:
name- The _unique_ name of the resulting resource.
-
DataProvider
public DataProvider(java.lang.String name, DataProviderArgs args)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.
-
DataProvider
public DataProvider(java.lang.String name, DataProviderArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.options- A bag of options that control this resource's behavior.
-
-
Method Detail
-
arn
public com.pulumi.core.Output<java.lang.String> arn()
- Returns:
- ARN of the data provider.
-
creationTime
public com.pulumi.core.Output<java.lang.String> creationTime()
- Returns:
- Creation time of the data provider in RFC3339 format.
-
description
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
- Returns:
- Description of the data provider.
-
engine
public com.pulumi.core.Output<java.lang.String> engine()
- Returns:
- Database engine for the data provider. Valid values: `aurora`, `aurora-postgresql`, `db2`, `db2-zos`, `docdb`, `mariadb`, `mongodb`, `mysql`, `oracle`, `postgres`, `redshift`, `sqlserver`, and `sybase`. Use `aurora` for Amazon Aurora MySQL-Compatible Edition.
-
name
public com.pulumi.core.Output<java.lang.String> name()
- Returns:
- Name of the data provider. AWS generates a name when omitted.
-
region
public com.pulumi.core.Output<java.lang.String> region()
- Returns:
- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
-
settings
public com.pulumi.core.Output<DataProviderSettings> settings()
- Returns:
- Database connection settings. Configure exactly one block matching `engine`. See `settings` Block below. The following arguments are optional:
-
tags
public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> tags()
- Returns:
- Map of tags assigned to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
-
tagsAll
public com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tagsAll()
- Returns:
- Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
-
virtual
public com.pulumi.core.Output<java.lang.Boolean> virtual()
- Returns:
- Whether to create a virtual data provider, which does not require a connection to a database. Defaults to `false`.
-
get
public static DataProvider get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, @Nullable DataProviderState state, @Nullable com.pulumi.resources.CustomResourceOptions options)
Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.- Parameters:
name- The _unique_ name of the resulting resource.id- The _unique_ provider ID of the resource to lookup.state-options- Optional settings to control the behavior of the CustomResource.
-
-