CreateInstanceProfileRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.databasemigrationservice.model

Class CreateInstanceProfileRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.databasemigrationservice.model.CreateInstanceProfileRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateInstanceProfileRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateInstanceProfileRequest ()

Constructors
Constructor and Description
`CreateInstanceProfileRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`CreateInstanceProfileRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`String`	`getAvailabilityZone ()` The Availability Zone where the instance profile will be created.
`String`	`getDescription ()` A user-friendly description of the instance profile.
`String`	`getInstanceProfileName ()` A user-friendly name for the instance profile.
`String`	`getKmsKeyArn ()` The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.
`String`	`getNetworkType ()` Specifies the network type for the instance profile.
`Boolean`	`getPubliclyAccessible ()` Specifies the accessibility options for the instance profile.
`String`	`getSubnetGroupIdentifier ()` A subnet group to associate with the instance profile.
`List<Tag>`	`getTags ()` One or more tags to be assigned to the instance profile.
`List<String>`	`getVpcSecurityGroups ()` Specifies the VPC security group names to be used with the instance profile.
`int`	`hashCode ()`
`Boolean`	`isPubliclyAccessible ()` Specifies the accessibility options for the instance profile.
`void`	`setAvailabilityZone (String availabilityZone)` The Availability Zone where the instance profile will be created.
`void`	`setDescription (String description)` A user-friendly description of the instance profile.
`void`	`setInstanceProfileName (String instanceProfileName)` A user-friendly name for the instance profile.
`void`	`setKmsKeyArn (String kmsKeyArn)` The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.
`void`	`setNetworkType (String networkType)` Specifies the network type for the instance profile.
`void`	`setPubliclyAccessible (Boolean publiclyAccessible)` Specifies the accessibility options for the instance profile.
`void`	`setSubnetGroupIdentifier (String subnetGroupIdentifier)` A subnet group to associate with the instance profile.
`void`	`setTags (Collection<Tag> tags)` One or more tags to be assigned to the instance profile.
`void`	`setVpcSecurityGroups (Collection<String> vpcSecurityGroups)` Specifies the VPC security group names to be used with the instance profile.
`String`	`toString ()` Returns a string representation of this object.
`CreateInstanceProfileRequest`	`withAvailabilityZone (String availabilityZone)` The Availability Zone where the instance profile will be created.
`CreateInstanceProfileRequest`	`withDescription (String description)` A user-friendly description of the instance profile.
`CreateInstanceProfileRequest`	`withInstanceProfileName (String instanceProfileName)` A user-friendly name for the instance profile.
`CreateInstanceProfileRequest`	`withKmsKeyArn (String kmsKeyArn)` The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.
`CreateInstanceProfileRequest`	`withNetworkType (String networkType)` Specifies the network type for the instance profile.
`CreateInstanceProfileRequest`	`withPubliclyAccessible (Boolean publiclyAccessible)` Specifies the accessibility options for the instance profile.
`CreateInstanceProfileRequest`	`withSubnetGroupIdentifier (String subnetGroupIdentifier)` A subnet group to associate with the instance profile.
`CreateInstanceProfileRequest`	`withTags (Collection<Tag> tags)` One or more tags to be assigned to the instance profile.
`CreateInstanceProfileRequest`	`withTags (Tag... tags)` One or more tags to be assigned to the instance profile.
`CreateInstanceProfileRequest`	`withVpcSecurityGroups (Collection<String> vpcSecurityGroups)` Specifies the VPC security group names to be used with the instance profile.
`CreateInstanceProfileRequest`	`withVpcSecurityGroups (String... vpcSecurityGroups)` Specifies the VPC security group names to be used with the instance profile.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateInstanceProfileRequest
```
public CreateInstanceProfileRequest()
```
- Method Detail
  - setAvailabilityZone
```
public void setAvailabilityZone(String availabilityZone)
```
    The Availability Zone where the instance profile will be created. The default value is a random, system-chosen Availability Zone in the Amazon Web Services Region where your data provider is created, for examplem us-east-1d.
    
    Parameters:
    
    availabilityZone - The Availability Zone where the instance profile will be created. The default value is a random, system-chosen Availability Zone in the Amazon Web Services Region where your data provider is created, for examplem us-east-1d.
  - getAvailabilityZone
```
public String getAvailabilityZone()
```
    The Availability Zone where the instance profile will be created. The default value is a random, system-chosen Availability Zone in the Amazon Web Services Region where your data provider is created, for examplem us-east-1d.
    
    Returns:
    
    The Availability Zone where the instance profile will be created. The default value is a random, system-chosen Availability Zone in the Amazon Web Services Region where your data provider is created, for examplem us-east-1d.
  - withAvailabilityZone
```
public CreateInstanceProfileRequest withAvailabilityZone(String availabilityZone)
```
    The Availability Zone where the instance profile will be created. The default value is a random, system-chosen Availability Zone in the Amazon Web Services Region where your data provider is created, for examplem us-east-1d.
    
    Parameters:
    
    availabilityZone - The Availability Zone where the instance profile will be created. The default value is a random, system-chosen Availability Zone in the Amazon Web Services Region where your data provider is created, for examplem us-east-1d.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsKeyArn
```
public void setKmsKeyArn(String kmsKeyArn)
```
    The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.
    
    If you don't specify a value for the KmsKeyArn parameter, then DMS uses your default encryption key.
    
    KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
    
    Parameters:
    
    kmsKeyArn - The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.
    
    If you don't specify a value for the KmsKeyArn parameter, then DMS uses your default encryption key.
    
    KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
  - getKmsKeyArn
```
public String getKmsKeyArn()
```
    The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.
    
    If you don't specify a value for the KmsKeyArn parameter, then DMS uses your default encryption key.
    
    KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.
    
    If you don't specify a value for the KmsKeyArn parameter, then DMS uses your default encryption key.
    
    KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
  - withKmsKeyArn
```
public CreateInstanceProfileRequest withKmsKeyArn(String kmsKeyArn)
```
    The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.
    
    If you don't specify a value for the KmsKeyArn parameter, then DMS uses your default encryption key.
    
    KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
    
    Parameters:
    
    kmsKeyArn - The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.
    
    If you don't specify a value for the KmsKeyArn parameter, then DMS uses your default encryption key.
    
    KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPubliclyAccessible
```
public void setPubliclyAccessible(Boolean publiclyAccessible)
```
    Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true.
    
    Parameters:
    
    publiclyAccessible - Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true.
  - getPubliclyAccessible
```
public Boolean getPubliclyAccessible()
```
    Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true.
    
    Returns:
    
    Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true.
  - withPubliclyAccessible
```
public CreateInstanceProfileRequest withPubliclyAccessible(Boolean publiclyAccessible)
```
    Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true.
    
    Parameters:
    
    publiclyAccessible - Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPubliclyAccessible
```
public Boolean isPubliclyAccessible()
```
    Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true.
    
    Returns:
    
    Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true.
  - getTags
```
public List<Tag> getTags()
```
    One or more tags to be assigned to the instance profile.
    
    Returns:
    
    One or more tags to be assigned to the instance profile.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    One or more tags to be assigned to the instance profile.
    
    Parameters:
    
    tags - One or more tags to be assigned to the instance profile.
  - withTags
```
public CreateInstanceProfileRequest withTags(Tag... tags)
```
    One or more tags to be assigned to the instance profile.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - One or more tags to be assigned to the instance profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CreateInstanceProfileRequest withTags(Collection<Tag> tags)
