Class KxEnvironment


  • public class KxEnvironment
    extends com.pulumi.resources.CustomResource
    Resource for managing an AWS FinSpace Kx Environment. ## Example Usage ### Basic Usage
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.kms.Key;
     import com.pulumi.aws.kms.KeyArgs;
     import com.pulumi.aws.finspace.KxEnvironment;
     import com.pulumi.aws.finspace.KxEnvironmentArgs;
     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 example = new Key("example", KeyArgs.builder()
                 .description("Sample KMS Key")
                 .deletionWindowInDays(7)
                 .build());
     
             var exampleKxEnvironment = new KxEnvironment("exampleKxEnvironment", KxEnvironmentArgs.builder()
                 .name("my-tf-kx-environment")
                 .kmsKeyId(example.arn())
                 .build());
     
         }
     }
     
     
    ### With Transit Gateway Configuration
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.kms.Key;
     import com.pulumi.aws.kms.KeyArgs;
     import com.pulumi.aws.ec2transitgateway.TransitGateway;
     import com.pulumi.aws.ec2transitgateway.TransitGatewayArgs;
     import com.pulumi.aws.finspace.KxEnvironment;
     import com.pulumi.aws.finspace.KxEnvironmentArgs;
     import com.pulumi.aws.finspace.inputs.KxEnvironmentTransitGatewayConfigurationArgs;
     import com.pulumi.aws.finspace.inputs.KxEnvironmentCustomDnsConfigurationArgs;
     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 example = new Key("example", KeyArgs.builder()
                 .description("Sample KMS Key")
                 .deletionWindowInDays(7)
                 .build());
     
             var exampleTransitGateway = new TransitGateway("exampleTransitGateway", TransitGatewayArgs.builder()
                 .description("example")
                 .build());
     
             var exampleEnv = new KxEnvironment("exampleEnv", KxEnvironmentArgs.builder()
                 .transitGatewayConfiguration(KxEnvironmentTransitGatewayConfigurationArgs.builder()
                     .transitGatewayId(exampleTransitGateway.id())
                     .routableCidrSpace("100.64.0.0/26")
                     .build())
                 .customDnsConfigurations(KxEnvironmentCustomDnsConfigurationArgs.builder()
                     .customDnsServerName("example.finspace.amazonaws.com")
                     .customDnsServerIp("10.0.0.76")
                     .build())
                 .name("my-tf-kx-environment")
                 .description("Environment description")
                 .kmsKeyId(example.arn())
                 .build());
     
         }
     }
     
     
    ### With Transit Gateway Attachment Network ACL Configuration
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.kms.Key;
     import com.pulumi.aws.kms.KeyArgs;
     import com.pulumi.aws.ec2transitgateway.TransitGateway;
     import com.pulumi.aws.ec2transitgateway.TransitGatewayArgs;
     import com.pulumi.aws.finspace.KxEnvironment;
     import com.pulumi.aws.finspace.KxEnvironmentArgs;
     import com.pulumi.aws.finspace.inputs.KxEnvironmentTransitGatewayConfigurationArgs;
     import com.pulumi.aws.finspace.inputs.KxEnvironmentTransitGatewayConfigurationAttachmentNetworkAclConfigurationArgs;
     import com.pulumi.aws.finspace.inputs.KxEnvironmentTransitGatewayConfigurationAttachmentNetworkAclConfigurationPortRangeArgs;
     import com.pulumi.aws.finspace.inputs.KxEnvironmentTransitGatewayConfigurationAttachmentNetworkAclConfigurationIcmpTypeCodeArgs;
     import com.pulumi.aws.finspace.inputs.KxEnvironmentCustomDnsConfigurationArgs;
     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 example = new Key("example", KeyArgs.builder()
                 .description("Sample KMS Key")
                 .deletionWindowInDays(7)
                 .build());
     
             var exampleTransitGateway = new TransitGateway("exampleTransitGateway", TransitGatewayArgs.builder()
                 .description("example")
                 .build());
     
             var exampleEnv = new KxEnvironment("exampleEnv", KxEnvironmentArgs.builder()
                 .transitGatewayConfiguration(KxEnvironmentTransitGatewayConfigurationArgs.builder()
                     .attachmentNetworkAclConfigurations(KxEnvironmentTransitGatewayConfigurationAttachmentNetworkAclConfigurationArgs.builder()
                         .portRange(KxEnvironmentTransitGatewayConfigurationAttachmentNetworkAclConfigurationPortRangeArgs.builder()
                             .from(53)
                             .to(53)
                             .build())
                         .icmpTypeCode(KxEnvironmentTransitGatewayConfigurationAttachmentNetworkAclConfigurationIcmpTypeCodeArgs.builder()
                             .type(-1)
                             .code(-1)
                             .build())
                         .ruleNumber(1)
                         .protocol("6")
                         .ruleAction("allow")
                         .cidrBlock("0.0.0.0/0")
                         .build())
                     .transitGatewayId(exampleTransitGateway.id())
                     .routableCidrSpace("100.64.0.0/26")
                     .build())
                 .customDnsConfigurations(KxEnvironmentCustomDnsConfigurationArgs.builder()
                     .customDnsServerName("example.finspace.amazonaws.com")
                     .customDnsServerIp("10.0.0.76")
                     .build())
                 .name("my-tf-kx-environment")
                 .description("Environment description")
                 .kmsKeyId(example.arn())
                 .build());
     
         }
     }
     
     
    ## Import Using `pulumi import`, import an AWS FinSpace Kx Environment using the `id`. For example: ```sh $ pulumi import aws:finspace/kxEnvironment:KxEnvironment example n3ceo7wqxoxcti5tujqwzs ```
    • 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.lang.String> arn()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> availabilityZones()  
      com.pulumi.core.Output<java.lang.String> createdTimestamp()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<KxEnvironmentCustomDnsConfiguration>>> customDnsConfigurations()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static KxEnvironment get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, KxEnvironmentState 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> infrastructureAccountId()  
      com.pulumi.core.Output<java.lang.String> kmsKeyId()  
      com.pulumi.core.Output<java.lang.String> lastModifiedTimestamp()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> status()  
      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<KxEnvironmentTransitGatewayConfiguration>> transitGatewayConfiguration()  
      • 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

      • KxEnvironment

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

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

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

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN identifier of the KX environment.
      • availabilityZones

        public com.pulumi.core.Output<java.util.List<java.lang.String>> availabilityZones()
        Returns:
        AWS Availability Zone IDs that this environment is available in. Important when selecting VPC subnets to use in cluster creation.
      • createdTimestamp

        public com.pulumi.core.Output<java.lang.String> createdTimestamp()
        Returns:
        Timestamp at which the environment is created in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
      • customDnsConfigurations

        public com.pulumi.core.Output<java.util.Optional<java.util.List<KxEnvironmentCustomDnsConfiguration>>> customDnsConfigurations()
        Returns:
        List of DNS server name and server IP. This is used to set up Route-53 outbound resolvers. Defined below.
      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description for the KX environment.
      • infrastructureAccountId

        public com.pulumi.core.Output<java.lang.String> infrastructureAccountId()
        Returns:
        Unique identifier for the AWS environment infrastructure account.
      • kmsKeyId

        public com.pulumi.core.Output<java.lang.String> kmsKeyId()
        Returns:
        KMS key ID to encrypt your data in the FinSpace environment.
      • lastModifiedTimestamp

        public com.pulumi.core.Output<java.lang.String> lastModifiedTimestamp()
        Returns:
        Last timestamp at which the environment was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the KX environment that you want to create. The following arguments are optional:
      • 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.
      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Status of environment creation
      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value mapping of resource tags. 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()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
      • transitGatewayConfiguration

        public com.pulumi.core.Output<java.util.Optional<KxEnvironmentTransitGatewayConfiguration>> transitGatewayConfiguration()
        Returns:
        Transit gateway and network configuration that is used to connect the KX environment to an internal network. Defined below.
      • get

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