RegionSettings class

Provides an AWS Backup Region Settings resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.backup.RegionSettings("test", {
    resourceTypeOptInPreference: {
        Aurora: true,
        CloudFormation: true,
        DocumentDB: true,
        DSQL: true,
        DynamoDB: true,
        EBS: true,
        EC2: true,
        EFS: true,
        FSx: true,
        Neptune: true,
        Redshift: true,
        "Redshift Serverless": false,
        RDS: false,
        S3: false,
        "SAP HANA on Amazon EC2": false,
        "Storage Gateway": false,
        VirtualMachine: false,
    },
    resourceTypeManagementPreference: {
        CloudFormation: true,
        DSQL: true,
        DynamoDB: false,
        EFS: false,
    },
});

import pulumi
import pulumi_aws as aws

test = aws.backup.RegionSettings("test",
    resource_type_opt_in_preference={
        "Aurora": True,
        "CloudFormation": True,
        "DocumentDB": True,
        "DSQL": True,
        "DynamoDB": True,
        "EBS": True,
        "EC2": True,
        "EFS": True,
        "FSx": True,
        "Neptune": True,
        "Redshift": True,
        "Redshift Serverless": False,
        "RDS": False,
        "S3": False,
        "SAP HANA on Amazon EC2": False,
        "Storage Gateway": False,
        "VirtualMachine": False,
    },
    resource_type_management_preference={
        "CloudFormation": True,
        "DSQL": True,
        "DynamoDB": False,
        "EFS": False,
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = new Aws.Backup.RegionSettings("test", new()
    {
        ResourceTypeOptInPreference =
        {
            { "Aurora", true },
            { "CloudFormation", true },
            { "DocumentDB", true },
            { "DSQL", true },
            { "DynamoDB", true },
            { "EBS", true },
            { "EC2", true },
            { "EFS", true },
            { "FSx", true },
            { "Neptune", true },
            { "Redshift", true },
            { "Redshift Serverless", false },
            { "RDS", false },
            { "S3", false },
            { "SAP HANA on Amazon EC2", false },
            { "Storage Gateway", false },
            { "VirtualMachine", false },
        },
        ResourceTypeManagementPreference =
        {
            { "CloudFormation", true },
            { "DSQL", true },
            { "DynamoDB", false },
            { "EFS", false },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/backup"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := backup.NewRegionSettings(ctx, "test", &backup.RegionSettingsArgs{
			ResourceTypeOptInPreference: pulumi.BoolMap{
				"Aurora":                 pulumi.Bool(true),
				"CloudFormation":         pulumi.Bool(true),
				"DocumentDB":             pulumi.Bool(true),
				"DSQL":                   pulumi.Bool(true),
				"DynamoDB":               pulumi.Bool(true),
				"EBS":                    pulumi.Bool(true),
				"EC2":                    pulumi.Bool(true),
				"EFS":                    pulumi.Bool(true),
				"FSx":                    pulumi.Bool(true),
				"Neptune":                pulumi.Bool(true),
				"Redshift":               pulumi.Bool(true),
				"Redshift Serverless":    pulumi.Bool(false),
				"RDS":                    pulumi.Bool(false),
				"S3":                     pulumi.Bool(false),
				"SAP HANA on Amazon EC2": pulumi.Bool(false),
				"Storage Gateway":        pulumi.Bool(false),
				"VirtualMachine":         pulumi.Bool(false),
			},
			ResourceTypeManagementPreference: pulumi.BoolMap{
				"CloudFormation": pulumi.Bool(true),
				"DSQL":           pulumi.Bool(true),
				"DynamoDB":       pulumi.Bool(false),
				"EFS":            pulumi.Bool(false),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_backup_regionsettings" "test" {
  resource_type_opt_in_preference = {
    "Aurora"                 = true
    "CloudFormation"         = true
    "DocumentDB"             = true
    "DSQL"                   = true
    "DynamoDB"               = true
    "EBS"                    = true
    "EC2"                    = true
    "EFS"                    = true
    "FSx"                    = true
    "Neptune"                = true
    "Redshift"               = true
    "Redshift Serverless"    = false
    "RDS"                    = false
    "S3"                     = false
    "SAP HANA on Amazon EC2" = false
    "Storage Gateway"        = false
    "VirtualMachine"         = false
  }
  resource_type_management_preference = {
    "CloudFormation" = true
    "DSQL"           = true
    "DynamoDB"       = false
    "EFS"            = false
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.backup.RegionSettings;
import com.pulumi.aws.backup.RegionSettingsArgs;
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 test = new RegionSettings("test", RegionSettingsArgs.builder()
            .resourceTypeOptInPreference(Map.ofEntries(
                Map.entry("Aurora", true),
                Map.entry("CloudFormation", true),
                Map.entry("DocumentDB", true),
                Map.entry("DSQL", true),
                Map.entry("DynamoDB", true),
                Map.entry("EBS", true),
                Map.entry("EC2", true),
                Map.entry("EFS", true),
                Map.entry("FSx", true),
                Map.entry("Neptune", true),
                Map.entry("Redshift", true),
                Map.entry("Redshift Serverless", false),
                Map.entry("RDS", false),
                Map.entry("S3", false),
                Map.entry("SAP HANA on Amazon EC2", false),
                Map.entry("Storage Gateway", false),
                Map.entry("VirtualMachine", false)
            ))
            .resourceTypeManagementPreference(Map.ofEntries(
                Map.entry("CloudFormation", true),
                Map.entry("DSQL", true),
                Map.entry("DynamoDB", false),
                Map.entry("EFS", false)
            ))
            .build());

    }
}

resources:
  test:
    type: aws:backup:RegionSettings
    properties:
      resourceTypeOptInPreference:
        Aurora: true
        CloudFormation: true
        DocumentDB: true
        DSQL: true
        DynamoDB: true
        EBS: true
        EC2: true
        EFS: true
        FSx: true
        Neptune: true
        Redshift: true
        Redshift Serverless: false
        RDS: false
        S3: false
        SAP HANA on Amazon EC2: false
        Storage Gateway: false
        VirtualMachine: false
      resourceTypeManagementPreference:
        CloudFormation: true
        DSQL: true
        DynamoDB: false
        EFS: false

Import

Identity Schema

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

Using pulumi import, import Backup Region Settings using the region. For example:

$ pulumi import aws:backup/regionSettings:RegionSettings test us-west-2

Constructors

RegionSettings(String name, {RegionSettingsArgs? args, CustomResourceOptions? options})
Creates a new RegionSettings. name The Pulumi resource name. args Arguments used to configure this RegionSettings. The set of arguments for RegionSettings. options Resource options controlling this resource's behavior.
RegionSettings.reference(String urn)
Creates a typed reference to an existing RegionSettings resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
resourceTypeManagementPreference ↔ Output<Map<String, bool>>
A map of service names to their full management preferences for the Region. For more information, see the AWS Documentation on what full management is and which services support full management.
latefinal
resourceTypeOptInPreference ↔ Output<Map<String, bool>>
A map of service names to their opt-in preferences for the Region. See AWS Documentation on which services support backup.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {RegionSettingsState? state, CustomResourceOptions? options}) → RegionSettings
Gets an existing RegionSettings resource's state with the given name and id.