Package com.pulumi.aws.dms

Class InstanceProfile

  • public class InstanceProfile
extends com.pulumi.resources.CustomResource
    Manages an AWS DMS (Database Migration) Instance Profile. An instance profile provides network and encryption information to DMS Schema Conversion for use in connecting to a data provider. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.dms.InstanceProfile;
 import com.pulumi.aws.dms.InstanceProfileArgs;
 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 InstanceProfile("example", InstanceProfileArgs.builder()
             .name("example")
             .build());
 
     }
 }
    ### With Networking Configuration 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.dms.InstanceProfile;
 import com.pulumi.aws.dms.InstanceProfileArgs;
 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 InstanceProfile("example", InstanceProfileArgs.builder()
             .name("example")
             .description("example instance profile")
             .networkType("IPV4")
             .publiclyAccessible(false)
             .subnetGroupIdentifier(exampleAwsDmsReplicationSubnetGroup.id())
             .vpcSecurityGroupIds(exampleAwsSecurityGroup.id())
             .kmsKeyArn(exampleAwsKmsKey.arn())
             .tags(Map.of("Name", "example"))
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `arn` (String) ARN of the instance profile. Using `pulumi import`, import DMS (Database Migration) Instance Profile using the `arn`. For example: ```sh $ pulumi import aws:dms/instanceProfile:InstanceProfile example arn:aws:dms:us-east-1:123456789012:instance-profile:ABCDEFGHIJKLMNOPQRSTUVWXYZ123456 ```

    • 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.lang.String> availabilityZone()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static InstanceProfile get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, InstanceProfileState 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> kmsKeyArn()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> networkType()  
      com.pulumi.core.Output<java.lang.Boolean> publiclyAccessible()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> subnetGroupIdentifier()  
      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.List<java.lang.String>> vpcSecurityGroupIds()  

      • 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

      • InstanceProfile

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

      • InstanceProfile

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

      • InstanceProfile

        public InstanceProfile​(java.lang.String name,
                       @Nullable
                       InstanceProfileArgs 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 of the instance profile.

      • availabilityZone

        public com.pulumi.core.Output<java.lang.String> availabilityZone()
        Returns:
        Availability Zone where the instance profile runs. Default is a random, system-chosen Availability Zone.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description for the instance profile.

      • kmsKeyArn

        public com.pulumi.core.Output<java.lang.String> kmsKeyArn()
        Returns:
        ARN of the KMS key used to encrypt the connection parameters for the instance profile. If you don't specify a value, DMS uses your default encryption key.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name for the instance profile. If omitted, DMS assigns a generated name.

      • networkType

        public com.pulumi.core.Output<java.lang.String> networkType()
        Returns:
        Network type for the instance profile. Valid values are `IPV4`, `IPV6`, and `DUAL`.

      • publiclyAccessible

        public com.pulumi.core.Output<java.lang.Boolean> publiclyAccessible()
        Returns:
        Whether the instance profile is publicly accessible. Default is `true`.

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

      • subnetGroupIdentifier

        public com.pulumi.core.Output<java.lang.String> subnetGroupIdentifier()
        Returns:
        Subnet group to associate with the instance profile.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags assigned to the resource. 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.

      • vpcSecurityGroupIds

        public com.pulumi.core.Output<java.util.List<java.lang.String>> vpcSecurityGroupIds()
        Returns:
        VPC security group IDs to be used with the instance profile. The VPC security groups must work with the VPC containing the instance profile.

      • get

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