Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. route53recoveryreadiness
  5. RecoveryGroup
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.route53recoveryreadiness.RecoveryGroup

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Provides an AWS Route 53 Recovery Readiness Recovery Group.

    Example Usage

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

const example = new aws.route53recoveryreadiness.RecoveryGroup("example", {recoveryGroupName: "my-high-availability-app"});

    import pulumi
import pulumi_aws as aws

example = aws.route53recoveryreadiness.RecoveryGroup("example", recovery_group_name="my-high-availability-app")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/route53recoveryreadiness"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := route53recoveryreadiness.NewRecoveryGroup(ctx, "example", &route53recoveryreadiness.RecoveryGroupArgs{
			RecoveryGroupName: pulumi.String("my-high-availability-app"),
		})
		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.Route53RecoveryReadiness.RecoveryGroup("example", new()
    {
        RecoveryGroupName = "my-high-availability-app",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.route53recoveryreadiness.RecoveryGroup;
import com.pulumi.aws.route53recoveryreadiness.RecoveryGroupArgs;
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 RecoveryGroup("example", RecoveryGroupArgs.builder()
            .recoveryGroupName("my-high-availability-app")
            .build());

    }
}

    resources:
  example:
    type: aws:route53recoveryreadiness:RecoveryGroup
    properties:
      recoveryGroupName: my-high-availability-app

    Create RecoveryGroup Resource

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

    Constructor syntax

    new RecoveryGroup(name: string, args: RecoveryGroupArgs, opts?: CustomResourceOptions);
    @overload
def RecoveryGroup(resource_name: str,
                  args: RecoveryGroupArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def RecoveryGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  recovery_group_name: Optional[str] = None,
                  cells: Optional[Sequence[str]] = None,
                  tags: Optional[Mapping[str, str]] = None)
    func NewRecoveryGroup(ctx *Context, name string, args RecoveryGroupArgs, opts ...ResourceOption) (*RecoveryGroup, error)
    public RecoveryGroup(string name, RecoveryGroupArgs args, CustomResourceOptions? opts = null)
    public RecoveryGroup(String name, RecoveryGroupArgs args)
public RecoveryGroup(String name, RecoveryGroupArgs args, CustomResourceOptions options)

    type: aws:route53recoveryreadiness:RecoveryGroup
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 RecoveryGroupArgs
    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 RecoveryGroupArgs
    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 RecoveryGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RecoveryGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RecoveryGroupArgs
    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 recoveryGroupResource = new Aws.Route53RecoveryReadiness.RecoveryGroup("recoveryGroupResource", new()
{
    RecoveryGroupName = "string",
    Cells = new[]
    {
        "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := route53recoveryreadiness.NewRecoveryGroup(ctx, "recoveryGroupResource", &route53recoveryreadiness.RecoveryGroupArgs{
	RecoveryGroupName: pulumi.String("string"),
	Cells: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var recoveryGroupResource = new RecoveryGroup("recoveryGroupResource", RecoveryGroupArgs.builder()
    .recoveryGroupName("string")
    .cells("string")
    .tags(Map.of("string", "string"))
    .build());

    recovery_group_resource = aws.route53recoveryreadiness.RecoveryGroup("recoveryGroupResource",
    recovery_group_name="string",
    cells=["string"],
    tags={
        "string": "string",
    })

    const recoveryGroupResource = new aws.route53recoveryreadiness.RecoveryGroup("recoveryGroupResource", {
    recoveryGroupName: "string",
    cells: ["string"],
    tags: {
        string: "string",
    },
});

    type: aws:route53recoveryreadiness:RecoveryGroup
properties:
    cells:
        - string
    recoveryGroupName: string
    tags:
        string: string

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

    RecoveryGroupName string

    A unique name describing the recovery group.

    The following argument are optional:

    Cells List<string>
    List of cell arns to add as nested fault domains within this recovery group
    Tags Dictionary<string, string>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    RecoveryGroupName string

    A unique name describing the recovery group.

    The following argument are optional:

    Cells []string
    List of cell arns to add as nested fault domains within this recovery group
    Tags map[string]string
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    recoveryGroupName String

    A unique name describing the recovery group.

    The following argument are optional:

    cells List<String>
    List of cell arns to add as nested fault domains within this recovery group
    tags Map<String,String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    recoveryGroupName string

    A unique name describing the recovery group.

    The following argument are optional:

    cells string[]
    List of cell arns to add as nested fault domains within this recovery group
    tags {[key: string]: string}
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    recovery_group_name str

    A unique name describing the recovery group.

    The following argument are optional:

    cells Sequence[str]
    List of cell arns to add as nested fault domains within this recovery group
    tags Mapping[str, str]
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    recoveryGroupName String

    A unique name describing the recovery group.

    The following argument are optional:

    cells List<String>
    List of cell arns to add as nested fault domains within this recovery group
    tags Map<String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

    Outputs

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

    Arn string
    ARN of the recovery group
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the recovery group
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the recovery group
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the recovery group
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the recovery group
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the recovery group
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing RecoveryGroup Resource

    Get an existing RecoveryGroup 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?: RecoveryGroupState, opts?: CustomResourceOptions): RecoveryGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        cells: Optional[Sequence[str]] = None,
        recovery_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> RecoveryGroup
    func GetRecoveryGroup(ctx *Context, name string, id IDInput, state *RecoveryGroupState, opts ...ResourceOption) (*RecoveryGroup, error)
    public static RecoveryGroup Get(string name, Input<string> id, RecoveryGroupState? state, CustomResourceOptions? opts = null)
    public static RecoveryGroup get(String name, Output<String> id, RecoveryGroupState 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:
    Arn string
    ARN of the recovery group
    Cells List<string>
    List of cell arns to add as nested fault domains within this recovery group
    RecoveryGroupName string

    A unique name describing the recovery group.

    The following argument are optional:

    Tags Dictionary<string, string>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the recovery group
    Cells []string
    List of cell arns to add as nested fault domains within this recovery group
    RecoveryGroupName string

    A unique name describing the recovery group.

    The following argument are optional:

    Tags map[string]string
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the recovery group
    cells List<String>
    List of cell arns to add as nested fault domains within this recovery group
    recoveryGroupName String

    A unique name describing the recovery group.

    The following argument are optional:

    tags Map<String,String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the recovery group
    cells string[]
    List of cell arns to add as nested fault domains within this recovery group
    recoveryGroupName string

    A unique name describing the recovery group.

    The following argument are optional:

    tags {[key: string]: string}
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the recovery group
    cells Sequence[str]
    List of cell arns to add as nested fault domains within this recovery group
    recovery_group_name str

    A unique name describing the recovery group.

    The following argument are optional:

    tags Mapping[str, str]
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the recovery group
    cells List<String>
    List of cell arns to add as nested fault domains within this recovery group
    recoveryGroupName String

    A unique name describing the recovery group.

    The following argument are optional:

    tags Map<String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import Route53 Recovery Readiness recovery groups using the recovery group name. For example:

    $ pulumi import aws:route53recoveryreadiness/recoveryGroup:RecoveryGroup my-high-availability-app my-high-availability-app

    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
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws