InstanceDesiredState class
Resource for managing an AWS RDS (Relational Database) RDS Instance State.
> Destruction of this resource is a no-op and will not modify the instance state
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.rds.InstanceDesiredState("test", {
identifier: testAwsDbInstance.identifier,
state: "available",
});
import pulumi
import pulumi_aws as aws
test = aws.rds.InstanceDesiredState("test",
identifier=test_aws_db_instance["identifier"],
state="available")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.Rds.InstanceDesiredState("test", new()
{
Identifier = testAwsDbInstance.Identifier,
State = "available",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/rds"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rds.NewInstanceDesiredState(ctx, "test", &rds.InstanceDesiredStateArgs{
Identifier: pulumi.Any(testAwsDbInstance.Identifier),
State: pulumi.String("available"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_rds_instancedesiredstate" "test" {
identifier = testAwsDbInstance.identifier
state = "available"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.InstanceDesiredState;
import com.pulumi.aws.rds.InstanceDesiredStateArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 InstanceDesiredState("test", InstanceDesiredStateArgs.builder()
.identifier(testAwsDbInstance.identifier())
.state("available")
.build());
}
}
resources:
test:
type: aws:rds:InstanceDesiredState
properties:
identifier: ${testAwsDbInstance.identifier}
state: available
Import
Using pulumi import, import RDS (Relational Database) RDS Instance State using the identifier. For example:
$ pulumi import aws:rds/instanceDesiredState:InstanceDesiredState example rds_instance_state-id-12345678
Constructors
- InstanceDesiredState(String name, {InstanceDesiredStateArgs? args, CustomResourceOptions? options})
-
Creates a new InstanceDesiredState.
nameThe Pulumi resource name.argsArguments used to configure this InstanceDesiredState. The set of arguments for InstanceDesiredState.optionsResource options controlling this resource's behavior. - InstanceDesiredState.reference(String urn)
- Creates a typed reference to an existing InstanceDesiredState resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
identifier
↔ Output<
String> -
DB Instance Identifier
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
state
↔ Output<
String> -
Configured state of the DB Instance. Valid values are
availableandstopped.latefinal -
timeouts
↔ Output<
InstanceDesiredStateTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {InstanceDesiredStateState? state, CustomResourceOptions? options}) → InstanceDesiredState -
Gets an existing InstanceDesiredState resource's state with the given
nameandid.