```
    One or more tags to be assigned to the instance profile.
    
    Parameters:
    
    tags - One or more tags to be assigned to the instance profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNetworkType
```
public void setNetworkType(String networkType)
```
    Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.
    
    Parameters:
    
    networkType - Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.
  - getNetworkType
```
public String getNetworkType()
```
    Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.
    
    Returns:
    
    Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.
  - withNetworkType
```
public CreateInstanceProfileRequest withNetworkType(String networkType)
```
    Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.
    
    Parameters:
    
    networkType - Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceProfileName
```
public void setInstanceProfileName(String instanceProfileName)
```
    A user-friendly name for the instance profile.
    
    Parameters:
    
    instanceProfileName - A user-friendly name for the instance profile.
  - getInstanceProfileName
```
public String getInstanceProfileName()
```
    A user-friendly name for the instance profile.
    
    Returns:
    
    A user-friendly name for the instance profile.
  - withInstanceProfileName
```
public CreateInstanceProfileRequest withInstanceProfileName(String instanceProfileName)
```
    A user-friendly name for the instance profile.
    
    Parameters:
    
    instanceProfileName - A user-friendly name for the instance profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A user-friendly description of the instance profile.
    
    Parameters:
    
    description - A user-friendly description of the instance profile.
  - getDescription
```
public String getDescription()
```
    A user-friendly description of the instance profile.
    
    Returns:
    
    A user-friendly description of the instance profile.
  - withDescription
```
public CreateInstanceProfileRequest withDescription(String description)
```
    A user-friendly description of the instance profile.
    
    Parameters:
    
    description - A user-friendly description of the instance profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSubnetGroupIdentifier
```
public void setSubnetGroupIdentifier(String subnetGroupIdentifier)
```
    A subnet group to associate with the instance profile.
    
    Parameters:
    
    subnetGroupIdentifier - A subnet group to associate with the instance profile.
  - getSubnetGroupIdentifier
```
public String getSubnetGroupIdentifier()
```
    A subnet group to associate with the instance profile.
    
    Returns:
    
    A subnet group to associate with the instance profile.
  - withSubnetGroupIdentifier
```
public CreateInstanceProfileRequest withSubnetGroupIdentifier(String subnetGroupIdentifier)
```
    A subnet group to associate with the instance profile.
    
    Parameters:
    
    subnetGroupIdentifier - A subnet group to associate with the instance profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVpcSecurityGroups
```
public List<String> getVpcSecurityGroups()
```
    Specifies the VPC security group names to be used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
    
    Returns:
    
    Specifies the VPC security group names to be used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
  - setVpcSecurityGroups
```
public void setVpcSecurityGroups(Collection<String> vpcSecurityGroups)
```
    Specifies the VPC security group names to be used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
    
    Parameters:
    
    vpcSecurityGroups - Specifies the VPC security group names to be used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
  - withVpcSecurityGroups
```
public CreateInstanceProfileRequest withVpcSecurityGroups(String... vpcSecurityGroups)
```
    Specifies the VPC security group names to be used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
    
    NOTE: This method appends the values to the existing list (if any). Use setVpcSecurityGroups(java.util.Collection) or withVpcSecurityGroups(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    vpcSecurityGroups - Specifies the VPC security group names to be used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withVpcSecurityGroups
```
public CreateInstanceProfileRequest withVpcSecurityGroups(Collection<String> vpcSecurityGroups)
```
    Specifies the VPC security group names to be used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
    
    Parameters:
    
    vpcSecurityGroups - Specifies the VPC security group names to be used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateInstanceProfileRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class CreateInstanceProfileRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateInstanceProfileRequest

Method Detail

setAvailabilityZone

getAvailabilityZone

withAvailabilityZone

setKmsKeyArn

getKmsKeyArn

withKmsKeyArn

setPubliclyAccessible

getPubliclyAccessible

withPubliclyAccessible

isPubliclyAccessible

getTags

setTags

withTags

withTags

setNetworkType

getNetworkType

withNetworkType

setInstanceProfileName

getInstanceProfileName

withInstanceProfileName

setDescription

getDescription

withDescription

setSubnetGroupIdentifier

getSubnetGroupIdentifier

withSubnetGroupIdentifier

getVpcSecurityGroups

setVpcSecurityGroups

withVpcSecurityGroups

withVpcSecurityGroups

toString

equals

hashCode

clone