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

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.GlobalSettings

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 Global Settings resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const test = new aws.backup.GlobalSettings("test", {globalSettings: {
        isCrossAccountBackupEnabled: "true",
    }});
    
    import pulumi
    import pulumi_aws as aws
    
    test = aws.backup.GlobalSettings("test", global_settings={
        "isCrossAccountBackupEnabled": "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.NewGlobalSettings(ctx, "test", &backup.GlobalSettingsArgs{
    			GlobalSettings: pulumi.StringMap{
    				"isCrossAccountBackupEnabled": pulumi.String("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.GlobalSettings("test", new()
        {
            GlobalSettingsList = 
            {
                { "isCrossAccountBackupEnabled", "true" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.backup.GlobalSettings;
    import com.pulumi.aws.backup.GlobalSettingsArgs;
    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 GlobalSettings("test", GlobalSettingsArgs.builder()
                .globalSettings(Map.of("isCrossAccountBackupEnabled", "true"))
                .build());
    
        }
    }
    
    resources:
      test:
        type: aws:backup:GlobalSettings
        properties:
          globalSettings:
            isCrossAccountBackupEnabled: 'true'
    

    Create GlobalSettings Resource

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

    Constructor syntax

    new GlobalSettings(name: string, args: GlobalSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def GlobalSettings(resource_name: str,
                       args: GlobalSettingsArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def GlobalSettings(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       global_settings: Optional[Mapping[str, str]] = None)
    func NewGlobalSettings(ctx *Context, name string, args GlobalSettingsArgs, opts ...ResourceOption) (*GlobalSettings, error)
    public GlobalSettings(string name, GlobalSettingsArgs args, CustomResourceOptions? opts = null)
    public GlobalSettings(String name, GlobalSettingsArgs args)
    public GlobalSettings(String name, GlobalSettingsArgs args, CustomResourceOptions options)
    
    type: aws:backup:GlobalSettings
    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 GlobalSettingsArgs
    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 GlobalSettingsArgs
    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 GlobalSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GlobalSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GlobalSettingsArgs
    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 globalSettingsResource = new Aws.Backup.GlobalSettings("globalSettingsResource", new()
    {
        GlobalSettingsList = 
        {
            { "string", "string" },
        },
    });
    
    example, err := backup.NewGlobalSettings(ctx, "globalSettingsResource", &backup.GlobalSettingsArgs{
    	GlobalSettings: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var globalSettingsResource = new GlobalSettings("globalSettingsResource", GlobalSettingsArgs.builder()
        .globalSettings(Map.of("string", "string"))
        .build());
    
    global_settings_resource = aws.backup.GlobalSettings("globalSettingsResource", global_settings={
        "string": "string",
    })
    
    const globalSettingsResource = new aws.backup.GlobalSettings("globalSettingsResource", {globalSettings: {
        string: "string",
    }});
    
    type: aws:backup:GlobalSettings
    properties:
        globalSettings:
            string: string
    

    GlobalSettings 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 GlobalSettings resource accepts the following input properties:

    GlobalSettingsList Dictionary<string, string>
    A list of resources along with the opt-in preferences for the account.
    GlobalSettings map[string]string
    A list of resources along with the opt-in preferences for the account.
    globalSettings Map<String,String>
    A list of resources along with the opt-in preferences for the account.
    globalSettings {[key: string]: string}
    A list of resources along with the opt-in preferences for the account.
    global_settings Mapping[str, str]
    A list of resources along with the opt-in preferences for the account.
    globalSettings Map<String>
    A list of resources along with the opt-in preferences for the account.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GlobalSettings 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 GlobalSettings Resource

    Get an existing GlobalSettings 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?: GlobalSettingsState, opts?: CustomResourceOptions): GlobalSettings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            global_settings: Optional[Mapping[str, str]] = None) -> GlobalSettings
    func GetGlobalSettings(ctx *Context, name string, id IDInput, state *GlobalSettingsState, opts ...ResourceOption) (*GlobalSettings, error)
    public static GlobalSettings Get(string name, Input<string> id, GlobalSettingsState? state, CustomResourceOptions? opts = null)
    public static GlobalSettings get(String name, Output<String> id, GlobalSettingsState 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:
    GlobalSettingsList Dictionary<string, string>
    A list of resources along with the opt-in preferences for the account.
    GlobalSettings map[string]string
    A list of resources along with the opt-in preferences for the account.
    globalSettings Map<String,String>
    A list of resources along with the opt-in preferences for the account.
    globalSettings {[key: string]: string}
    A list of resources along with the opt-in preferences for the account.
    global_settings Mapping[str, str]
    A list of resources along with the opt-in preferences for the account.
    globalSettings Map<String>
    A list of resources along with the opt-in preferences for the account.

    Import

    Using pulumi import, import Backup Global Settings using the id. For example:

    $ pulumi import aws:backup/globalSettings:GlobalSettings example 123456789012
    

    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