@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
211 lines • 8.26 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.ExportTask = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Resource for managing an AWS RDS (Relational Database) Export Task.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.rds.ExportTask("example", {
* exportTaskIdentifier: "example",
* sourceArn: exampleAwsDbSnapshot.dbSnapshotArn,
* s3BucketName: exampleAwsS3Bucket.id,
* iamRoleArn: exampleAwsIamRole.arn,
* kmsKeyId: exampleAwsKmsKey.arn,
* });
* ```
*
* ### Complete Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const exampleBucket = new aws.s3.Bucket("example", {
* bucket: "example",
* forceDestroy: true,
* });
* const exampleBucketAcl = new aws.s3.BucketAcl("example", {
* bucket: exampleBucket.id,
* acl: "private",
* });
* const exampleRole = new aws.iam.Role("example", {
* name: "example",
* assumeRolePolicy: JSON.stringify({
* Version: "2012-10-17",
* Statement: [{
* Action: "sts:AssumeRole",
* Effect: "Allow",
* Sid: "",
* Principal: {
* Service: "export.rds.amazonaws.com",
* },
* }],
* }),
* });
* const example = aws.iam.getPolicyDocumentOutput({
* statements: [
* {
* actions: ["s3:ListAllMyBuckets"],
* resources: ["*"],
* },
* {
* actions: [
* "s3:GetBucketLocation",
* "s3:ListBucket",
* ],
* resources: [exampleBucket.arn],
* },
* {
* actions: [
* "s3:GetObject",
* "s3:PutObject",
* "s3:DeleteObject",
* ],
* resources: [pulumi.interpolate`${exampleBucket.arn}/*`],
* },
* ],
* });
* const examplePolicy = new aws.iam.Policy("example", {
* name: "example",
* policy: example.apply(example => example.json),
* });
* const exampleRolePolicyAttachment = new aws.iam.RolePolicyAttachment("example", {
* role: exampleRole.name,
* policyArn: examplePolicy.arn,
* });
* const exampleKey = new aws.kms.Key("example", {deletionWindowInDays: 10});
* const exampleInstance = new aws.rds.Instance("example", {
* identifier: "example",
* allocatedStorage: 10,
* dbName: "test",
* engine: "mysql",
* engineVersion: "5.7",
* instanceClass: aws.rds.InstanceType.T3_Micro,
* username: "foo",
* password: "foobarbaz",
* parameterGroupName: "default.mysql5.7",
* skipFinalSnapshot: true,
* });
* const exampleSnapshot = new aws.rds.Snapshot("example", {
* dbInstanceIdentifier: exampleInstance.identifier,
* dbSnapshotIdentifier: "example",
* });
* const exampleExportTask = new aws.rds.ExportTask("example", {
* exportTaskIdentifier: "example",
* sourceArn: exampleSnapshot.dbSnapshotArn,
* s3BucketName: exampleBucket.id,
* iamRoleArn: exampleRole.arn,
* kmsKeyId: exampleKey.arn,
* exportOnlies: ["database"],
* s3Prefix: "my_prefix/example",
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import a RDS (Relational Database) Export Task using the `export_task_identifier`. For example:
*
* ```sh
* $ pulumi import aws:rds/exportTask:ExportTask example example
* ```
*/
class ExportTask extends pulumi.CustomResource {
/**
* Get an existing ExportTask 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, id, state, opts) {
return new ExportTask(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of ExportTask. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === ExportTask.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["exportOnlies"] = state?.exportOnlies;
resourceInputs["exportTaskIdentifier"] = state?.exportTaskIdentifier;
resourceInputs["failureCause"] = state?.failureCause;
resourceInputs["iamRoleArn"] = state?.iamRoleArn;
resourceInputs["kmsKeyId"] = state?.kmsKeyId;
resourceInputs["percentProgress"] = state?.percentProgress;
resourceInputs["region"] = state?.region;
resourceInputs["s3BucketName"] = state?.s3BucketName;
resourceInputs["s3Prefix"] = state?.s3Prefix;
resourceInputs["snapshotTime"] = state?.snapshotTime;
resourceInputs["sourceArn"] = state?.sourceArn;
resourceInputs["sourceType"] = state?.sourceType;
resourceInputs["status"] = state?.status;
resourceInputs["taskEndTime"] = state?.taskEndTime;
resourceInputs["taskStartTime"] = state?.taskStartTime;
resourceInputs["timeouts"] = state?.timeouts;
resourceInputs["warningMessage"] = state?.warningMessage;
}
else {
const args = argsOrState;
if (args?.exportTaskIdentifier === undefined && !opts.urn) {
throw new Error("Missing required property 'exportTaskIdentifier'");
}
if (args?.iamRoleArn === undefined && !opts.urn) {
throw new Error("Missing required property 'iamRoleArn'");
}
if (args?.kmsKeyId === undefined && !opts.urn) {
throw new Error("Missing required property 'kmsKeyId'");
}
if (args?.s3BucketName === undefined && !opts.urn) {
throw new Error("Missing required property 's3BucketName'");
}
if (args?.sourceArn === undefined && !opts.urn) {
throw new Error("Missing required property 'sourceArn'");
}
resourceInputs["exportOnlies"] = args?.exportOnlies;
resourceInputs["exportTaskIdentifier"] = args?.exportTaskIdentifier;
resourceInputs["iamRoleArn"] = args?.iamRoleArn;
resourceInputs["kmsKeyId"] = args?.kmsKeyId;
resourceInputs["region"] = args?.region;
resourceInputs["s3BucketName"] = args?.s3BucketName;
resourceInputs["s3Prefix"] = args?.s3Prefix;
resourceInputs["sourceArn"] = args?.sourceArn;
resourceInputs["timeouts"] = args?.timeouts;
resourceInputs["failureCause"] = undefined /*out*/;
resourceInputs["percentProgress"] = undefined /*out*/;
resourceInputs["snapshotTime"] = undefined /*out*/;
resourceInputs["sourceType"] = undefined /*out*/;
resourceInputs["status"] = undefined /*out*/;
resourceInputs["taskEndTime"] = undefined /*out*/;
resourceInputs["taskStartTime"] = undefined /*out*/;
resourceInputs["warningMessage"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(ExportTask.__pulumiType, name, resourceInputs, opts);
}
}
exports.ExportTask = ExportTask;
/** @internal */
ExportTask.__pulumiType = 'aws:rds/exportTask:ExportTask';
//# sourceMappingURL=exportTask.js.map