Package software.amazon.awscdk.services.dms

Class CfnInstanceProfile

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.dms.CfnInstanceProfile
All Implemented Interfaces:
IInspectable, IInstanceProfileRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:08.368Z") @Stability(Stable) public class CfnInstanceProfile extends CfnResource implements IInspectable, IInstanceProfileRef, ITaggableV2
Provides information that defines an instance profile.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dms.*;
 CfnInstanceProfile cfnInstanceProfile = CfnInstanceProfile.Builder.create(this, "MyCfnInstanceProfile")
         .availabilityZone("availabilityZone")
         .description("description")
         .instanceProfileIdentifier("instanceProfileIdentifier")
         .instanceProfileName("instanceProfileName")
         .kmsKeyArn("kmsKeyArn")
         .networkType("networkType")
         .publiclyAccessible(false)
         .subnetGroupIdentifier("subnetGroupIdentifier")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcSecurityGroups(List.of("vpcSecurityGroups"))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnInstanceProfile

      protected CfnInstanceProfile(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnInstanceProfile

      protected CfnInstanceProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnInstanceProfile

      @Stability(Stable) public CfnInstanceProfile(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnInstanceProfileProps props)
      Create a new AWS::DMS::InstanceProfile.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnInstanceProfile

      @Stability(Stable) public CfnInstanceProfile(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::DMS::InstanceProfile.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForInstanceProfile

      @Stability(Stable) @NotNull public static String arnForInstanceProfile(@NotNull IInstanceProfileRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnInstanceProfile

      @Stability(Stable) @NotNull public static Boolean isCfnInstanceProfile(@NotNull Object x)
      Checks whether the given object is a CfnInstanceProfile.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrInstanceProfileArn

      @Stability(Stable) @NotNull public String getAttrInstanceProfileArn()
      The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.

    • getAttrInstanceProfileCreationTime

      @Stability(Stable) @NotNull public String getAttrInstanceProfileCreationTime()
      The time the instance profile was created.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getInstanceProfileRef

      @Stability(Stable) @NotNull public InstanceProfileReference getInstanceProfileRef()
      A reference to a InstanceProfile resource.
      Specified by:
      getInstanceProfileRef in interface IInstanceProfileRef

    • getAvailabilityZone

      @Stability(Stable) @Nullable public String getAvailabilityZone()
      The Availability Zone where the instance profile runs.

    • setAvailabilityZone

      @Stability(Stable) public void setAvailabilityZone(@Nullable String value)
      The Availability Zone where the instance profile runs.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the instance profile.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the instance profile.

    • getInstanceProfileIdentifier

      @Stability(Stable) @Nullable public String getInstanceProfileIdentifier()
      The identifier of the instance profile.

    • setInstanceProfileIdentifier

      @Stability(Stable) public void setInstanceProfileIdentifier(@Nullable String value)
      The identifier of the instance profile.

    • getInstanceProfileName

      @Stability(Stable) @Nullable public String getInstanceProfileName()
      The user-friendly name for the instance profile.

    • setInstanceProfileName

      @Stability(Stable) public void setInstanceProfileName(@Nullable String value)
      The user-friendly name for the instance profile.

    • getKmsKeyArn

      @Stability(Stable) @Nullable public String getKmsKeyArn()
      The Amazon Resource Name (ARN) of the AWS key that is used to encrypt the connection parameters for the instance profile.

    • setKmsKeyArn

      @Stability(Stable) public void setKmsKeyArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the AWS key that is used to encrypt the connection parameters for the instance profile.

    • getNetworkType

      @Stability(Stable) @Nullable public String getNetworkType()
      Specifies the network type for the instance profile.

    • setNetworkType

      @Stability(Stable) public void setNetworkType(@Nullable String value)
      Specifies the network type for the instance profile.

    • getPubliclyAccessible

      @Stability(Stable) @Nullable public Object getPubliclyAccessible()
      Specifies the accessibility options for the instance profile.

      Returns union: either Boolean or IResolvable

    • setPubliclyAccessible

      @Stability(Stable) public void setPubliclyAccessible(@Nullable Boolean value)
      Specifies the accessibility options for the instance profile.

    • setPubliclyAccessible

      @Stability(Stable) public void setPubliclyAccessible(@Nullable IResolvable value)
      Specifies the accessibility options for the instance profile.

    • getSubnetGroupIdentifier

      @Stability(Stable) @Nullable public String getSubnetGroupIdentifier()
      The identifier of the subnet group that is associated with the instance profile.

    • setSubnetGroupIdentifier

      @Stability(Stable) public void setSubnetGroupIdentifier(@Nullable String value)
      The identifier of the subnet group that is associated with the instance profile.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.

    • getVpcSecurityGroups

      @Stability(Stable) @Nullable public List<String> getVpcSecurityGroups()
      The VPC security groups that are used with the instance profile.

    • setVpcSecurityGroups

      @Stability(Stable) public void setVpcSecurityGroups(@Nullable List<String> value)
      The VPC security groups that are used with the instance profile.