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

aws.route53recoveryreadiness.ReadinessCheck

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 Readiness Readiness Check.

Example Usage

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

const example = new aws.route53recoveryreadiness.ReadinessCheck("example", {
    readinessCheckName: my_cw_alarm_check,
    resourceSetName: my_cw_alarm_set,
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.route53recoveryreadiness.ReadinessCheck("example",
    readiness_check_name=my_cw_alarm_check,
    resource_set_name=my_cw_alarm_set)
Copy
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.NewReadinessCheck(ctx, "example", &route53recoveryreadiness.ReadinessCheckArgs{
			ReadinessCheckName: pulumi.Any(my_cw_alarm_check),
			ResourceSetName:    pulumi.Any(my_cw_alarm_set),
		})
		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.Route53RecoveryReadiness.ReadinessCheck("example", new()
    {
        ReadinessCheckName = my_cw_alarm_check,
        ResourceSetName = my_cw_alarm_set,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.route53recoveryreadiness.ReadinessCheck;
import com.pulumi.aws.route53recoveryreadiness.ReadinessCheckArgs;
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 ReadinessCheck("example", ReadinessCheckArgs.builder()
            .readinessCheckName(my_cw_alarm_check)
            .resourceSetName(my_cw_alarm_set)
            .build());

    }
}
Copy
resources:
  example:
    type: aws:route53recoveryreadiness:ReadinessCheck
    properties:
      readinessCheckName: ${["my-cw-alarm-check"]}
      resourceSetName: ${["my-cw-alarm-set"]}
Copy

Create ReadinessCheck Resource

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

Constructor syntax

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

@overload
def ReadinessCheck(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   readiness_check_name: Optional[str] = None,
                   resource_set_name: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None)
func NewReadinessCheck(ctx *Context, name string, args ReadinessCheckArgs, opts ...ResourceOption) (*ReadinessCheck, error)
public ReadinessCheck(string name, ReadinessCheckArgs args, CustomResourceOptions? opts = null)
public ReadinessCheck(String name, ReadinessCheckArgs args)
public ReadinessCheck(String name, ReadinessCheckArgs args, CustomResourceOptions options)

type: aws:route53recoveryreadiness:ReadinessCheck
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 This property is required. ReadinessCheckArgs
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 This property is required. ReadinessCheckArgs
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 This property is required. ReadinessCheckArgs
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 This property is required. ReadinessCheckArgs
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. ReadinessCheckArgs
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 readinessCheckResource = new Aws.Route53RecoveryReadiness.ReadinessCheck("readinessCheckResource", new()
{
    ReadinessCheckName = "string",
    ResourceSetName = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := route53recoveryreadiness.NewReadinessCheck(ctx, "readinessCheckResource", &route53recoveryreadiness.ReadinessCheckArgs{
	ReadinessCheckName: pulumi.String("string"),
	ResourceSetName:    pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var readinessCheckResource = new ReadinessCheck("readinessCheckResource", ReadinessCheckArgs.builder()
    .readinessCheckName("string")
    .resourceSetName("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
readiness_check_resource = aws.route53recoveryreadiness.ReadinessCheck("readinessCheckResource",
    readiness_check_name="string",
    resource_set_name="string",
    tags={
        "string": "string",
    })
Copy
const readinessCheckResource = new aws.route53recoveryreadiness.ReadinessCheck("readinessCheckResource", {
    readinessCheckName: "string",
    resourceSetName: "string",
    tags: {
        string: "string",
    },
});
Copy
type: aws:route53recoveryreadiness:ReadinessCheck
properties:
    readinessCheckName: string
    resourceSetName: string
    tags:
        string: string
Copy

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

ReadinessCheckName
This property is required.
Changes to this property will trigger replacement.
string
Unique name describing the readiness check.
ResourceSetName This property is required. string

Name describing the resource set that will be monitored for readiness.

The following arguments 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
ReadinessCheckName
This property is required.
Changes to this property will trigger replacement.
string
Unique name describing the readiness check.
ResourceSetName This property is required. string

Name describing the resource set that will be monitored for readiness.

The following arguments 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
readinessCheckName
This property is required.
Changes to this property will trigger replacement.
String
Unique name describing the readiness check.
resourceSetName This property is required. String

Name describing the resource set that will be monitored for readiness.

The following arguments 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
readinessCheckName
This property is required.
Changes to this property will trigger replacement.
string
Unique name describing the readiness check.
resourceSetName This property is required. string

Name describing the resource set that will be monitored for readiness.

The following arguments 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
readiness_check_name
This property is required.
Changes to this property will trigger replacement.
str
Unique name describing the readiness check.
resource_set_name This property is required. str

Name describing the resource set that will be monitored for readiness.

The following arguments 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
readinessCheckName
This property is required.
Changes to this property will trigger replacement.
String
Unique name describing the readiness check.
resourceSetName This property is required. String

Name describing the resource set that will be monitored for readiness.

The following arguments 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

Outputs

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

Arn string
ARN of the readiness_check
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 readiness_check
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 readiness_check
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 readiness_check
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 readiness_check
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 readiness_check
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 ReadinessCheck Resource

Get an existing ReadinessCheck 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?: ReadinessCheckState, opts?: CustomResourceOptions): ReadinessCheck
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        readiness_check_name: Optional[str] = None,
        resource_set_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> ReadinessCheck
func GetReadinessCheck(ctx *Context, name string, id IDInput, state *ReadinessCheckState, opts ...ResourceOption) (*ReadinessCheck, error)
public static ReadinessCheck Get(string name, Input<string> id, ReadinessCheckState? state, CustomResourceOptions? opts = null)
public static ReadinessCheck get(String name, Output<String> id, ReadinessCheckState state, CustomResourceOptions options)
resources:  _:    type: aws:route53recoveryreadiness:ReadinessCheck    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 readiness_check
ReadinessCheckName Changes to this property will trigger replacement. string
Unique name describing the readiness check.
ResourceSetName string

Name describing the resource set that will be monitored for readiness.

The following arguments 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 readiness_check
ReadinessCheckName Changes to this property will trigger replacement. string
Unique name describing the readiness check.
ResourceSetName string

Name describing the resource set that will be monitored for readiness.

The following arguments 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 readiness_check
readinessCheckName Changes to this property will trigger replacement. String
Unique name describing the readiness check.
resourceSetName String

Name describing the resource set that will be monitored for readiness.

The following arguments 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 readiness_check
readinessCheckName Changes to this property will trigger replacement. string
Unique name describing the readiness check.
resourceSetName string

Name describing the resource set that will be monitored for readiness.

The following arguments 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 readiness_check
readiness_check_name Changes to this property will trigger replacement. str
Unique name describing the readiness check.
resource_set_name str

Name describing the resource set that will be monitored for readiness.

The following arguments 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 readiness_check
readinessCheckName Changes to this property will trigger replacement. String
Unique name describing the readiness check.
resourceSetName String

Name describing the resource set that will be monitored for readiness.

The following arguments 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 readiness checks using the readiness check name. For example:

$ pulumi import aws:route53recoveryreadiness/readinessCheck:ReadinessCheck my-cw-alarm-check example
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