software.amazon.awssdk.services.databasemigration.model

Class CreateInstanceProfileRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest

software.amazon.awssdk.services.databasemigration.model.CreateInstanceProfileRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateInstanceProfileRequest.Builder,CreateInstanceProfileRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateInstanceProfileRequest
extends DatabaseMigrationRequest
implements ToCopyableBuilder<CreateInstanceProfileRequest.Builder,CreateInstanceProfileRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateInstanceProfileRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	availabilityZone() The Availability Zone where the instance profile will be created.
static CreateInstanceProfileRequest.Builder	builder()
String	description() A user-friendly description of the instance profile.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
boolean	hasVpcSecurityGroups() For responses, this returns true if the service returned a value for the VpcSecurityGroups property.
String	instanceProfileName() A user-friendly name for the instance profile.
String	kmsKeyArn() The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.
String	networkType() Specifies the network type for the instance profile.
Boolean	publiclyAccessible() Specifies the accessibility options for the instance profile.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateInstanceProfileRequest.Builder>	serializableBuilderClass()
String	subnetGroupIdentifier() A subnet group to associate with the instance profile.
List<Tag>	tags() One or more tags to be assigned to the instance profile.
CreateInstanceProfileRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	vpcSecurityGroups() Specifies the VPC security group names to be used with the instance profile.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

availabilityZone

public final 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.

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.

kmsKeyArn

public final 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.

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.

publiclyAccessible

public final 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.

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

One or more tags to be assigned to the instance profile.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

One or more tags to be assigned to the instance profile.

networkType

public final 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.

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.

instanceProfileName

public final String instanceProfileName()

A user-friendly name for the instance profile.

Returns:

A user-friendly name for the instance profile.

description

public final String description()

A user-friendly description of the instance profile.

Returns:

A user-friendly description of the instance profile.

subnetGroupIdentifier

public final String subnetGroupIdentifier()

A subnet group to associate with the instance profile.

Returns:

A subnet group to associate with the instance profile.

hasVpcSecurityGroups

public final boolean hasVpcSecurityGroups()

For responses, this returns true if the service returned a value for the VpcSecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

vpcSecurityGroups

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSecurityGroups() method.

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.

toBuilder

public CreateInstanceProfileRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateInstanceProfileRequest.Builder,CreateInstanceProfileRequest>

Specified by:

toBuilder in class DatabaseMigrationRequest

builder

public static CreateInstanceProfileRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateInstanceProfileRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo