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, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:05.394Z")
@Stability(Stable)
public class CfnInstanceProfile
extends CfnResource
implements IInspectable, 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-instanceprofile.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnInstanceProfile.Builder	A fluent builder for CfnInstanceProfile.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnInstanceProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnInstanceProfile(software.amazon.jsii.JsiiObjectRef objRef)
	CfnInstanceProfile(software.constructs.Construct scope, String id)
	CfnInstanceProfile(software.constructs.Construct scope, String id, CfnInstanceProfileProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrInstanceProfileArn()	The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.
String	getAttrInstanceProfileCreationTime()	The time the instance profile was created.
String	getAvailabilityZone()	The Availability Zone where the instance profile runs.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	A description of the instance profile.
String	getInstanceProfileIdentifier()	The identifier of the instance profile.
String	getInstanceProfileName()	The user-friendly name for the instance profile.
String	getKmsKeyArn()	The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the connection parameters for the instance profile.
String	getNetworkType()	Specifies the network type for the instance profile.
Object	getPubliclyAccessible()	Specifies the accessibility options for the instance profile.
String	getSubnetGroupIdentifier()	The identifier of the subnet group that is associated with the instance profile.
List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
List<String>	getVpcSecurityGroups()	The VPC security groups that are used with the instance profile.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAvailabilityZone(String value)	The Availability Zone where the instance profile runs.
void	setDescription(String value)	A description of the instance profile.
void	setInstanceProfileIdentifier(String value)	The identifier of the instance profile.
void	setInstanceProfileName(String value)	The user-friendly name for the instance profile.
void	setKmsKeyArn(String value)	The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the connection parameters for the instance profile.
void	setNetworkType(String value)	Specifies the network type for the instance profile.
void	setPubliclyAccessible(Boolean value)	Specifies the accessibility options for the instance profile.
void	setPubliclyAccessible(IResolvable value)	Specifies the accessibility options for the instance profile.
void	setSubnetGroupIdentifier(String value)	The identifier of the subnet group that is associated with the instance profile.
void	setTags(List<CfnTag> value)	An array of key-value pairs to apply to this resource.
void	setVpcSecurityGroups(List<String> value)	The VPC security groups that are used with the instance profile.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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)

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)

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

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

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

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.