1. Packages
  2. AWS Classic
  3. API Docs
  4. backup
  5. RegionSettings

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi

aws.backup.RegionSettings

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi

    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,
            DocumentDB: true,
            DynamoDB: true,
            EBS: true,
            EC2: true,
            EFS: true,
            FSx: true,
            Neptune: true,
            RDS: true,
            "Storage Gateway": true,
            VirtualMachine: true,
        },
        resourceTypeManagementPreference: {
            DynamoDB: true,
            EFS: true,
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    test = aws.backup.RegionSettings("test",
        resource_type_opt_in_preference={
            "Aurora": True,
            "DocumentDB": True,
            "DynamoDB": True,
            "EBS": True,
            "EC2": True,
            "EFS": True,
            "FSx": True,
            "Neptune": True,
            "RDS": True,
            "Storage Gateway": True,
            "VirtualMachine": True,
        },
        resource_type_management_preference={
            "DynamoDB": True,
            "EFS": True,
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/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),
    				"DocumentDB":      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),
    				"RDS":             pulumi.Bool(true),
    				"Storage Gateway": pulumi.Bool(true),
    				"VirtualMachine":  pulumi.Bool(true),
    			},
    			ResourceTypeManagementPreference: pulumi.BoolMap{
    				"DynamoDB": pulumi.Bool(true),
    				"EFS":      pulumi.Bool(true),
    			},
    		})
    		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 test = new Aws.Backup.RegionSettings("test", new()
        {
            ResourceTypeOptInPreference = 
            {
                { "Aurora", true },
                { "DocumentDB", true },
                { "DynamoDB", true },
                { "EBS", true },
                { "EC2", true },
                { "EFS", true },
                { "FSx", true },
                { "Neptune", true },
                { "RDS", true },
                { "Storage Gateway", true },
                { "VirtualMachine", true },
            },
            ResourceTypeManagementPreference = 
            {
                { "DynamoDB", true },
                { "EFS", true },
            },
        });
    
    });
    
    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.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 test = new RegionSettings("test", RegionSettingsArgs.builder()
                .resourceTypeOptInPreference(Map.ofEntries(
                    Map.entry("Aurora", true),
                    Map.entry("DocumentDB", 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("RDS", true),
                    Map.entry("Storage Gateway", true),
                    Map.entry("VirtualMachine", true)
                ))
                .resourceTypeManagementPreference(Map.ofEntries(
                    Map.entry("DynamoDB", true),
                    Map.entry("EFS", true)
                ))
                .build());
    
        }
    }
    
    resources:
      test:
        type: aws:backup:RegionSettings
        properties:
          resourceTypeOptInPreference:
            Aurora: true
            DocumentDB: true
            DynamoDB: true
            EBS: true
            EC2: true
            EFS: true
            FSx: true
            Neptune: true
            RDS: true
            Storage Gateway: true
            VirtualMachine: true
          resourceTypeManagementPreference:
            DynamoDB: true
            EFS: true
    

    Create RegionSettings Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RegionSettings(name: string, args: RegionSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def RegionSettings(resource_name: str,
                       args: RegionSettingsArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def RegionSettings(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       resource_type_opt_in_preference: Optional[Mapping[str, bool]] = None,
                       resource_type_management_preference: Optional[Mapping[str, bool]] = None)
    func NewRegionSettings(ctx *Context, name string, args RegionSettingsArgs, opts ...ResourceOption) (*RegionSettings, error)
    public RegionSettings(string name, RegionSettingsArgs args, CustomResourceOptions? opts = null)
    public RegionSettings(String name, RegionSettingsArgs args)
    public RegionSettings(String name, RegionSettingsArgs args, CustomResourceOptions options)
    
    type: aws:backup:RegionSettings
    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 RegionSettingsArgs
    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 RegionSettingsArgs
    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 RegionSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RegionSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RegionSettingsArgs
    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 regionSettingsResource = new Aws.Backup.RegionSettings("regionSettingsResource", new()
    {
        ResourceTypeOptInPreference = 
        {
            { "string", false },
        },
        ResourceTypeManagementPreference = 
        {
            { "string", false },
        },
    });
    
    example, err := backup.NewRegionSettings(ctx, "regionSettingsResource", &backup.RegionSettingsArgs{
    	ResourceTypeOptInPreference: pulumi.BoolMap{
    		"string": pulumi.Bool(false),
    	},
    	ResourceTypeManagementPreference: pulumi.BoolMap{
    		"string": pulumi.Bool(false),
    	},
    })
    
    var regionSettingsResource = new RegionSettings("regionSettingsResource", RegionSettingsArgs.builder()
        .resourceTypeOptInPreference(Map.of("string", false))
        .resourceTypeManagementPreference(Map.of("string", false))
        .build());
    
    region_settings_resource = aws.backup.RegionSettings("regionSettingsResource",
        resource_type_opt_in_preference={
            "string": False,
        },
        resource_type_management_preference={
            "string": False,
        })
    
    const regionSettingsResource = new aws.backup.RegionSettings("regionSettingsResource", {
        resourceTypeOptInPreference: {
            string: false,
        },
        resourceTypeManagementPreference: {
            string: false,
        },
    });
    
    type: aws:backup:RegionSettings
    properties:
        resourceTypeManagementPreference:
            string: false
        resourceTypeOptInPreference:
            string: false
    

    RegionSettings Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The RegionSettings resource accepts the following input properties:

    ResourceTypeOptInPreference Dictionary<string, bool>
    A map of services along with the opt-in preferences for the Region.
    ResourceTypeManagementPreference Dictionary<string, bool>
    A map of services along with the management preferences for the Region. For more information, see the AWS Documentation.
    ResourceTypeOptInPreference map[string]bool
    A map of services along with the opt-in preferences for the Region.
    ResourceTypeManagementPreference map[string]bool
    A map of services along with the management preferences for the Region. For more information, see the AWS Documentation.
    resourceTypeOptInPreference Map<String,Boolean>
    A map of services along with the opt-in preferences for the Region.
    resourceTypeManagementPreference Map<String,Boolean>
    A map of services along with the management preferences for the Region. For more information, see the AWS Documentation.
    resourceTypeOptInPreference {[key: string]: boolean}
    A map of services along with the opt-in preferences for the Region.
    resourceTypeManagementPreference {[key: string]: boolean}
    A map of services along with the management preferences for the Region. For more information, see the AWS Documentation.
    resource_type_opt_in_preference Mapping[str, bool]
    A map of services along with the opt-in preferences for the Region.
    resource_type_management_preference Mapping[str, bool]
    A map of services along with the management preferences for the Region. For more information, see the AWS Documentation.
    resourceTypeOptInPreference Map<Boolean>
    A map of services along with the opt-in preferences for the Region.
    resourceTypeManagementPreference Map<Boolean>
    A map of services along with the management preferences for the Region. For more information, see the AWS Documentation.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RegionSettings resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing RegionSettings Resource

    Get an existing RegionSettings 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?: RegionSettingsState, opts?: CustomResourceOptions): RegionSettings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            resource_type_management_preference: Optional[Mapping[str, bool]] = None,
            resource_type_opt_in_preference: Optional[Mapping[str, bool]] = None) -> RegionSettings
    func GetRegionSettings(ctx *Context, name string, id IDInput, state *RegionSettingsState, opts ...ResourceOption) (*RegionSettings, error)
    public static RegionSettings Get(string name, Input<string> id, RegionSettingsState? state, CustomResourceOptions? opts = null)
    public static RegionSettings get(String name, Output<String> id, RegionSettingsState 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.
    The following state arguments are supported:
    ResourceTypeManagementPreference Dictionary<string, bool>
    A map of services along with the management preferences for the Region. For more information, see the AWS Documentation.
    ResourceTypeOptInPreference Dictionary<string, bool>
    A map of services along with the opt-in preferences for the Region.
    ResourceTypeManagementPreference map[string]bool
    A map of services along with the management preferences for the Region. For more information, see the AWS Documentation.
    ResourceTypeOptInPreference map[string]bool
    A map of services along with the opt-in preferences for the Region.
    resourceTypeManagementPreference Map<String,Boolean>
    A map of services along with the management preferences for the Region. For more information, see the AWS Documentation.
    resourceTypeOptInPreference Map<String,Boolean>
    A map of services along with the opt-in preferences for the Region.
    resourceTypeManagementPreference {[key: string]: boolean}
    A map of services along with the management preferences for the Region. For more information, see the AWS Documentation.
    resourceTypeOptInPreference {[key: string]: boolean}
    A map of services along with the opt-in preferences for the Region.
    resource_type_management_preference Mapping[str, bool]
    A map of services along with the management preferences for the Region. For more information, see the AWS Documentation.
    resource_type_opt_in_preference Mapping[str, bool]
    A map of services along with the opt-in preferences for the Region.
    resourceTypeManagementPreference Map<Boolean>
    A map of services along with the management preferences for the Region. For more information, see the AWS Documentation.
    resourceTypeOptInPreference Map<Boolean>
    A map of services along with the opt-in preferences for the Region.

    Import

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

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

    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.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi