Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. route53recoverycontrol
  5. Cluster
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.route53recoverycontrol.Cluster

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Provides an AWS Route 53 Recovery Control Config Cluster.

Example Usage

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

const example = new aws.route53recoverycontrol.Cluster("example", {name: "georgefitzgerald"});
Copy
import pulumi
import pulumi_aws as aws

example = aws.route53recoverycontrol.Cluster("example", name="georgefitzgerald")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := route53recoverycontrol.NewCluster(ctx, "example", &route53recoverycontrol.ClusterArgs{
			Name: pulumi.String("georgefitzgerald"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Route53RecoveryControl.Cluster("example", new()
    {
        Name = "georgefitzgerald",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.route53recoverycontrol.Cluster;
import com.pulumi.aws.route53recoverycontrol.ClusterArgs;
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 Cluster("example", ClusterArgs.builder()
            .name("georgefitzgerald")
            .build());

    }
}
Copy
resources:
  example:
    type: aws:route53recoverycontrol:Cluster
    properties:
      name: georgefitzgerald
Copy

Create Cluster Resource

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

Constructor syntax

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

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None)
func NewCluster(ctx *Context, name string, args *ClusterArgs, opts ...ResourceOption) (*Cluster, error)
public Cluster(string name, ClusterArgs? args = null, CustomResourceOptions? opts = null)
public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

type: aws:route53recoverycontrol:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ClusterArgs
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 exampleclusterResourceResourceFromRoute53recoverycontrolcluster = new Aws.Route53RecoveryControl.Cluster("exampleclusterResourceResourceFromRoute53recoverycontrolcluster", new()
{
    Name = "string",
});
Copy
example, err := route53recoverycontrol.NewCluster(ctx, "exampleclusterResourceResourceFromRoute53recoverycontrolcluster", &route53recoverycontrol.ClusterArgs{
	Name: pulumi.String("string"),
})
Copy
var exampleclusterResourceResourceFromRoute53recoverycontrolcluster = new Cluster("exampleclusterResourceResourceFromRoute53recoverycontrolcluster", ClusterArgs.builder()
    .name("string")
    .build());
Copy
examplecluster_resource_resource_from_route53recoverycontrolcluster = aws.route53recoverycontrol.Cluster("exampleclusterResourceResourceFromRoute53recoverycontrolcluster", name="string")
Copy
const exampleclusterResourceResourceFromRoute53recoverycontrolcluster = new aws.route53recoverycontrol.Cluster("exampleclusterResourceResourceFromRoute53recoverycontrolcluster", {name: "string"});
Copy
type: aws:route53recoverycontrol:Cluster
properties:
    name: string
Copy

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

Name Changes to this property will trigger replacement. string
Unique name describing the cluster.
Name Changes to this property will trigger replacement. string
Unique name describing the cluster.
name Changes to this property will trigger replacement. String
Unique name describing the cluster.
name Changes to this property will trigger replacement. string
Unique name describing the cluster.
name Changes to this property will trigger replacement. str
Unique name describing the cluster.
name Changes to this property will trigger replacement. String
Unique name describing the cluster.

Outputs

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

Arn string
ARN of the cluster
ClusterEndpoints List<ClusterClusterEndpoint>
List of 5 endpoints in 5 regions that can be used to talk to the cluster. See below.
Id string
The provider-assigned unique ID for this managed resource.
Status string
Status of cluster. PENDING when it is being created, PENDING_DELETION when it is being deleted and DEPLOYED otherwise.
Arn string
ARN of the cluster
ClusterEndpoints []ClusterClusterEndpoint
List of 5 endpoints in 5 regions that can be used to talk to the cluster. See below.
Id string
The provider-assigned unique ID for this managed resource.
Status string
Status of cluster. PENDING when it is being created, PENDING_DELETION when it is being deleted and DEPLOYED otherwise.
arn String
ARN of the cluster
clusterEndpoints List<ClusterClusterEndpoint>
List of 5 endpoints in 5 regions that can be used to talk to the cluster. See below.
id String
The provider-assigned unique ID for this managed resource.
status String
Status of cluster. PENDING when it is being created, PENDING_DELETION when it is being deleted and DEPLOYED otherwise.
arn string
ARN of the cluster
clusterEndpoints ClusterClusterEndpoint[]
List of 5 endpoints in 5 regions that can be used to talk to the cluster. See below.
id string
The provider-assigned unique ID for this managed resource.
status string
Status of cluster. PENDING when it is being created, PENDING_DELETION when it is being deleted and DEPLOYED otherwise.
arn str
ARN of the cluster
cluster_endpoints Sequence[ClusterClusterEndpoint]
List of 5 endpoints in 5 regions that can be used to talk to the cluster. See below.
id str
The provider-assigned unique ID for this managed resource.
status str
Status of cluster. PENDING when it is being created, PENDING_DELETION when it is being deleted and DEPLOYED otherwise.
arn String
ARN of the cluster
clusterEndpoints List<Property Map>
List of 5 endpoints in 5 regions that can be used to talk to the cluster. See below.
id String
The provider-assigned unique ID for this managed resource.
status String
Status of cluster. PENDING when it is being created, PENDING_DELETION when it is being deleted and DEPLOYED otherwise.

Look up Existing Cluster Resource

Get an existing Cluster 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?: ClusterState, opts?: CustomResourceOptions): Cluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        cluster_endpoints: Optional[Sequence[ClusterClusterEndpointArgs]] = None,
        name: Optional[str] = None,
        status: Optional[str] = None) -> Cluster
