1. Packages
  2. AWS Classic
  3. API Docs
  4. m2
  5. Environment

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.36.0 published on Wednesday, May 15, 2024 by Pulumi

aws.m2.Environment

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.36.0 published on Wednesday, May 15, 2024 by Pulumi

    Resource for managing an AWS Mainframe Modernization Environment.

    Example Usage

    Basic Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    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.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 test = new Environment("test", EnvironmentArgs.builder()        
                .name("test-env")
                .engineType("bluage")
                .instanceType("M2.m5.large")
                .securityGroups("sg-01234567890abcdef")
                .subnetIds(            
                    "subnet-01234567890abcdef",
                    "subnet-01234567890abcdea")
                .build());
    
        }
    }
    
    resources:
      test:
        type: aws:m2:Environment
        properties:
          name: test-env
          engineType: bluage
          instanceType: M2.m5.large
          securityGroups:
            - sg-01234567890abcdef
          subnetIds:
            - subnet-01234567890abcdef
            - subnet-01234567890abcdea
    

    High Availability

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    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.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 test = new Environment("test", EnvironmentArgs.builder()        
                .name("test-env")
                .engineType("bluage")
                .instanceType("M2.m5.large")
                .securityGroups("sg-01234567890abcdef")
                .subnetIds(            
                    "subnet-01234567890abcdef",
                    "subnet-01234567890abcdea")
                .highAvailabilityConfig(EnvironmentHighAvailabilityConfigArgs.builder()
                    .desiredCapacity(2)
                    .build())
                .build());
    
        }
    }
    
    resources:
      test:
        type: aws:m2:Environment
        properties:
          name: test-env
          engineType: bluage
          instanceType: M2.m5.large
          securityGroups:
            - sg-01234567890abcdef
          subnetIds:
            - subnet-01234567890abcdef
            - subnet-01234567890abcdea
          highAvailabilityConfig:
            desiredCapacity: 2
    

    EFS Filesystem

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    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.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 test = new Environment("test", EnvironmentArgs.builder()        
                .name("test-env")
                .engineType("bluage")
                .instanceType("M2.m5.large")
                .securityGroups("sg-01234567890abcdef")
                .subnetIds(            
                    "subnet-01234567890abcdef",
                    "subnet-01234567890abcdea")
                .storageConfiguration(EnvironmentStorageConfigurationArgs.builder()
                    .efs(EnvironmentStorageConfigurationEfsArgs.builder()
                        .fileSystemId("fs-01234567890abcdef")
                        .mountPoint("/m2/mount/example")
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      test:
        type: aws:m2:Environment
        properties:
          name: test-env
          engineType: bluage
          instanceType: M2.m5.large
          securityGroups:
            - sg-01234567890abcdef
          subnetIds:
            - subnet-01234567890abcdef
            - subnet-01234567890abcdea
          storageConfiguration:
            efs:
              fileSystemId: fs-01234567890abcdef
              mountPoint: /m2/mount/example
    

    FSX Filesystem

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    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.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 test = new Environment("test", EnvironmentArgs.builder()        
                .name("test-env")
                .engineType("bluage")
                .instanceType("M2.m5.large")
                .securityGroups("sg-01234567890abcdef")
                .subnetIds(            
                    "subnet-01234567890abcdef",
                    "subnet-01234567890abcdea")
                .storageConfiguration(EnvironmentStorageConfigurationArgs.builder()
                    .fsx(EnvironmentStorageConfigurationFsxArgs.builder()
                        .fileSystemId("fs-01234567890abcdef")
                        .mountPoint("/m2/mount/example")
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      test:
        type: aws:m2:Environment
        properties:
          name: test-env
          engineType: bluage
          instanceType: M2.m5.large
          securityGroups:
            - sg-01234567890abcdef
          subnetIds:
            - subnet-01234567890abcdef
            - subnet-01234567890abcdea
          storageConfiguration:
            fsx:
              fileSystemId: fs-01234567890abcdef
              mountPoint: /m2/mount/example
    

    Create Environment Resource

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

    Constructor syntax

    new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);
    @overload
    def Environment(resource_name: str,
                    args: EnvironmentArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def Environment(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    engine_type: Optional[str] = None,
                    instance_type: Optional[str] = None,
                    name: Optional[str] = None,
                    preferred_maintenance_window: Optional[str] = None,
                    force_update: Optional[bool] = None,
                    high_availability_config: Optional[EnvironmentHighAvailabilityConfigArgs] = None,
                    description: Optional[str] = None,
                    kms_key_id: Optional[str] = None,
                    apply_changes_during_maintenance_window: Optional[bool] = None,
                    engine_version: Optional[str] = None,
                    publicly_accessible: Optional[bool] = None,
                    security_group_ids: Optional[Sequence[str]] = None,
                    storage_configuration: Optional[EnvironmentStorageConfigurationArgs] = None,
                    subnet_ids: Optional[Sequence[str]] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    timeouts: Optional[EnvironmentTimeoutsArgs] = None)
    func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
    public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)
    public Environment(String name, EnvironmentArgs args)
    public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)
    
    type: aws:m2:Environment
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var exampleenvironmentResourceResourceFromM2environment = new Aws.M2.Environment("exampleenvironmentResourceResourceFromM2environment", new()
    {
        EngineType = "string",
        InstanceType = "string",
        Name = "string",
        PreferredMaintenanceWindow = "string",
        ForceUpdate = false,
        HighAvailabilityConfig = new Aws.M2.Inputs.EnvironmentHighAvailabilityConfigArgs
        {
            DesiredCapacity = 0,
        },
        Description = "string",
        KmsKeyId = "string",
        ApplyChangesDuringMaintenanceWindow = false,
        EngineVersion = "string",
        PubliclyAccessible = false,
        SecurityGroupIds = new[]
        {
            "string",
        },
        StorageConfiguration = new Aws.M2.Inputs.EnvironmentStorageConfigurationArgs
        {
            Efs = new Aws.M2.Inputs.EnvironmentStorageConfigurationEfsArgs
            {
                FileSystemId = "string",
                MountPoint = "string",
            },
            Fsx = new Aws.M2.Inputs.EnvironmentStorageConfigurationFsxArgs
            {
                FileSystemId = "string",
                MountPoint = "string",
            },
        },
        SubnetIds = new[]
        {
            "string",
        },
        Tags = 
        {
            { "string", "string" },
        },
        Timeouts = new Aws.M2.Inputs.EnvironmentTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Update = "string",
        },
    });
    
    example, err := m2.NewEnvironment(ctx, "exampleenvironmentResourceResourceFromM2environment", &m2.EnvironmentArgs{
    	EngineType:                 pulumi.String("string"),
    	InstanceType:               pulumi.String("string"),
    	Name:                       pulumi.String("string"),
    	PreferredMaintenanceWindow: pulumi.String("string"),
    	ForceUpdate:                pulumi.Bool(false),
    	HighAvailabilityConfig: &m2.EnvironmentHighAvailabilityConfigArgs{
    		DesiredCapacity: pulumi.Int(0),
    	},
    	Description:                         pulumi.String("string"),
    	KmsKeyId:                            pulumi.String("string"),
    	ApplyChangesDuringMaintenanceWindow: pulumi.Bool(false),
    	EngineVersion:                       pulumi.String("string"),
    	PubliclyAccessible:                  pulumi.Bool(false),
    	SecurityGroupIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	StorageConfiguration: &m2.EnvironmentStorageConfigurationArgs{
    		Efs: &m2.EnvironmentStorageConfigurationEfsArgs{
    			FileSystemId: pulumi.String("string"),
    			MountPoint:   pulumi.String("string"),
    		},
    		Fsx: &m2.EnvironmentStorageConfigurationFsxArgs{
    			FileSystemId: pulumi.String("string"),
    			MountPoint:   pulumi.String("string"),
    		},
    	},
    	SubnetIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Timeouts: &m2.EnvironmentTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    })
    
    var exampleenvironmentResourceResourceFromM2environment = new Environment("exampleenvironmentResourceResourceFromM2environment", EnvironmentArgs.builder()        
        .engineType("string")
        .instanceType("string")
        .name("string")
        .preferredMaintenanceWindow("string")
        .forceUpdate(false)
        .highAvailabilityConfig(EnvironmentHighAvailabilityConfigArgs.builder()
            .desiredCapacity(0)
            .build())
        .description("string")
        .kmsKeyId("string")
        .applyChangesDuringMaintenanceWindow(false)
        .engineVersion("string")
        .publiclyAccessible(false)
        .securityGroupIds("string")
        .storageConfiguration(EnvironmentStorageConfigurationArgs.builder()
            .efs(EnvironmentStorageConfigurationEfsArgs.builder()
                .fileSystemId("string")
                .mountPoint("string")
                .build())
            .fsx(EnvironmentStorageConfigurationFsxArgs.builder()
                .fileSystemId("string")
                .mountPoint("string")
                .build())
            .build())
        .subnetIds("string")
        .tags(Map.of("string", "string"))
        .timeouts(EnvironmentTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .update("string")
            .build())
        .build());
    
    exampleenvironment_resource_resource_from_m2environment = aws.m2.Environment("exampleenvironmentResourceResourceFromM2environment",
        engine_type="string",
        instance_type="string",
        name="string",
        preferred_maintenance_window="string",
        force_update=False,
        high_availability_config=aws.m2.EnvironmentHighAvailabilityConfigArgs(
            desired_capacity=0,
        ),
        description="string",
        kms_key_id="string",
        apply_changes_during_maintenance_window=False,
        engine_version="string",
        publicly_accessible=False,
        security_group_ids=["string"],
        storage_configuration=aws.m2.EnvironmentStorageConfigurationArgs(
            efs=aws.m2.EnvironmentStorageConfigurationEfsArgs(
                file_system_id="string",
                mount_point="string",
            ),
            fsx=aws.m2.EnvironmentStorageConfigurationFsxArgs(
                file_system_id="string",
                mount_point="string",
            ),
        ),
        subnet_ids=["string"],
        tags={
            "string": "string",
        },
        timeouts=aws.m2.EnvironmentTimeoutsArgs(
            create="string",
            delete="string",
            update="string",
        ))
    
    const exampleenvironmentResourceResourceFromM2environment = new aws.m2.Environment("exampleenvironmentResourceResourceFromM2environment", {
        engineType: "string",
        instanceType: "string",
        name: "string",
        preferredMaintenanceWindow: "string",
        forceUpdate: false,
        highAvailabilityConfig: {
            desiredCapacity: 0,
        },
        description: "string",
        kmsKeyId: "string",
        applyChangesDuringMaintenanceWindow: false,
        engineVersion: "string",
        publiclyAccessible: false,
        securityGroupIds: ["string"],
        storageConfiguration: {
            efs: {
                fileSystemId: "string",
                mountPoint: "string",
            },
            fsx: {
                fileSystemId: "string",
                mountPoint: "string",
            },
        },
        subnetIds: ["string"],
        tags: {
            string: "string",
        },
        timeouts: {
            create: "string",
            "delete": "string",
            update: "string",
        },
    });
    
    type: aws:m2:Environment
    properties:
        applyChangesDuringMaintenanceWindow: false
        description: string
        engineType: string
        engineVersion: string
        forceUpdate: false
        highAvailabilityConfig:
            desiredCapacity: 0
        instanceType: string
        kmsKeyId: string
        name: string
        preferredMaintenanceWindow: string
        publiclyAccessible: false
        securityGroupIds:
            - string
        storageConfiguration:
            efs:
                fileSystemId: string
                mountPoint: string
            fsx:
                fileSystemId: string
                mountPoint: string
        subnetIds:
            - string
        tags:
            string: string
        timeouts:
            create: string
            delete: string
            update: string
    

    Environment Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Environment resource accepts the following input properties:

    EngineType string
    Engine type must be microfocus or bluage.
    InstanceType string

    M2 Instance Type.

    The following arguments are optional:

    ApplyChangesDuringMaintenanceWindow bool
    Description string
    EngineVersion string
    The specific version of the engine for the Environment.
    ForceUpdate bool
    Force update the environment even if applications are running.
    HighAvailabilityConfig EnvironmentHighAvailabilityConfig
    KmsKeyId string
    ARN of the KMS key to use for the Environment.
    Name string
    Name of the runtime environment. Must be unique within the account.
    PreferredMaintenanceWindow string
    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 bool
    Allow applications deployed to this environment to be publicly accessible.
    SecurityGroupIds List<string>
    List of security group ids.
    StorageConfiguration EnvironmentStorageConfiguration
    SubnetIds List<string>
    List of subnet ids to deploy environment to.
    Tags Dictionary<string, string>
    Key-value tags for the place index. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts EnvironmentTimeouts
    EngineType string
    Engine type must be microfocus or bluage.
    InstanceType string

    M2 Instance Type.

    The following arguments are optional:

    ApplyChangesDuringMaintenanceWindow bool
    Description string
    EngineVersion string
    The specific version of the engine for the Environment.
    ForceUpdate bool
    Force update the environment even if applications are running.
    HighAvailabilityConfig EnvironmentHighAvailabilityConfigArgs
    KmsKeyId string
    ARN of the KMS key to use for the Environment.
    Name string
    Name of the runtime environment. Must be unique within the account.
    PreferredMaintenanceWindow string
    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 bool
    Allow applications deployed to this environment to be publicly accessible.
    SecurityGroupIds []string
    List of security group ids.
    StorageConfiguration EnvironmentStorageConfigurationArgs
    SubnetIds []string
    List of subnet ids to deploy environment to.
    Tags map[string]string
    Key-value tags for the place index. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts EnvironmentTimeoutsArgs
    engineType String
    Engine type must be microfocus or bluage.
    instanceType String

    M2 Instance Type.

    The following arguments are optional:

    applyChangesDuringMaintenanceWindow Boolean
    description String
    engineVersion String
    The specific version of the engine for the Environment.
    forceUpdate Boolean
    Force update the environment even if applications are running.
    highAvailabilityConfig EnvironmentHighAvailabilityConfig
    kmsKeyId String
    ARN of the KMS key to use for the Environment.
    name String
    Name of the runtime environment. Must be unique within the account.
    preferredMaintenanceWindow String
    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 Boolean
    Allow applications deployed to this environment to be publicly accessible.
    securityGroupIds List<String>
    List of security group ids.
    storageConfiguration EnvironmentStorageConfiguration
    subnetIds List<String>
    List of subnet ids to deploy environment to.
    tags Map<String,String>
    Key-value tags for the place index. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts EnvironmentTimeouts
    engineType string
    Engine type must be microfocus or bluage.
    instanceType string

    M2 Instance Type.

    The following arguments are optional:

    applyChangesDuringMaintenanceWindow boolean
    description string
    engineVersion string
    The specific version of the engine for the Environment.
    forceUpdate boolean
    Force update the environment even if applications are running.
    highAvailabilityConfig EnvironmentHighAvailabilityConfig
    kmsKeyId string
    ARN of the KMS key to use for the Environment.
    name string
    Name of the runtime environment. Must be unique within the account.
    preferredMaintenanceWindow string
    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 boolean
    Allow applications deployed to this environment to be publicly accessible.
    securityGroupIds string[]
    List of security group ids.
    storageConfiguration EnvironmentStorageConfiguration
    subnetIds string[]
    List of subnet ids to deploy environment to.
    tags {[key: string]: string}
    Key-value tags for the place index. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts EnvironmentTimeouts
    engine_type str
    Engine type must be microfocus or bluage.
    instance_type str

    M2 Instance Type.

    The following arguments are optional:

    apply_changes_during_maintenance_window bool
    description str
    engine_version str
    The specific version of the engine for the Environment.
    force_update bool
    Force update the environment even if applications are running.
    high_availability_config EnvironmentHighAvailabilityConfigArgs
    kms_key_id str
    ARN of the KMS key to use for the Environment.
    name str
    Name of the runtime environment. Must be unique within the account.
    preferred_maintenance_window str
    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.
    publicly_accessible bool
    Allow applications deployed to this environment to be publicly accessible.
    security_group_ids Sequence[str]
    List of security group ids.
    storage_configuration EnvironmentStorageConfigurationArgs
    subnet_ids Sequence[str]
    List of subnet ids to deploy environment to.
    tags Mapping[str, str]
    Key-value tags for the place index. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts EnvironmentTimeoutsArgs
    engineType String
    Engine type must be microfocus or bluage.
    instanceType String

    M2 Instance Type.

    The following arguments are optional:

    applyChangesDuringMaintenanceWindow Boolean
    description String
    engineVersion String
    The specific version of the engine for the Environment.
    forceUpdate Boolean
    Force update the environment even if applications are running.
    highAvailabilityConfig Property Map
    kmsKeyId String
    ARN of the KMS key to use for the Environment.
    name String
    Name of the runtime environment. Must be unique within the account.
    preferredMaintenanceWindow String
    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 Boolean
    Allow applications deployed to this environment to be publicly accessible.
    securityGroupIds List<String>
    List of security group ids.
    storageConfiguration Property Map
    subnetIds List<String>
    List of subnet ids to deploy environment to.
    tags Map<String>
    Key-value tags for the place index. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts Property Map

    Outputs

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

    Arn string
    ARN of the Environment.
    EnvironmentId string
    The id of the Environment.
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancerArn string
    ARN of the load balancer created by the Environment.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Environment.
    EnvironmentId string
    The id of the Environment.
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancerArn string
    ARN of the load balancer created by the Environment.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    arn String
    ARN of the Environment.
    environmentId String
    The id of the Environment.
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancerArn String
    ARN of the load balancer created by the Environment.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    arn string
    ARN of the Environment.
    environmentId string
    The id of the Environment.
    id string
    The provider-assigned unique ID for this managed resource.
    loadBalancerArn string
    ARN of the load balancer created by the Environment.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    arn str
    ARN of the Environment.
    environment_id str
    The id of the Environment.
    id str
    The provider-assigned unique ID for this managed resource.
    load_balancer_arn str
    ARN of the load balancer created by the Environment.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    arn String
    ARN of the Environment.
    environmentId String
    The id of the Environment.
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancerArn String
    ARN of the load balancer created by the Environment.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    Look up Existing Environment Resource

    Get an existing Environment 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?: EnvironmentState, opts?: CustomResourceOptions): Environment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            apply_changes_during_maintenance_window: Optional[bool] = None,
            arn: Optional[str] = None,
            description: Optional[str] = None,
            engine_type: Optional[str] = None,
            engine_version: Optional[str] = None,
            environment_id: Optional[str] = None,
            force_update: Optional[bool] = None,
            high_availability_config: Optional[EnvironmentHighAvailabilityConfigArgs] = None,
            instance_type: Optional[str] = None,
            kms_key_id: Optional[str] = None,
            load_balancer_arn: Optional[str] = None,
            name: Optional[str] = None,
            preferred_maintenance_window: Optional[str] = None,
            publicly_accessible: Optional[bool] = None,
            security_group_ids: Optional[Sequence[str]] = None,
            storage_configuration: Optional[EnvironmentStorageConfigurationArgs] = None,
            subnet_ids: Optional[Sequence[str]] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            timeouts: Optional[EnvironmentTimeoutsArgs] = None) -> Environment
    func GetEnvironment(ctx *Context, name string, id IDInput, state *EnvironmentState, opts ...ResourceOption) (*Environment, error)
    public static Environment Get(string name, Input<string> id, EnvironmentState? state, CustomResourceOptions? opts = null)
    public static Environment get(String name, Output<String> id, EnvironmentState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    ApplyChangesDuringMaintenanceWindow bool
    Arn string
    ARN of the Environment.
    Description string
    EngineType string
    Engine type must be microfocus or bluage.
    EngineVersion string
    The specific version of the engine for the Environment.
    EnvironmentId string
    The id of the Environment.
    ForceUpdate bool
    Force update the environment even if applications are running.
    HighAvailabilityConfig EnvironmentHighAvailabilityConfig
    InstanceType string

    M2 Instance Type.

    The following arguments are optional:

    KmsKeyId string
    ARN of the KMS key to use for the Environment.
    LoadBalancerArn string
    ARN of the load balancer created by the Environment.
    Name string
    Name of the runtime environment. Must be unique within the account.
    PreferredMaintenanceWindow string
    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 bool
    Allow applications deployed to this environment to be publicly accessible.
    SecurityGroupIds List<string>
    List of security group ids.
    StorageConfiguration EnvironmentStorageConfiguration
    SubnetIds List<string>
    List of subnet ids to deploy environment to.
    Tags Dictionary<string, string>
    Key-value tags for the place index. 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>

    Deprecated: Please use tags instead.

    Timeouts EnvironmentTimeouts
    ApplyChangesDuringMaintenanceWindow bool
    Arn string
    ARN of the Environment.
    Description string
    EngineType string
    Engine type must be microfocus or bluage.
    EngineVersion string
    The specific version of the engine for the Environment.
    EnvironmentId string
    The id of the Environment.
    ForceUpdate bool
    Force update the environment even if applications are running.
    HighAvailabilityConfig EnvironmentHighAvailabilityConfigArgs
    InstanceType string

    M2 Instance Type.

    The following arguments are optional:

    KmsKeyId string
    ARN of the KMS key to use for the Environment.
    LoadBalancerArn string
    ARN of the load balancer created by the Environment.
    Name string
    Name of the runtime environment. Must be unique within the account.
    PreferredMaintenanceWindow string
    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 bool
    Allow applications deployed to this environment to be publicly accessible.
    SecurityGroupIds []string
    List of security group ids.
    StorageConfiguration EnvironmentStorageConfigurationArgs
    SubnetIds []string
    List of subnet ids to deploy environment to.
    Tags map[string]string
    Key-value tags for the place index. 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

    Deprecated: Please use tags instead.

    Timeouts EnvironmentTimeoutsArgs
    applyChangesDuringMaintenanceWindow Boolean
    arn String
    ARN of the Environment.
    description String
    engineType String
    Engine type must be microfocus or bluage.
    engineVersion String
    The specific version of the engine for the Environment.
    environmentId String
    The id of the Environment.
    forceUpdate Boolean
    Force update the environment even if applications are running.
    highAvailabilityConfig EnvironmentHighAvailabilityConfig
    instanceType String

    M2 Instance Type.

    The following arguments are optional:

    kmsKeyId String
    ARN of the KMS key to use for the Environment.
    loadBalancerArn String
    ARN of the load balancer created by the Environment.
    name String
    Name of the runtime environment. Must be unique within the account.
    preferredMaintenanceWindow String
    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 Boolean
    Allow applications deployed to this environment to be publicly accessible.
    securityGroupIds List<String>
    List of security group ids.
    storageConfiguration EnvironmentStorageConfiguration
    subnetIds List<String>
    List of subnet ids to deploy environment to.
    tags Map<String,String>
    Key-value tags for the place index. 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>

    Deprecated: Please use tags instead.

    timeouts EnvironmentTimeouts
    applyChangesDuringMaintenanceWindow boolean
    arn string
    ARN of the Environment.
    description string
    engineType string
    Engine type must be microfocus or bluage.
    engineVersion string
    The specific version of the engine for the Environment.
    environmentId string
    The id of the Environment.
    forceUpdate boolean
    Force update the environment even if applications are running.
    highAvailabilityConfig EnvironmentHighAvailabilityConfig
    instanceType string

    M2 Instance Type.

    The following arguments are optional:

    kmsKeyId string
    ARN of the KMS key to use for the Environment.
    loadBalancerArn string
    ARN of the load balancer created by the Environment.
    name string
    Name of the runtime environment. Must be unique within the account.
    preferredMaintenanceWindow string
    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 boolean
    Allow applications deployed to this environment to be publicly accessible.
    securityGroupIds string[]
    List of security group ids.
    storageConfiguration EnvironmentStorageConfiguration
    subnetIds string[]
    List of subnet ids to deploy environment to.
    tags {[key: string]: string}
    Key-value tags for the place index. 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}

    Deprecated: Please use tags instead.

    timeouts EnvironmentTimeouts
    apply_changes_during_maintenance_window bool
    arn str
    ARN of the Environment.
    description str
    engine_type str
    Engine type must be microfocus or bluage.
    engine_version str
    The specific version of the engine for the Environment.
    environment_id str
    The id of the Environment.
    force_update bool
    Force update the environment even if applications are running.
    high_availability_config EnvironmentHighAvailabilityConfigArgs
    instance_type str

    M2 Instance Type.

    The following arguments are optional:

    kms_key_id str
    ARN of the KMS key to use for the Environment.
    load_balancer_arn str
    ARN of the load balancer created by the Environment.
    name str
    Name of the runtime environment. Must be unique within the account.
    preferred_maintenance_window str
    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.
    publicly_accessible bool
    Allow applications deployed to this environment to be publicly accessible.
    security_group_ids Sequence[str]
    List of security group ids.
    storage_configuration EnvironmentStorageConfigurationArgs
    subnet_ids Sequence[str]
    List of subnet ids to deploy environment to.
    tags Mapping[str, str]
    Key-value tags for the place index. 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]

    Deprecated: Please use tags instead.

    timeouts EnvironmentTimeoutsArgs
    applyChangesDuringMaintenanceWindow Boolean
    arn String
    ARN of the Environment.
    description String
    engineType String
    Engine type must be microfocus or bluage.
    engineVersion String
    The specific version of the engine for the Environment.
    environmentId String
    The id of the Environment.
    forceUpdate Boolean
    Force update the environment even if applications are running.
    highAvailabilityConfig Property Map
    instanceType String

    M2 Instance Type.

    The following arguments are optional:

    kmsKeyId String
    ARN of the KMS key to use for the Environment.
    loadBalancerArn String
    ARN of the load balancer created by the Environment.
    name String
    Name of the runtime environment. Must be unique within the account.
    preferredMaintenanceWindow String
    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 Boolean
    Allow applications deployed to this environment to be publicly accessible.
    securityGroupIds List<String>
    List of security group ids.
    storageConfiguration Property Map
    subnetIds List<String>
    List of subnet ids to deploy environment to.
    tags Map<String>
    Key-value tags for the place index. 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>

    Deprecated: Please use tags instead.

    timeouts Property Map

    Supporting Types

    EnvironmentHighAvailabilityConfig, EnvironmentHighAvailabilityConfigArgs

    DesiredCapacity int
    Desired number of instances for the Environment.
    DesiredCapacity int
    Desired number of instances for the Environment.
    desiredCapacity Integer
    Desired number of instances for the Environment.
    desiredCapacity number
    Desired number of instances for the Environment.
    desired_capacity int
    Desired number of instances for the Environment.
    desiredCapacity Number
    Desired number of instances for the Environment.

    EnvironmentStorageConfiguration, EnvironmentStorageConfigurationArgs

    EnvironmentStorageConfigurationEfs, EnvironmentStorageConfigurationEfsArgs

    FileSystemId string
    Id of the EFS filesystem to mount.
    MountPoint string
    Path to mount the filesystem on, must start with /m2/mount/.
    FileSystemId string
    Id of the EFS filesystem to mount.
    MountPoint string
    Path to mount the filesystem on, must start with /m2/mount/.
    fileSystemId String
    Id of the EFS filesystem to mount.
    mountPoint String
    Path to mount the filesystem on, must start with /m2/mount/.
    fileSystemId string
    Id of the EFS filesystem to mount.
    mountPoint string
    Path to mount the filesystem on, must start with /m2/mount/.
    file_system_id str
    Id of the EFS filesystem to mount.
    mount_point str
    Path to mount the filesystem on, must start with /m2/mount/.
    fileSystemId String
    Id of the EFS filesystem to mount.
    mountPoint String
    Path to mount the filesystem on, must start with /m2/mount/.

    EnvironmentStorageConfigurationFsx, EnvironmentStorageConfigurationFsxArgs

    FileSystemId string
    Id of the FSX filesystem to mount.
    MountPoint string
    Path to mount the filesystem on, must start with /m2/mount/.
    FileSystemId string
    Id of the FSX filesystem to mount.
    MountPoint string
    Path to mount the filesystem on, must start with /m2/mount/.
    fileSystemId String
    Id of the FSX filesystem to mount.
    mountPoint String
    Path to mount the filesystem on, must start with /m2/mount/.
    fileSystemId string
    Id of the FSX filesystem to mount.
    mountPoint string
    Path to mount the filesystem on, must start with /m2/mount/.
    file_system_id str
    Id of the FSX filesystem to mount.
    mount_point str
    Path to mount the filesystem on, must start with /m2/mount/.
    fileSystemId String
    Id of the FSX filesystem to mount.
    mountPoint String
    Path to mount the filesystem on, must start with /m2/mount/.

    EnvironmentTimeouts, EnvironmentTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

    Using pulumi import, import Mainframe Modernization Environment using the 01234567890abcdef012345678. For example:

    $ pulumi import aws:m2/environment:Environment example 01234567890abcdef012345678
    

    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 logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.36.0 published on Wednesday, May 15, 2024 by Pulumi