@pulumi/gcp

import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * GoldengateConnection is a resource that represents metadata to establish a connection to a source or target data. * * ## Example Usage * * ### Oracledatabase Goldengate Connection Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const connection = new gcp.oracledatabase.GoldengateConnection("connection", { * goldengateConnectionId: "my-connection", * location: "asia-south1", * project: "my-project", * gcpOracleZone: "asia-south1-b-r1", * properties: { * displayName: "my-connection display name", * connectionType: "ORACLE", * oracleConnectionProperties: { * technologyType: "ORACLE_AUTONOMOUS_DATABASE_AT_GOOGLE_CLOUD", * connectionString: "jdbc:oracle:thin:@//10.0.0.5:1521/ORCL", * username: "admin", * password: "GenerateWallet@123", * }, * }, * deletionProtection: true, * }); * ``` * ### Oracledatabase Goldengate Connection Full * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const connection = new gcp.oracledatabase.GoldengateConnection("connection", { * goldengateConnectionId: "my-connection", * location: "us-east4", * project: "my-project", * odbNetwork: "projects/my-project/locations/us-east4/odbNetworks/my-network", * odbSubnet: "projects/my-project/locations/us-east4/odbNetworks/my-network/odbSubnets/my-subnet", * gcpOracleZone: "us-east4-b-r1", * labels: { * "label-one": "value-one", * }, * properties: { * displayName: "my-connection display name", * connectionType: "ORACLE", * routingMethod: "DEDICATED_ENDPOINT", * oracleConnectionProperties: { * technologyType: "ORACLE_AUTONOMOUS_DATABASE_AT_GOOGLE_CLOUD", * username: "admin", * password: "GenerateWallet@123", * sessionMode: "DIRECT", * gcpOracleDatabaseId: "projects/my-project/locations/us-east4/autonomousDatabases/my-autonomous-database", * }, * }, * deletionProtection: true, * }); * ``` * ### Oracledatabase Goldengate Connection Mysql * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const connection = new gcp.oracledatabase.GoldengateConnection("connection", { * goldengateConnectionId: "my-connection", * location: "northamerica-northeast1", * project: "my-project", * gcpOracleZone: "northamerica-northeast1-a-r1", * properties: { * displayName: "my-connection display name", * connectionType: "MYSQL", * mysqlConnectionProperties: { * technologyType: "MYSQL_SERVER", * username: "mysql_user", * password: "mysql_password", * host: "mysql.example.com", * port: 3306, * database: "mydb", * securityProtocol: "MTLS", * sslMode: "PREFERRED", * sslCertFile: "YmFzZTY0LWNsaWVudC1jZXJ0LWZpbGUtY29udGVudC1kZW1vLWdnb25u", * sslKeyFile: "YmFzZTY0LWNsaWVudC1rZXktZmlsZS1jb250ZW50LWRlbW8tZ2dvbm4=", * additionalAttributes: [{ * key: "attr1", * value: "value1", * }], * }, * }, * deletionProtection: true, * }); * ``` * ### Oracledatabase Goldengate Connection Postgresql * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const connection = new gcp.oracledatabase.GoldengateConnection("connection", { * goldengateConnectionId: "my-connection", * location: "southamerica-east1", * project: "my-project", * gcpOracleZone: "southamerica-east1-a-r1", * properties: { * displayName: "my-connection display name", * connectionType: "POSTGRESQL", * postgresqlConnectionProperties: { * technologyType: "POSTGRESQL_SERVER", * database: "postgres_app_db", * host: "postgres.corp.example.com", * port: 5432, * username: "pg_replicator", * password: "PostgresReplicationP@ssw0rd!", * securityProtocol: "PLAIN", * }, * }, * deletionProtection: true, * }); * ``` * ### Oracledatabase Goldengate Connection Redis * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const connection = new gcp.oracledatabase.GoldengateConnection("connection", { * goldengateConnectionId: "my-connection", * location: "asia-northeast2", * project: "my-project", * gcpOracleZone: "asia-northeast2-a-r1", * properties: { * displayName: "my-connection display name", * connectionType: "REDIS", * redisConnectionProperties: { * technologyType: "REDIS", * servers: "redis-shard1.example.com:6379,redis-shard2.example.com:6379", * securityProtocol: "PLAIN", * authenticationType: "BASIC", * username: "redis_agent", * password: "RedisSecureCacheP@ssword123!", * }, * }, * deletionProtection: true, * }); * ``` * ### Oracledatabase Goldengate Connection Kafka * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const connection = new gcp.oracledatabase.GoldengateConnection("connection", { * goldengateConnectionId: "my-connection", * location: "europe-west8", * project: "my-project", * gcpOracleZone: "europe-west8-a-r1", * properties: { * displayName: "my-connection display name", * connectionType: "KAFKA", * kafkaConnectionProperties: { * technologyType: "APACHE_KAFKA", * streamPoolId: "ocid1.streampool.oc1..example", * clusterId: "ocid1.kafkacluster.oc1..example", * bootstrapServers: [{ * host: "kafka.example.com", * port: 9092, * privateIpAddress: "10.0.0.1", * }], * securityProtocol: "SSL", * consumerPropertiesFile: "Y29uc3VtZXIucHJvcGVydGllcz1kZW1v", * producerPropertiesFile: "cHJvZHVjZXIucHJvcGVydGllcz1kZW1v", * useResourcePrincipal: false, * }, * }, * deletionProtection: true, * }); * ``` * ### Oracledatabase Goldengate Connection Iceberg * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const connection = new gcp.oracledatabase.GoldengateConnection("connection", { * goldengateConnectionId: "my-connection", * location: "australia-southeast1", * project: "my-project", * gcpOracleZone: "australia-southeast1-b-r1", * properties: { * displayName: "my-connection display name", * connectionType: "ICEBERG", * icebergConnectionProperties: { * technologyType: "APACHE_ICEBERG", * catalog: { * catalogType: "GLUE", * glueIcebergCatalog: { * glueId: "glue_catalog_id", * }, * }, * storage: { * storageType: "AMAZON_S3", * amazonS3IcebergStorage: { * schemeType: "S3", * accessKeyId: "AKIAIOSFODNN7EXAMPLE", * secretAccessKeySecret: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", * region: "us-east-1", * bucket: "iceberg-bucket", * endpoint: "https://s3.amazonaws.com", * }, * }, * }, * }, * deletionProtection: true, * }); * ``` * ### Oracledatabase Goldengate Connection Snowflake * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const connection = new gcp.oracledatabase.GoldengateConnection("connection", { * goldengateConnectionId: "my-connection", * location: "europe-west3", * project: "my-project", * gcpOracleZone: "europe-west3-b-r1", * properties: { * displayName: "my-connection display name", * connectionType: "SNOWFLAKE", * snowflakeConnectionProperties: { * technologyType: "SNOWFLAKE", * connectionUrl: "jdbc:snowflake://xy12345.snowflakecomputing.com/?warehouse=COMPUTE_WH&db=ANALYTICS_DB", * authenticationType: "BASIC", * username: "snowflake_sync_user", * password: "SnowflakeBasicP@ssword123!", * }, * }, * deletionProtection: true, * }); * ``` * ### Oracledatabase Goldengate Connection Jms * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const connection = new gcp.oracledatabase.GoldengateConnection("connection", { * goldengateConnectionId: "my-connection", * location: "asia-northeast1", * project: "my-project", * gcpOracleZone: "asia-northeast1-a-r1", * properties: { * displayName: "my-connection display name", * connectionType: "JAVA_MESSAGE_SERVICE", * javaMessageServiceConnectionProperties: { * technologyType: "ORACLE_WEBLOGIC_JMS", * useJndi: true, * jndiConnectionFactory: "ConnectionFactory", * jndiProviderUrl: "tcp://jms.example.com:61616?jms.prefetchPolicy.all=1000", * jndiInitialContextFactory: "org.apache.activemq.jndi.ActiveMQInitialContextFactory", * jndiSecurityPrincipal: "jms_user", * jndiSecurityCredentialsSecret: "jms_credentials", * username: "jms_user", * password: "jms_password", * securityProtocol: "MTLS", * authenticationType: "BASIC", * trustStoreFile: "YmFzZTY0LXRydXN0c3RvcmUtZmlsZS1jb250ZW50LWRlbW8tZ2dvbm4=", * trustStorePassword: "truststore_pass", * keyStoreFile: "YmFzZTY0LWtleXN0b3JlLWZpbGUtY29udGVudC1kZW1vLWdnb25u", * keyStorePassword: "keystore_pass", * sslKeyPassword: "ssl_key_pass", * }, * }, * deletionProtection: true, * }); * ``` * * ## Import * * GoldengateConnection can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/goldengateConnections/{{goldengate_connection_id}}` * * `{{project}}/{{location}}/{{goldengate_connection_id}}` * * `{{location}}/{{goldengate_connection_id}}` * * When using the `pulumi import` command, GoldengateConnection can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:oracledatabase/goldengateConnection:GoldengateConnection default projects/{{project}}/locations/{{location}}/goldengateConnections/{{goldengate_connection_id}} * $ pulumi import gcp:oracledatabase/goldengateConnection:GoldengateConnection default {{project}}/{{location}}/{{goldengate_connection_id}} * $ pulumi import gcp:oracledatabase/goldengateConnection:GoldengateConnection default {{location}}/{{goldengate_connection_id}} * ``` */ export declare class GoldengateConnection extends pulumi.CustomResource { /** * Get an existing GoldengateConnection resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GoldengateConnectionState, opts?: pulumi.CustomResourceOptions): GoldengateConnection; /** * Returns true if the given object is an instance of GoldengateConnection. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is GoldengateConnection; /** * The date and time that the GoldengateConnection was created. */ readonly createTime: pulumi.Output<string>; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ readonly deletionPolicy: pulumi.Output<string>; /** * Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a terraform destroy or pulumi up that would delete the instance will fail. */ readonly deletionProtection: pulumi.Output<boolean | undefined>; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ readonly effectiveLabels: pulumi.Output<{ [key: string]: string; }>; /** * The ID of the subscription entitlement associated with the * GoldengateConnection. */ readonly entitlementId: pulumi.Output<string>; /** * The GCP Oracle zone where Oracle GoldengateConnection is hosted. * Example: us-east4-b-r2. * If not specified, the system will pick a zone based on availability. */ readonly gcpOracleZone: pulumi.Output<string>; /** * The ID of the GoldengateConnection to create. This value is * restricted to (^a-z?$) and must be a maximum of * 63 characters in length. The value must start with a letter and end with a * letter or a number. */ readonly goldengateConnectionId: pulumi.Output<string>; /** * The labels or tags associated with the GoldengateConnection. * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ readonly labels: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ readonly location: pulumi.Output<string>; /** * Identifier. The name of the GoldengateConnection resource in the following format: * projects/{project}/locations/{region}/goldengateConnections/{goldengate_connection} */ readonly name: pulumi.Output<string>; /** * HTTPS link to OCI resources exposed to Customer via UI Interface. */ readonly ociUrl: pulumi.Output<string>; /** * The name of the OdbNetwork associated with the GoldengateConnection. * The format is * projects/{project}/locations/{location}/odbNetworks/{odb_network}. * It is optional but if specified, this should match the parent ODBNetwork * of the OdbSubnet. */ readonly odbNetwork: pulumi.Output<string | undefined>; /** * The name of the OdbSubnet associated with the GoldengateConnection for IP * allocation. * Format: * projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} */ readonly odbSubnet: pulumi.Output<string | undefined>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output<string>; /** * The properties of a GoldengateConnection. * Structure is documented below. */ readonly properties: pulumi.Output<outputs.oracledatabase.GoldengateConnectionProperties>; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ readonly pulumiLabels: pulumi.Output<{ [key: string]: string; }>; /** * Create a GoldengateConnection resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: GoldengateConnectionArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering GoldengateConnection resources. */ export interface GoldengateConnectionState { /** * The date and time that the GoldengateConnection was created. */ createTime?: pulumi.Input<string | undefined>; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ deletionPolicy?: pulumi.Input<string | undefined>; /** * Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a terraform destroy or pulumi up that would delete the instance will fail. */ deletionProtection?: pulumi.Input<boolean | undefined>; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ effectiveLabels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; /** * The ID of the subscription entitlement associated with the * GoldengateConnection. */ entitlementId?: pulumi.Input<string | undefined>; /** * The GCP Oracle zone where Oracle GoldengateConnection is hosted. * Example: us-east4-b-r2. * If not specified, the system will pick a zone based on availability. */ gcpOracleZone?: pulumi.Input<string | undefined>; /** * The ID of the GoldengateConnection to create. This value is * restricted to (^a-z?$) and must be a maximum of * 63 characters in length. The value must start with a letter and end with a * letter or a number. */ goldengateConnectionId?: pulumi.Input<string | undefined>; /** * The labels or tags associated with the GoldengateConnection. * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ location?: pulumi.Input<string | undefined>; /** * Identifier. The name of the GoldengateConnection resource in the following format: * projects/{project}/locations/{region}/goldengateConnections/{goldengate_connection} */ name?: pulumi.Input<string | undefined>; /** * HTTPS link to OCI resources exposed to Customer via UI Interface. */ ociUrl?: pulumi.Input<string | undefined>; /** * The name of the OdbNetwork associated with the GoldengateConnection. * The format is * projects/{project}/locations/{location}/odbNetworks/{odb_network}. * It is optional but if specified, this should match the parent ODBNetwork * of the OdbSubnet. */ odbNetwork?: pulumi.Input<string | undefined>; /** * The name of the OdbSubnet associated with the GoldengateConnection for IP * allocation. * Format: * projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} */ odbSubnet?: pulumi.Input<string | undefined>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input<string | undefined>; /** * The properties of a GoldengateConnection. * Structure is documented below. */ properties?: pulumi.Input<inputs.oracledatabase.GoldengateConnectionProperties | undefined>; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; } /** * The set of arguments for constructing a GoldengateConnection resource. */ export interface GoldengateConnectionArgs { /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ deletionPolicy?: pulumi.Input<string | undefined>; /** * Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a terraform destroy or pulumi up that would delete the instance will fail. */ deletionProtection?: pulumi.Input<boolean | undefined>; /** * The GCP Oracle zone where Oracle GoldengateConnection is hosted. * Example: us-east4-b-r2. * If not specified, the system will pick a zone based on availability. */ gcpOracleZone?: pulumi.Input<string | undefined>; /** * The ID of the GoldengateConnection to create. This value is * restricted to (^a-z?$) and must be a maximum of * 63 characters in length. The value must start with a letter and end with a * letter or a number. */ goldengateConnectionId: pulumi.Input<string>; /** * The labels or tags associated with the GoldengateConnection. * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ location: pulumi.Input<string>; /** * The name of the OdbNetwork associated with the GoldengateConnection. * The format is * projects/{project}/locations/{location}/odbNetworks/{odb_network}. * It is optional but if specified, this should match the parent ODBNetwork * of the OdbSubnet. */ odbNetwork?: pulumi.Input<string | undefined>; /** * The name of the OdbSubnet associated with the GoldengateConnection for IP * allocation. * Format: * projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} */ odbSubnet?: pulumi.Input<string | undefined>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input<string | undefined>; /** * The properties of a GoldengateConnection. * Structure is documented below. */ properties: pulumi.Input<inputs.oracledatabase.GoldengateConnectionProperties>; } //# sourceMappingURL=goldengateConnection.d.ts.map