func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
resources:  _:    type: aws:route53recoverycontrol:Cluster    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 cluster
ClusterEndpoints List<ClusterClusterEndpoint>
List of 5 endpoints in 5 regions that can be used to talk to the cluster. See below.
Name Changes to this property will trigger replacement. string
Unique name describing the cluster.
Status string
Status of cluster. PENDING when it is being created, PENDING_DELETION when it is being deleted and DEPLOYED otherwise.
Arn string
ARN of the cluster
ClusterEndpoints []ClusterClusterEndpointArgs
List of 5 endpoints in 5 regions that can be used to talk to the cluster. See below.
Name Changes to this property will trigger replacement. string
Unique name describing the cluster.
Status string
Status of cluster. PENDING when it is being created, PENDING_DELETION when it is being deleted and DEPLOYED otherwise.
arn String
ARN of the cluster
clusterEndpoints List<ClusterClusterEndpoint>
List of 5 endpoints in 5 regions that can be used to talk to the cluster. See below.
name Changes to this property will trigger replacement. String
Unique name describing the cluster.
status String
Status of cluster. PENDING when it is being created, PENDING_DELETION when it is being deleted and DEPLOYED otherwise.
arn string
ARN of the cluster
clusterEndpoints ClusterClusterEndpoint[]
List of 5 endpoints in 5 regions that can be used to talk to the cluster. See below.
name Changes to this property will trigger replacement. string
Unique name describing the cluster.
status string
Status of cluster. PENDING when it is being created, PENDING_DELETION when it is being deleted and DEPLOYED otherwise.
arn str
ARN of the cluster
cluster_endpoints Sequence[ClusterClusterEndpointArgs]
List of 5 endpoints in 5 regions that can be used to talk to the cluster. See below.
name Changes to this property will trigger replacement. str
Unique name describing the cluster.
status str
Status of cluster. PENDING when it is being created, PENDING_DELETION when it is being deleted and DEPLOYED otherwise.
arn String
ARN of the cluster
clusterEndpoints List<Property Map>
List of 5 endpoints in 5 regions that can be used to talk to the cluster. See below.
name Changes to this property will trigger replacement. String
Unique name describing the cluster.
status String
Status of cluster. PENDING when it is being created, PENDING_DELETION when it is being deleted and DEPLOYED otherwise.

Supporting Types

ClusterClusterEndpoint
, ClusterClusterEndpointArgs

Endpoint string
Cluster endpoint.
Region string
Region of the endpoint.
Endpoint string
Cluster endpoint.
Region string
Region of the endpoint.
endpoint String
Cluster endpoint.
region String
Region of the endpoint.
endpoint string
Cluster endpoint.
region string
Region of the endpoint.
endpoint str
Cluster endpoint.
region str
Region of the endpoint.
endpoint String
Cluster endpoint.
region String
Region of the endpoint.

Import

Using pulumi import, import Route53 Recovery Control Config cluster using the cluster ARN. For example:

$ pulumi import aws:route53recoverycontrol/cluster:Cluster mycluster arn:aws:route53-recovery-control::313517334327:cluster/f9ae13be-a11e-4ec7-8522-94a70468e6ea
Copy

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 v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws