aws.rds.ExportTask
Explore with Pulumi AI
Resource for managing an AWS RDS (Relational Database) Export Task.
Example Usage
Basic Usage
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,
});
import pulumi
import pulumi_aws as aws
example = aws.rds.ExportTask("example",
export_task_identifier="example",
source_arn=example_aws_db_snapshot["dbSnapshotArn"],
s3_bucket_name=example_aws_s3_bucket["id"],
iam_role_arn=example_aws_iam_role["arn"],
kms_key_id=example_aws_kms_key["arn"])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rds.NewExportTask(ctx, "example", &rds.ExportTaskArgs{
ExportTaskIdentifier: pulumi.String("example"),
SourceArn: pulumi.Any(exampleAwsDbSnapshot.DbSnapshotArn),
S3BucketName: pulumi.Any(exampleAwsS3Bucket.Id),
IamRoleArn: pulumi.Any(exampleAwsIamRole.Arn),
KmsKeyId: pulumi.Any(exampleAwsKmsKey.Arn),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Rds.ExportTask("example", new()
{
ExportTaskIdentifier = "example",
SourceArn = exampleAwsDbSnapshot.DbSnapshotArn,
S3BucketName = exampleAwsS3Bucket.Id,
IamRoleArn = exampleAwsIamRole.Arn,
KmsKeyId = exampleAwsKmsKey.Arn,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.ExportTask;
import com.pulumi.aws.rds.ExportTaskArgs;
import java.util.List;
import java.util.ArrayList;
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 ExportTask("example", ExportTaskArgs.builder()
.exportTaskIdentifier("example")
.sourceArn(exampleAwsDbSnapshot.dbSnapshotArn())
.s3BucketName(exampleAwsS3Bucket.id())
.iamRoleArn(exampleAwsIamRole.arn())
.kmsKeyId(exampleAwsKmsKey.arn())
.build());
}
}
resources:
example:
type: aws:rds:ExportTask
properties:
exportTaskIdentifier: example
sourceArn: ${exampleAwsDbSnapshot.dbSnapshotArn}
s3BucketName: ${exampleAwsS3Bucket.id}
iamRoleArn: ${exampleAwsIamRole.arn}
kmsKeyId: ${exampleAwsKmsKey.arn}
Complete Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const exampleBucketV2 = new aws.s3.BucketV2("example", {
bucket: "example",
forceDestroy: true,
});
const exampleBucketAclV2 = new aws.s3.BucketAclV2("example", {
bucket: exampleBucketV2.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: [exampleBucketV2.arn],
},
{
actions: [
"s3:GetObject",
"s3:PutObject",
"s3:DeleteObject",
],
resources: [pulumi.interpolate`${exampleBucketV2.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: exampleBucketV2.id,
iamRoleArn: exampleRole.arn,
kmsKeyId: exampleKey.arn,
exportOnlies: ["database"],
s3Prefix: "my_prefix/example",
});
import pulumi
import json
import pulumi_aws as aws
example_bucket_v2 = aws.s3.BucketV2("example",
bucket="example",
force_destroy=True)
example_bucket_acl_v2 = aws.s3.BucketAclV2("example",
bucket=example_bucket_v2.id,
acl="private")
example_role = aws.iam.Role("example",
name="example",
assume_role_policy=json.dumps({
"Version": "2012-10-17",
"Statement": [{
"Action": "sts:AssumeRole",
"Effect": "Allow",
"Sid": "",
"Principal": {
"Service": "export.rds.amazonaws.com",
},
}],
}))
example = aws.iam.get_policy_document_output(statements=[
{
"actions": ["s3:ListAllMyBuckets"],
"resources": ["*"],
},
{
"actions": [
"s3:GetBucketLocation",
"s3:ListBucket",
],
"resources": [example_bucket_v2.arn],
},
{
"actions": [
"s3:GetObject",
"s3:PutObject",
"s3:DeleteObject",
],
"resources": [example_bucket_v2.arn.apply(lambda arn: f"{arn}/*")],
},
])
example_policy = aws.iam.Policy("example",
name="example",
policy=example.json)
example_role_policy_attachment = aws.iam.RolePolicyAttachment("example",
role=example_role.name,
policy_arn=example_policy.arn)
example_key = aws.kms.Key("example", deletion_window_in_days=10)
example_instance = aws.rds.Instance("example",
identifier="example",
allocated_storage=10,
db_name="test",
engine="mysql",
engine_version="5.7",
instance_class=aws.rds.InstanceType.T3_MICRO,
username="foo",
password="foobarbaz",
parameter_group_name="default.mysql5.7",
skip_final_snapshot=True)
example_snapshot = aws.rds.Snapshot("example",
db_instance_identifier=example_instance.identifier,
db_snapshot_identifier="example")
example_export_task = aws.rds.ExportTask("example",
export_task_identifier="example",
source_arn=example_snapshot.db_snapshot_arn,
s3_bucket_name=example_bucket_v2.id,
iam_role_arn=example_role.arn,
kms_key_id=example_key.arn,
export_onlies=["database"],
s3_prefix="my_prefix/example")
package main
import (
"encoding/json"
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kms"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleBucketV2, err := s3.NewBucketV2(ctx, "example", &s3.BucketV2Args{
Bucket: pulumi.String("example"),
ForceDestroy: pulumi.Bool(true),
})
if err != nil {
return err
}
_, err = s3.NewBucketAclV2(ctx, "example", &s3.BucketAclV2Args{
Bucket: exampleBucketV2.ID(),
Acl: pulumi.String("private"),
})
if err != nil {
return err
}
tmpJSON0, err := json.Marshal(map[string]interface{}{
"Version": "2012-10-17",
"Statement": []map[string]interface{}{
map[string]interface{}{
"Action": "sts:AssumeRole",
"Effect": "Allow",
"Sid": "",
"Principal": map[string]interface{}{
"Service": "export.rds.amazonaws.com",
},
},
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
exampleRole, err := iam.NewRole(ctx, "example", &iam.RoleArgs{
Name: pulumi.String("example"),
AssumeRolePolicy: pulumi.String(json0),
})
if err != nil {
return err
}
example := iam.GetPolicyDocumentOutput(ctx, iam.GetPolicyDocumentOutputArgs{
Statements: iam.GetPolicyDocumentStatementArray{
&iam.GetPolicyDocumentStatementArgs{
Actions: pulumi.StringArray{
pulumi.String("s3:ListAllMyBuckets"),
},
Resources: pulumi.StringArray{
pulumi.String("*"),
},
},
&iam.GetPolicyDocumentStatementArgs{
Actions: pulumi.StringArray{
pulumi.String("s3:GetBucketLocation"),
pulumi.String("s3:ListBucket"),
},
Resources: pulumi.StringArray{
exampleBucketV2.Arn,
},
},
&iam.GetPolicyDocumentStatementArgs{
Actions: pulumi.StringArray{
pulumi.String("s3:GetObject"),
pulumi.String("s3:PutObject"),
pulumi.String("s3:DeleteObject"),
},
Resources: pulumi.StringArray{
exampleBucketV2.Arn.ApplyT(func(arn string) (string, error) {
return fmt.Sprintf("%v/*", arn), nil
}).(pulumi.StringOutput),
},
},
},
}, nil)
examplePolicy, err := iam.NewPolicy(ctx, "example", &iam.PolicyArgs{
Name: pulumi.String("example"),
Policy: pulumi.String(example.ApplyT(func(example iam.GetPolicyDocumentResult) (*string, error) {
return &example.Json, nil
}).(pulumi.StringPtrOutput)),
})
if err != nil {
return err
}
_, err = iam.NewRolePolicyAttachment(ctx, "example", &iam.RolePolicyAttachmentArgs{
Role: exampleRole.Name,
PolicyArn: examplePolicy.Arn,
})
if err != nil {
return err
}
exampleKey, err := kms.NewKey(ctx, "example", &kms.KeyArgs{
DeletionWindowInDays: pulumi.Int(10),
})
if err != nil {
return err
}
exampleInstance, err := rds.NewInstance(ctx, "example", &rds.InstanceArgs{
Identifier: pulumi.String("example"),
AllocatedStorage: pulumi.Int(10),
DbName: pulumi.String("test"),
Engine: pulumi.String("mysql"),
EngineVersion: pulumi.String("5.7"),
InstanceClass: pulumi.String(rds.InstanceType_T3_Micro),
Username: pulumi.String("foo"),
Password: pulumi.String("foobarbaz"),
ParameterGroupName: pulumi.String("default.mysql5.7"),
SkipFinalSnapshot: pulumi.Bool(true),
})
if err != nil {
return err
}
exampleSnapshot, err := rds.NewSnapshot(ctx, "example", &rds.SnapshotArgs{
DbInstanceIdentifier: exampleInstance.Identifier,
DbSnapshotIdentifier: pulumi.String("example"),
})
if err != nil {
return err
}
_, err = rds.NewExportTask(ctx, "example", &rds.ExportTaskArgs{
ExportTaskIdentifier: pulumi.String("example"),
SourceArn: exampleSnapshot.DbSnapshotArn,
S3BucketName: exampleBucketV2.ID(),
IamRoleArn: exampleRole.Arn,
KmsKeyId: exampleKey.Arn,
ExportOnlies: pulumi.StringArray{
pulumi.String("database"),
},
S3Prefix: pulumi.String("my_prefix/example"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var exampleBucketV2 = new Aws.S3.BucketV2("example", new()
{
Bucket = "example",
ForceDestroy = true,
});
var exampleBucketAclV2 = new Aws.S3.BucketAclV2("example", new()
{
Bucket = exampleBucketV2.Id,
Acl = "private",
});
var exampleRole = new Aws.Iam.Role("example", new()
{
Name = "example",
AssumeRolePolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["Version"] = "2012-10-17",
["Statement"] = new[]
{
new Dictionary<string, object?>
{
["Action"] = "sts:AssumeRole",
["Effect"] = "Allow",
["Sid"] = "",
["Principal"] = new Dictionary<string, object?>
{
["Service"] = "export.rds.amazonaws.com",
},
},
},
}),
});
var example = Aws.Iam.GetPolicyDocument.Invoke(new()
{
Statements = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
{
Actions = new[]
{
"s3:ListAllMyBuckets",
},
Resources = new[]
{
"*",
},
},
new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
{
Actions = new[]
{
"s3:GetBucketLocation",
"s3:ListBucket",
},
Resources = new[]
{
exampleBucketV2.Arn,
},
},
new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
{
Actions = new[]
{
"s3:GetObject",
"s3:PutObject",
"s3:DeleteObject",
},
Resources = new[]
{
$"{exampleBucketV2.Arn}/*",
},
},
},
});
var examplePolicy = new Aws.Iam.Policy("example", new()
{
Name = "example",
PolicyDocument = example.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
});
var exampleRolePolicyAttachment = new Aws.Iam.RolePolicyAttachment("example", new()
{
Role = exampleRole.Name,
PolicyArn = examplePolicy.Arn,
});
var exampleKey = new Aws.Kms.Key("example", new()
{
DeletionWindowInDays = 10,
});
var exampleInstance = new Aws.Rds.Instance("example", new()
{
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,
});
var exampleSnapshot = new Aws.Rds.Snapshot("example", new()
{
DbInstanceIdentifier = exampleInstance.Identifier,
DbSnapshotIdentifier = "example",
});
var exampleExportTask = new Aws.Rds.ExportTask("example", new()
{
ExportTaskIdentifier = "example",
SourceArn = exampleSnapshot.DbSnapshotArn,
S3BucketName = exampleBucketV2.Id,
IamRoleArn = exampleRole.Arn,
KmsKeyId = exampleKey.Arn,
ExportOnlies = new[]
{
"database",
},
S3Prefix = "my_prefix/example",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.BucketV2;
import com.pulumi.aws.s3.BucketV2Args;
import com.pulumi.aws.s3.BucketAclV2;
import com.pulumi.aws.s3.BucketAclV2Args;
import com.pulumi.aws.iam.Role;
import com.pulumi.aws.iam.RoleArgs;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
import com.pulumi.aws.iam.Policy;
import com.pulumi.aws.iam.PolicyArgs;
import com.pulumi.aws.iam.RolePolicyAttachment;
import com.pulumi.aws.iam.RolePolicyAttachmentArgs;
import com.pulumi.aws.kms.Key;
import com.pulumi.aws.kms.KeyArgs;
import com.pulumi.aws.rds.Instance;
import com.pulumi.aws.rds.InstanceArgs;
import com.pulumi.aws.rds.Snapshot;
import com.pulumi.aws.rds.SnapshotArgs;
import com.pulumi.aws.rds.ExportTask;
import com.pulumi.aws.rds.ExportTaskArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
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 exampleBucketV2 = new BucketV2("exampleBucketV2", BucketV2Args.builder()
.bucket("example")
.forceDestroy(true)
.build());
var exampleBucketAclV2 = new BucketAclV2("exampleBucketAclV2", BucketAclV2Args.builder()
.bucket(exampleBucketV2.id())
.acl("private")
.build());
var exampleRole = new Role("exampleRole", RoleArgs.builder()
.name("example")
.assumeRolePolicy(serializeJson(
jsonObject(
jsonProperty("Version", "2012-10-17"),
jsonProperty("Statement", jsonArray(jsonObject(
jsonProperty("Action", "sts:AssumeRole"),
jsonProperty("Effect", "Allow"),
jsonProperty("Sid", ""),
jsonProperty("Principal", jsonObject(
jsonProperty("Service", "export.rds.amazonaws.com")
))
)))
)))
.build());
final var example = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
.statements(
GetPolicyDocumentStatementArgs.builder()
.actions("s3:ListAllMyBuckets")
.resources("*")
.build(),
GetPolicyDocumentStatementArgs.builder()
.actions(
"s3:GetBucketLocation",
"s3:ListBucket")
.resources(exampleBucketV2.arn())
.build(),
GetPolicyDocumentStatementArgs.builder()
.actions(
"s3:GetObject",
"s3:PutObject",
"s3:DeleteObject")
.resources(exampleBucketV2.arn().applyValue(arn -> String.format("%s/*", arn)))
.build())
.build());
var examplePolicy = new Policy("examplePolicy", PolicyArgs.builder()
.name("example")
.policy(example.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult).applyValue(example -> example.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult.json())))
.build());
var exampleRolePolicyAttachment = new RolePolicyAttachment("exampleRolePolicyAttachment", RolePolicyAttachmentArgs.builder()
.role(exampleRole.name())
.policyArn(examplePolicy.arn())
.build());
var exampleKey = new Key("exampleKey", KeyArgs.builder()
.deletionWindowInDays(10)
.build());
var exampleInstance = new Instance("exampleInstance", InstanceArgs.builder()
.identifier("example")
.allocatedStorage(10)
.dbName("test")
.engine("mysql")
.engineVersion("5.7")
.instanceClass("db.t3.micro")
.username("foo")
.password("foobarbaz")
.parameterGroupName("default.mysql5.7")
.skipFinalSnapshot(true)
.build());
var exampleSnapshot = new Snapshot("exampleSnapshot", SnapshotArgs.builder()
.dbInstanceIdentifier(exampleInstance.identifier())
.dbSnapshotIdentifier("example")
.build());
var exampleExportTask = new ExportTask("exampleExportTask", ExportTaskArgs.builder()
.exportTaskIdentifier("example")
.sourceArn(exampleSnapshot.dbSnapshotArn())
.s3BucketName(exampleBucketV2.id())
.iamRoleArn(exampleRole.arn())
.kmsKeyId(exampleKey.arn())
.exportOnlies("database")
.s3Prefix("my_prefix/example")
.build());
}
}
resources:
exampleBucketV2:
type: aws:s3:BucketV2
name: example
properties:
bucket: example
forceDestroy: true
exampleBucketAclV2:
type: aws:s3:BucketAclV2
name: example
properties:
bucket: ${exampleBucketV2.id}
acl: private
exampleRole:
type: aws:iam:Role
name: example
properties:
name: example
assumeRolePolicy:
fn::toJSON:
Version: 2012-10-17
Statement:
- Action: sts:AssumeRole
Effect: Allow
Sid:
Principal:
Service: export.rds.amazonaws.com
examplePolicy:
type: aws:iam:Policy
name: example
properties:
name: example
policy: ${example.json}
exampleRolePolicyAttachment:
type: aws:iam:RolePolicyAttachment
name: example
properties:
role: ${exampleRole.name}
policyArn: ${examplePolicy.arn}
exampleKey:
type: aws:kms:Key
name: example
properties:
deletionWindowInDays: 10
exampleInstance:
type: aws:rds:Instance
name: example
properties:
identifier: example
allocatedStorage: 10
dbName: test
engine: mysql
engineVersion: '5.7'
instanceClass: db.t3.micro
username: foo
password: foobarbaz
parameterGroupName: default.mysql5.7
skipFinalSnapshot: true
exampleSnapshot:
type: aws:rds:Snapshot
name: example
properties:
dbInstanceIdentifier: ${exampleInstance.identifier}
dbSnapshotIdentifier: example
exampleExportTask:
type: aws:rds:ExportTask
name: example
properties:
exportTaskIdentifier: example
sourceArn: ${exampleSnapshot.dbSnapshotArn}
s3BucketName: ${exampleBucketV2.id}
iamRoleArn: ${exampleRole.arn}
kmsKeyId: ${exampleKey.arn}
exportOnlies:
- database
s3Prefix: my_prefix/example
variables:
example:
fn::invoke:
Function: aws:iam:getPolicyDocument
Arguments:
statements:
- actions:
- s3:ListAllMyBuckets
resources:
- '*'
- actions:
- s3:GetBucketLocation
- s3:ListBucket
resources:
- ${exampleBucketV2.arn}
- actions:
- s3:GetObject
- s3:PutObject
- s3:DeleteObject
resources:
- ${exampleBucketV2.arn}/*
Create ExportTask Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ExportTask(name: string, args: ExportTaskArgs, opts?: CustomResourceOptions);
@overload
def ExportTask(resource_name: str,
args: ExportTaskArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ExportTask(resource_name: str,
opts: Optional[ResourceOptions] = None,
export_task_identifier: Optional[str] = None,
iam_role_arn: Optional[str] = None,
kms_key_id: Optional[str] = None,
s3_bucket_name: Optional[str] = None,
source_arn: Optional[str] = None,
export_onlies: Optional[Sequence[str]] = None,
s3_prefix: Optional[str] = None,
timeouts: Optional[ExportTaskTimeoutsArgs] = None)
func NewExportTask(ctx *Context, name string, args ExportTaskArgs, opts ...ResourceOption) (*ExportTask, error)
public ExportTask(string name, ExportTaskArgs args, CustomResourceOptions? opts = null)
public ExportTask(String name, ExportTaskArgs args)
public ExportTask(String name, ExportTaskArgs args, CustomResourceOptions options)
type: aws:rds:ExportTask
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ExportTaskArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ExportTaskArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ExportTaskArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ExportTaskArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ExportTaskArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var exportTaskResource = new Aws.Rds.ExportTask("exportTaskResource", new()
{
ExportTaskIdentifier = "string",
IamRoleArn = "string",
KmsKeyId = "string",
S3BucketName = "string",
SourceArn = "string",
ExportOnlies = new[]
{
"string",
},
S3Prefix = "string",
Timeouts = new Aws.Rds.Inputs.ExportTaskTimeoutsArgs
{
Create = "string",
Delete = "string",
},
});
example, err := rds.NewExportTask(ctx, "exportTaskResource", &rds.ExportTaskArgs{
ExportTaskIdentifier: pulumi.String("string"),
IamRoleArn: pulumi.String("string"),
KmsKeyId: pulumi.String("string"),
S3BucketName: pulumi.String("string"),
SourceArn: pulumi.String("string"),
ExportOnlies: pulumi.StringArray{
pulumi.String("string"),
},
S3Prefix: pulumi.String("string"),
Timeouts: &rds.ExportTaskTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
},
})
var exportTaskResource = new ExportTask("exportTaskResource", ExportTaskArgs.builder()
.exportTaskIdentifier("string")
.iamRoleArn("string")
.kmsKeyId("string")
.s3BucketName("string")
.sourceArn("string")
.exportOnlies("string")
.s3Prefix("string")
.timeouts(ExportTaskTimeoutsArgs.builder()
.create("string")
.delete("string")
.build())
.build());
export_task_resource = aws.rds.ExportTask("exportTaskResource",
export_task_identifier="string",
iam_role_arn="string",
kms_key_id="string",
s3_bucket_name="string",
source_arn="string",
export_onlies=["string"],
s3_prefix="string",
timeouts={
"create": "string",
"delete": "string",
})
const exportTaskResource = new aws.rds.ExportTask("exportTaskResource", {
exportTaskIdentifier: "string",
iamRoleArn: "string",
kmsKeyId: "string",
s3BucketName: "string",
sourceArn: "string",
exportOnlies: ["string"],
s3Prefix: "string",
timeouts: {
create: "string",
"delete": "string",
},
});
type: aws:rds:ExportTask
properties:
exportOnlies:
- string
exportTaskIdentifier: string
iamRoleArn: string
kmsKeyId: string
s3BucketName: string
s3Prefix: string
sourceArn: string
timeouts:
create: string
delete: string
ExportTask Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ExportTask resource accepts the following input properties:
- Export
Task stringIdentifier - Unique identifier for the snapshot export task.
- Iam
Role stringArn - ARN of the IAM role to use for writing to the Amazon S3 bucket.
- Kms
Key stringId - ID of the Amazon Web Services KMS key to use to encrypt the snapshot.
- S3Bucket
Name string - Name of the Amazon S3 bucket to export the snapshot to.
- Source
Arn string Amazon Resource Name (ARN) of the snapshot to export.
The following arguments are optional:
- Export
Onlies List<string> - Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the AWS StartExportTask API documentation.
- S3Prefix string
- Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
- Timeouts
Export
Task Timeouts
- Export
Task stringIdentifier - Unique identifier for the snapshot export task.
- Iam
Role stringArn - ARN of the IAM role to use for writing to the Amazon S3 bucket.
- Kms
Key stringId - ID of the Amazon Web Services KMS key to use to encrypt the snapshot.
- S3Bucket
Name string - Name of the Amazon S3 bucket to export the snapshot to.
- Source
Arn string Amazon Resource Name (ARN) of the snapshot to export.
The following arguments are optional:
- Export
Onlies []string - Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the AWS StartExportTask API documentation.
- S3Prefix string
- Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
- Timeouts
Export
Task Timeouts Args
- export
Task StringIdentifier - Unique identifier for the snapshot export task.
- iam
Role StringArn - ARN of the IAM role to use for writing to the Amazon S3 bucket.
- kms
Key StringId - ID of the Amazon Web Services KMS key to use to encrypt the snapshot.
- s3Bucket
Name String - Name of the Amazon S3 bucket to export the snapshot to.
- source
Arn String Amazon Resource Name (ARN) of the snapshot to export.
The following arguments are optional:
- export
Onlies List<String> - Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the AWS StartExportTask API documentation.
- s3Prefix String
- Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
- timeouts
Export
Task Timeouts
- export
Task stringIdentifier - Unique identifier for the snapshot export task.
- iam
Role stringArn - ARN of the IAM role to use for writing to the Amazon S3 bucket.
- kms
Key stringId - ID of the Amazon Web Services KMS key to use to encrypt the snapshot.
- s3Bucket
Name string - Name of the Amazon S3 bucket to export the snapshot to.
- source
Arn string Amazon Resource Name (ARN) of the snapshot to export.
The following arguments are optional:
- export
Onlies string[] - Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the AWS StartExportTask API documentation.
- s3Prefix string
- Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
- timeouts
Export
Task Timeouts
- export_
task_ stridentifier - Unique identifier for the snapshot export task.
- iam_
role_ strarn - ARN of the IAM role to use for writing to the Amazon S3 bucket.
- kms_
key_ strid - ID of the Amazon Web Services KMS key to use to encrypt the snapshot.
- s3_
bucket_ strname - Name of the Amazon S3 bucket to export the snapshot to.
- source_
arn str Amazon Resource Name (ARN) of the snapshot to export.
The following arguments are optional:
- export_
onlies Sequence[str] - Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the AWS StartExportTask API documentation.
- s3_
prefix str - Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
- timeouts
Export
Task Timeouts Args
- export
Task StringIdentifier - Unique identifier for the snapshot export task.
- iam
Role StringArn - ARN of the IAM role to use for writing to the Amazon S3 bucket.
- kms
Key StringId - ID of the Amazon Web Services KMS key to use to encrypt the snapshot.
- s3Bucket
Name String - Name of the Amazon S3 bucket to export the snapshot to.
- source
Arn String Amazon Resource Name (ARN) of the snapshot to export.
The following arguments are optional:
- export
Onlies List<String> - Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the AWS StartExportTask API documentation.
- s3Prefix String
- Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
- timeouts Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the ExportTask resource produces the following output properties:
- Failure
Cause string - Reason the export failed, if it failed.
- Id string
- The provider-assigned unique ID for this managed resource.
- Percent
Progress int - Progress of the snapshot export task as a percentage.
- Snapshot
Time string - Time that the snapshot was created.
- Source
Type string - Type of source for the export.
- Status string
- Status of the export task.
- Task
End stringTime - Time that the snapshot export task completed.
- Task
Start stringTime - Time that the snapshot export task started.
- Warning
Message string - Warning about the snapshot export task, if any.
- Failure
Cause string - Reason the export failed, if it failed.
- Id string
- The provider-assigned unique ID for this managed resource.
- Percent
Progress int - Progress of the snapshot export task as a percentage.
- Snapshot
Time string - Time that the snapshot was created.
- Source
Type string - Type of source for the export.
- Status string
- Status of the export task.
- Task
End stringTime - Time that the snapshot export task completed.
- Task
Start stringTime - Time that the snapshot export task started.
- Warning
Message string - Warning about the snapshot export task, if any.
- failure
Cause String - Reason the export failed, if it failed.
- id String
- The provider-assigned unique ID for this managed resource.
- percent
Progress Integer - Progress of the snapshot export task as a percentage.
- snapshot
Time String - Time that the snapshot was created.
- source
Type String - Type of source for the export.
- status String
- Status of the export task.
- task
End StringTime - Time that the snapshot export task completed.
- task
Start StringTime - Time that the snapshot export task started.
- warning
Message String - Warning about the snapshot export task, if any.
- failure
Cause string - Reason the export failed, if it failed.
- id string
- The provider-assigned unique ID for this managed resource.
- percent
Progress number - Progress of the snapshot export task as a percentage.
- snapshot
Time string - Time that the snapshot was created.
- source
Type string - Type of source for the export.
- status string
- Status of the export task.
- task
End stringTime - Time that the snapshot export task completed.
- task
Start stringTime - Time that the snapshot export task started.
- warning
Message string - Warning about the snapshot export task, if any.
- failure_
cause str - Reason the export failed, if it failed.
- id str
- The provider-assigned unique ID for this managed resource.
- percent_
progress int - Progress of the snapshot export task as a percentage.
- snapshot_
time str - Time that the snapshot was created.
- source_
type str - Type of source for the export.
- status str
- Status of the export task.
- task_
end_ strtime - Time that the snapshot export task completed.
- task_
start_ strtime - Time that the snapshot export task started.
- warning_
message str - Warning about the snapshot export task, if any.
- failure
Cause String - Reason the export failed, if it failed.
- id String
- The provider-assigned unique ID for this managed resource.
- percent
Progress Number - Progress of the snapshot export task as a percentage.
- snapshot
Time String - Time that the snapshot was created.
- source
Type String - Type of source for the export.
- status String
- Status of the export task.
- task
End StringTime - Time that the snapshot export task completed.
- task
Start StringTime - Time that the snapshot export task started.
- warning
Message String - Warning about the snapshot export task, if any.
Look up Existing ExportTask Resource
Get an existing ExportTask resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ExportTaskState, opts?: CustomResourceOptions): ExportTask
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
export_onlies: Optional[Sequence[str]] = None,
export_task_identifier: Optional[str] = None,
failure_cause: Optional[str] = None,
iam_role_arn: Optional[str] = None,
kms_key_id: Optional[str] = None,
percent_progress: Optional[int] = None,
s3_bucket_name: Optional[str] = None,
s3_prefix: Optional[str] = None,
snapshot_time: Optional[str] = None,
source_arn: Optional[str] = None,
source_type: Optional[str] = None,
status: Optional[str] = None,
task_end_time: Optional[str] = None,
task_start_time: Optional[str] = None,
timeouts: Optional[ExportTaskTimeoutsArgs] = None,
warning_message: Optional[str] = None) -> ExportTask
func GetExportTask(ctx *Context, name string, id IDInput, state *ExportTaskState, opts ...ResourceOption) (*ExportTask, error)
public static ExportTask Get(string name, Input<string> id, ExportTaskState? state, CustomResourceOptions? opts = null)
public static ExportTask get(String name, Output<String> id, ExportTaskState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Export
Onlies List<string> - Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the AWS StartExportTask API documentation.
- Export
Task stringIdentifier - Unique identifier for the snapshot export task.
- Failure
Cause string - Reason the export failed, if it failed.
- Iam
Role stringArn - ARN of the IAM role to use for writing to the Amazon S3 bucket.
- Kms
Key stringId - ID of the Amazon Web Services KMS key to use to encrypt the snapshot.
- Percent
Progress int - Progress of the snapshot export task as a percentage.
- S3Bucket
Name string - Name of the Amazon S3 bucket to export the snapshot to.
- S3Prefix string
- Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
- Snapshot
Time string - Time that the snapshot was created.
- Source
Arn string Amazon Resource Name (ARN) of the snapshot to export.
The following arguments are optional:
- Source
Type string - Type of source for the export.
- Status string
- Status of the export task.
- Task
End stringTime - Time that the snapshot export task completed.
- Task
Start stringTime - Time that the snapshot export task started.
- Timeouts
Export
Task Timeouts - Warning
Message string - Warning about the snapshot export task, if any.
- Export
Onlies []string - Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the AWS StartExportTask API documentation.
- Export
Task stringIdentifier - Unique identifier for the snapshot export task.
- Failure
Cause string - Reason the export failed, if it failed.
- Iam
Role stringArn - ARN of the IAM role to use for writing to the Amazon S3 bucket.
- Kms
Key stringId - ID of the Amazon Web Services KMS key to use to encrypt the snapshot.
- Percent
Progress int - Progress of the snapshot export task as a percentage.
- S3Bucket
Name string - Name of the Amazon S3 bucket to export the snapshot to.
- S3Prefix string
- Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
- Snapshot
Time string - Time that the snapshot was created.
- Source
Arn string Amazon Resource Name (ARN) of the snapshot to export.
The following arguments are optional:
- Source
Type string - Type of source for the export.
- Status string
- Status of the export task.
- Task
End stringTime - Time that the snapshot export task completed.
- Task
Start stringTime - Time that the snapshot export task started.
- Timeouts
Export
Task Timeouts Args - Warning
Message string - Warning about the snapshot export task, if any.
- export
Onlies List<String> - Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the AWS StartExportTask API documentation.
- export
Task StringIdentifier - Unique identifier for the snapshot export task.
- failure
Cause String - Reason the export failed, if it failed.
- iam
Role StringArn - ARN of the IAM role to use for writing to the Amazon S3 bucket.
- kms
Key StringId - ID of the Amazon Web Services KMS key to use to encrypt the snapshot.
- percent
Progress Integer - Progress of the snapshot export task as a percentage.
- s3Bucket
Name String - Name of the Amazon S3 bucket to export the snapshot to.
- s3Prefix String
- Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
- snapshot
Time String - Time that the snapshot was created.
- source
Arn String Amazon Resource Name (ARN) of the snapshot to export.
The following arguments are optional:
- source
Type String - Type of source for the export.
- status String
- Status of the export task.
- task
End StringTime - Time that the snapshot export task completed.
- task
Start StringTime - Time that the snapshot export task started.
- timeouts
Export
Task Timeouts - warning
Message String - Warning about the snapshot export task, if any.
- export
Onlies string[] - Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the AWS StartExportTask API documentation.
- export
Task stringIdentifier - Unique identifier for the snapshot export task.
- failure
Cause string - Reason the export failed, if it failed.
- iam
Role stringArn - ARN of the IAM role to use for writing to the Amazon S3 bucket.
- kms
Key stringId - ID of the Amazon Web Services KMS key to use to encrypt the snapshot.
- percent
Progress number - Progress of the snapshot export task as a percentage.
- s3Bucket
Name string - Name of the Amazon S3 bucket to export the snapshot to.
- s3Prefix string
- Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
- snapshot
Time string - Time that the snapshot was created.
- source
Arn string Amazon Resource Name (ARN) of the snapshot to export.
The following arguments are optional:
- source
Type string - Type of source for the export.
- status string
- Status of the export task.
- task
End stringTime - Time that the snapshot export task completed.
- task
Start stringTime - Time that the snapshot export task started.
- timeouts
Export
Task Timeouts - warning
Message string - Warning about the snapshot export task, if any.
- export_
onlies Sequence[str] - Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the AWS StartExportTask API documentation.
- export_
task_ stridentifier - Unique identifier for the snapshot export task.
- failure_
cause str - Reason the export failed, if it failed.
- iam_
role_ strarn - ARN of the IAM role to use for writing to the Amazon S3 bucket.
- kms_
key_ strid - ID of the Amazon Web Services KMS key to use to encrypt the snapshot.
- percent_
progress int - Progress of the snapshot export task as a percentage.
- s3_
bucket_ strname - Name of the Amazon S3 bucket to export the snapshot to.
- s3_
prefix str - Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
- snapshot_
time str - Time that the snapshot was created.
- source_
arn str Amazon Resource Name (ARN) of the snapshot to export.
The following arguments are optional:
- source_
type str - Type of source for the export.
- status str
- Status of the export task.
- task_
end_ strtime - Time that the snapshot export task completed.
- task_
start_ strtime - Time that the snapshot export task started.
- timeouts
Export
Task Timeouts Args - warning_
message str - Warning about the snapshot export task, if any.
- export
Onlies List<String> - Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the AWS StartExportTask API documentation.
- export
Task StringIdentifier - Unique identifier for the snapshot export task.
- failure
Cause String - Reason the export failed, if it failed.
- iam
Role StringArn - ARN of the IAM role to use for writing to the Amazon S3 bucket.
- kms
Key StringId - ID of the Amazon Web Services KMS key to use to encrypt the snapshot.
- percent
Progress Number - Progress of the snapshot export task as a percentage.
- s3Bucket
Name String - Name of the Amazon S3 bucket to export the snapshot to.
- s3Prefix String
- Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
- snapshot
Time String - Time that the snapshot was created.
- source
Arn String Amazon Resource Name (ARN) of the snapshot to export.
The following arguments are optional:
- source
Type String - Type of source for the export.
- status String
- Status of the export task.
- task
End StringTime - Time that the snapshot export task completed.
- task
Start StringTime - Time that the snapshot export task started.
- timeouts Property Map
- warning
Message String - Warning about the snapshot export task, if any.
Supporting Types
ExportTaskTimeouts, ExportTaskTimeoutsArgs
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- create str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
Import
Using pulumi import
, import a RDS (Relational Database) Export Task using the export_task_identifier
. For example:
$ pulumi import aws:rds/exportTask:ExportTask example example
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.