Package com.pulumi.aws.rds

Class InstanceDesiredState

  • public class InstanceDesiredState
extends com.pulumi.resources.CustomResource
    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 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import RDS (Relational Database) RDS Instance State using the `identifier`. For example: ```sh $ pulumi import aws:rds/instanceDesiredState:InstanceDesiredState example rds_instance_state-id-12345678 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static InstanceDesiredState get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, InstanceDesiredStateState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> identifier()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> state()  
      com.pulumi.core.Output<java.util.Optional<InstanceDesiredStateTimeouts>> timeouts()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • InstanceDesiredState

        public InstanceDesiredState​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • InstanceDesiredState

        public InstanceDesiredState​(java.lang.String name,
                            InstanceDesiredStateArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • InstanceDesiredState

        public InstanceDesiredState​(java.lang.String name,
                            InstanceDesiredStateArgs args,
                            @Nullable
                            com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • identifier

        public com.pulumi.core.Output<java.lang.String> identifier()
        Returns:
        DB Instance Identifier

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • state

        public com.pulumi.core.Output<java.lang.String> state()
        Returns:
        Configured state of the DB Instance. Valid values are `available` and `stopped`.

      • get

        public static InstanceDesiredState get​(java.lang.String name,
                                       com.pulumi.core.Output<java.lang.String> id,
                                       @Nullable
                                       InstanceDesiredStateState state,
                                       @Nullable
                                       com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.