Package com.pulumi.aws.m2

Class Environment

  • public class Environment
extends com.pulumi.resources.CustomResource
    Resource for managing an [AWS Mainframe Modernization Environment](https://docs.aws.amazon.com/m2/latest/userguide/environments-m2.html). ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.m2.Environment;
 import com.pulumi.aws.m2.EnvironmentArgs;
 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 Environment("test", EnvironmentArgs.builder()
             .name("test-env")
             .engineType("bluage")
             .instanceType("M2.m5.large")
             .securityGroups(Arrays.asList("sg-01234567890abcdef"))
             .subnetIds(            
                 "subnet-01234567890abcdef",
                 "subnet-01234567890abcdea")
             .build());
 
     }
 }
    ### High Availability 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.m2.Environment;
 import com.pulumi.aws.m2.EnvironmentArgs;
 import com.pulumi.aws.m2.inputs.EnvironmentHighAvailabilityConfigArgs;
 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 Environment("test", EnvironmentArgs.builder()
             .highAvailabilityConfig(EnvironmentHighAvailabilityConfigArgs.builder()
                 .desiredCapacity(2)
                 .build())
             .name("test-env")
             .engineType("bluage")
             .instanceType("M2.m5.large")
             .securityGroups(Arrays.asList("sg-01234567890abcdef"))
             .subnetIds(            
                 "subnet-01234567890abcdef",
                 "subnet-01234567890abcdea")
             .build());
 
     }
 }
    ### EFS Filesystem 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.m2.Environment;
 import com.pulumi.aws.m2.EnvironmentArgs;
 import com.pulumi.aws.m2.inputs.EnvironmentStorageConfigurationArgs;
 import com.pulumi.aws.m2.inputs.EnvironmentStorageConfigurationEfsArgs;
 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 Environment("test", EnvironmentArgs.builder()
             .storageConfiguration(EnvironmentStorageConfigurationArgs.builder()
                 .efs(EnvironmentStorageConfigurationEfsArgs.builder()
                     .fileSystemId("fs-01234567890abcdef")
                     .mountPoint("/m2/mount/example")
                     .build())
                 .build())
             .name("test-env")
             .engineType("bluage")
             .instanceType("M2.m5.large")
             .securityGroups(Arrays.asList("sg-01234567890abcdef"))
             .subnetIds(            
                 "subnet-01234567890abcdef",
                 "subnet-01234567890abcdea")
             .build());
 
     }
 }
    ### FSx Filesystem 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.m2.Environment;
 import com.pulumi.aws.m2.EnvironmentArgs;
 import com.pulumi.aws.m2.inputs.EnvironmentStorageConfigurationArgs;
 import com.pulumi.aws.m2.inputs.EnvironmentStorageConfigurationFsxArgs;
 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 Environment("test", EnvironmentArgs.builder()
             .storageConfiguration(EnvironmentStorageConfigurationArgs.builder()
                 .fsx(EnvironmentStorageConfigurationFsxArgs.builder()
                     .fileSystemId("fs-01234567890abcdef")
                     .mountPoint("/m2/mount/example")
                     .build())
                 .build())
             .name("test-env")
             .engineType("bluage")
             .instanceType("M2.m5.large")
             .securityGroups(Arrays.asList("sg-01234567890abcdef"))
             .subnetIds(            
                 "subnet-01234567890abcdef",
                 "subnet-01234567890abcdea")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Mainframe Modernization Environment using the `01234567890abcdef012345678`. For example: ```sh $ pulumi import aws:m2/environment:Environment example 01234567890abcdef012345678 ```

    • 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
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> applyChangesDuringMaintenanceWindow()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.String> engineType()  
      com.pulumi.core.Output<java.lang.String> engineVersion()  
      com.pulumi.core.Output<java.lang.String> environmentId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> forceUpdate()  
      static Environment get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, EnvironmentState 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.util.Optional<EnvironmentHighAvailabilityConfig>> highAvailabilityConfig()  
      com.pulumi.core.Output<java.lang.String> instanceType()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKeyId()  
      com.pulumi.core.Output<java.lang.String> loadBalancerArn()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> preferredMaintenanceWindow()  
      com.pulumi.core.Output<java.lang.Boolean> publiclyAccessible()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> securityGroupIds()  
      com.pulumi.core.Output<java.util.Optional<EnvironmentStorageConfiguration>> storageConfiguration()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> subnetIds()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<EnvironmentTimeouts>> 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

      • Environment

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

      • Environment

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

      • Environment

        public Environment​(java.lang.String name,
                   EnvironmentArgs 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

      • applyChangesDuringMaintenanceWindow

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> applyChangesDuringMaintenanceWindow()
        Returns:
        Whether to apply configuration changes during the preferred maintenance window instead of immediately.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the Environment.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the runtime environment.

      • engineType

        public com.pulumi.core.Output<java.lang.String> engineType()
        Returns:
        Engine type must be `microfocus` or `bluage`.

      • engineVersion

        public com.pulumi.core.Output<java.lang.String> engineVersion()
        Returns:
        Specific version of the engine for the Environment.

      • environmentId

        public com.pulumi.core.Output<java.lang.String> environmentId()
        Returns:
        ID of the Environment.

      • forceUpdate

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> forceUpdate()
        Returns:
        Force update the environment even if applications are running.

      • instanceType

        public com.pulumi.core.Output<java.lang.String> instanceType()
        Returns:
        M2 Instance Type.

      • kmsKeyId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKeyId()
        Returns:
        ARN of the KMS key to use for the Environment.

      • loadBalancerArn

        public com.pulumi.core.Output<java.lang.String> loadBalancerArn()
        Returns:
        ARN of the load balancer created by the Environment.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the runtime environment. Must be unique within the account. The following arguments are optional:

      • preferredMaintenanceWindow

        public com.pulumi.core.Output<java.lang.String> preferredMaintenanceWindow()
        Returns:
        Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format `ddd:hh24:mi-ddd:hh24:mi` and must be less than 24 hours. If not provided a random value will be used.

      • publiclyAccessible

        public com.pulumi.core.Output<java.lang.Boolean> publiclyAccessible()
        Returns:
        Allow applications deployed to this environment to be publicly accessible.

      • 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.

      • securityGroupIds

        public com.pulumi.core.Output<java.util.List<java.lang.String>> securityGroupIds()
        Returns:
        List of security group IDs.

      • subnetIds

        public com.pulumi.core.Output<java.util.List<java.lang.String>> subnetIds()
        Returns:
        List of subnet IDs to deploy environment to.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value tags for the place index. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()

      • get

        public static Environment get​(java.lang.String name,
                              com.pulumi.core.Output<java.lang.String> id,
                              @Nullable
                              EnvironmentState 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.