com.amazonaws.services.databasemigrationservice.model.InstanceProfile Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dms Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.databasemigrationservice.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Provides information that defines an instance profile.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class InstanceProfile implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.
*
*/
private String instanceProfileArn;
/**
*
* The Availability Zone where the instance profile runs.
*
*/
private String availabilityZone;
/**
*
* 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.
*
*/
private String kmsKeyArn;
/**
*
* 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.
*
*/
private Boolean publiclyAccessible;
/**
*
* 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.
*
*/
private String networkType;
/**
*
* The user-friendly name for the instance profile.
*
*/
private String instanceProfileName;
/**
*
* A description of the instance profile. Descriptions can have up to 31 characters. A description can contain only
* ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens,
* and can only begin with a letter.
*
*/
private String description;
/**
*
* The time the instance profile was created.
*
*/
private java.util.Date instanceProfileCreationTime;
/**
*
* The identifier of the subnet group that is associated with the instance profile.
*
*/
private String subnetGroupIdentifier;
/**
*
* The VPC security groups that are used with the instance profile. The VPC security group must work with the VPC
* containing the instance profile.
*
*/
private java.util.List vpcSecurityGroups;
/**
*
* The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.
*
*
* @param instanceProfileArn
* The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.
*/
public void setInstanceProfileArn(String instanceProfileArn) {
this.instanceProfileArn = instanceProfileArn;
}
/**
*
* The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.
*
*
* @return The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.
*/
public String getInstanceProfileArn() {
return this.instanceProfileArn;
}
/**
*
* The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.
*
*
* @param instanceProfileArn
* The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InstanceProfile withInstanceProfileArn(String instanceProfileArn) {
setInstanceProfileArn(instanceProfileArn);
return this;
}
/**
*
* The Availability Zone where the instance profile runs.
*
*
* @param availabilityZone
* The Availability Zone where the instance profile runs.
*/
public void setAvailabilityZone(String availabilityZone) {
this.availabilityZone = availabilityZone;
}
/**
*
* The Availability Zone where the instance profile runs.
*
*
* @return The Availability Zone where the instance profile runs.
*/
public String getAvailabilityZone() {
return this.availabilityZone;
}
/**
*
* The Availability Zone where the instance profile runs.
*
*
* @param availabilityZone
* The Availability Zone where the instance profile runs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InstanceProfile withAvailabilityZone(String availabilityZone) {
setAvailabilityZone(availabilityZone);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setKmsKeyArn(String kmsKeyArn) {
this.kmsKeyArn = 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.
*
*
* @return 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.
*/
public String getKmsKeyArn() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InstanceProfile withKmsKeyArn(String kmsKeyArn) {
setKmsKeyArn(kmsKeyArn);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setPubliclyAccessible(Boolean publiclyAccessible) {
this.publiclyAccessible = 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.
*
*
* @return 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.
*/
public Boolean getPubliclyAccessible() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InstanceProfile withPubliclyAccessible(Boolean publiclyAccessible) {
setPubliclyAccessible(publiclyAccessible);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isPubliclyAccessible() {
return this.publiclyAccessible;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setNetworkType(String networkType) {
this.networkType = 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.
*
*
* @return 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.
*/
public String getNetworkType() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InstanceProfile withNetworkType(String networkType) {
setNetworkType(networkType);
return this;
}
/**
*
* The user-friendly name for the instance profile.
*
*
* @param instanceProfileName
* The user-friendly name for the instance profile.
*/
public void setInstanceProfileName(String instanceProfileName) {
this.instanceProfileName = instanceProfileName;
}
/**
*
* The user-friendly name for the instance profile.
*
*
* @return The user-friendly name for the instance profile.
*/
public String getInstanceProfileName() {
return this.instanceProfileName;
}
/**
*
* The user-friendly name for the instance profile.
*
*
* @param instanceProfileName
* The user-friendly name for the instance profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InstanceProfile withInstanceProfileName(String instanceProfileName) {
setInstanceProfileName(instanceProfileName);
return this;
}
/**
*
* A description of the instance profile. Descriptions can have up to 31 characters. A description can contain only
* ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens,
* and can only begin with a letter.
*
*
* @param description
* A description of the instance profile. Descriptions can have up to 31 characters. A description can
* contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two
* consecutive hyphens, and can only begin with a letter.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A description of the instance profile. Descriptions can have up to 31 characters. A description can contain only
* ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens,
* and can only begin with a letter.
*
*
* @return A description of the instance profile. Descriptions can have up to 31 characters. A description can
* contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two
* consecutive hyphens, and can only begin with a letter.
*/
public String getDescription() {
return this.description;
}
/**
*
* A description of the instance profile. Descriptions can have up to 31 characters. A description can contain only
* ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens,
* and can only begin with a letter.
*
*
* @param description
* A description of the instance profile. Descriptions can have up to 31 characters. A description can
* contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two
* consecutive hyphens, and can only begin with a letter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InstanceProfile withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The time the instance profile was created.
*
*
* @param instanceProfileCreationTime
* The time the instance profile was created.
*/
public void setInstanceProfileCreationTime(java.util.Date instanceProfileCreationTime) {
this.instanceProfileCreationTime = instanceProfileCreationTime;
}
/**
*
* The time the instance profile was created.
*
*
* @return The time the instance profile was created.
*/
public java.util.Date getInstanceProfileCreationTime() {
return this.instanceProfileCreationTime;
}
/**
*
* The time the instance profile was created.
*
*
* @param instanceProfileCreationTime
* The time the instance profile was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InstanceProfile withInstanceProfileCreationTime(java.util.Date instanceProfileCreationTime) {
setInstanceProfileCreationTime(instanceProfileCreationTime);
return this;
}
/**
*
* The identifier of the subnet group that is associated with the instance profile.
*
*
* @param subnetGroupIdentifier
* The identifier of the subnet group that is associated with the instance profile.
*/
public void setSubnetGroupIdentifier(String subnetGroupIdentifier) {
this.subnetGroupIdentifier = subnetGroupIdentifier;
}
/**
*
* The identifier of the subnet group that is associated with the instance profile.
*
*
* @return The identifier of the subnet group that is associated with the instance profile.
*/
public String getSubnetGroupIdentifier() {
return this.subnetGroupIdentifier;
}
/**
*
* The identifier of the subnet group that is associated with the instance profile.
*
*
* @param subnetGroupIdentifier
* The identifier of the subnet group that is associated with the instance profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InstanceProfile withSubnetGroupIdentifier(String subnetGroupIdentifier) {
setSubnetGroupIdentifier(subnetGroupIdentifier);
return this;
}
/**
*
* The VPC security groups that are used with the instance profile. The VPC security group must work with the VPC
* containing the instance profile.
*
*
* @return The VPC security groups that are used with the instance profile. The VPC security group must work with
* the VPC containing the instance profile.
*/
public java.util.List getVpcSecurityGroups() {
return vpcSecurityGroups;
}
/**
*
* The VPC security groups that are used with the instance profile. The VPC security group must work with the VPC
* containing the instance profile.
*
*
* @param vpcSecurityGroups
* The VPC security groups that are used with the instance profile. The VPC security group must work with the
* VPC containing the instance profile.
*/
public void setVpcSecurityGroups(java.util.Collection vpcSecurityGroups) {
if (vpcSecurityGroups == null) {
this.vpcSecurityGroups = null;
return;
}
this.vpcSecurityGroups = new java.util.ArrayList(vpcSecurityGroups);
}
/**
*
* The VPC security groups that are 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
* {@link #setVpcSecurityGroups(java.util.Collection)} or {@link #withVpcSecurityGroups(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param vpcSecurityGroups
* The VPC security groups that are used with the instance profile. The VPC security group must work with the
* VPC containing the instance profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InstanceProfile withVpcSecurityGroups(String... vpcSecurityGroups) {
if (this.vpcSecurityGroups == null) {
setVpcSecurityGroups(new java.util.ArrayList(vpcSecurityGroups.length));
}
for (String ele : vpcSecurityGroups) {
this.vpcSecurityGroups.add(ele);
}
return this;
}
/**
*
* The VPC security groups that are used with the instance profile. The VPC security group must work with the VPC
* containing the instance profile.
*
*
* @param vpcSecurityGroups
* The VPC security groups that are used with the instance profile. The VPC security group must work with the
* VPC containing the instance profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InstanceProfile withVpcSecurityGroups(java.util.Collection vpcSecurityGroups) {
setVpcSecurityGroups(vpcSecurityGroups);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getInstanceProfileArn() != null)
sb.append("InstanceProfileArn: ").append(getInstanceProfileArn()).append(",");
if (getAvailabilityZone() != null)
sb.append("AvailabilityZone: ").append(getAvailabilityZone()).append(",");
if (getKmsKeyArn() != null)
sb.append("KmsKeyArn: ").append(getKmsKeyArn()).append(",");
if (getPubliclyAccessible() != null)
sb.append("PubliclyAccessible: ").append(getPubliclyAccessible()).append(",");
if (getNetworkType() != null)
sb.append("NetworkType: ").append(getNetworkType()).append(",");
if (getInstanceProfileName() != null)
sb.append("InstanceProfileName: ").append(getInstanceProfileName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getInstanceProfileCreationTime() != null)
sb.append("InstanceProfileCreationTime: ").append(getInstanceProfileCreationTime()).append(",");
if (getSubnetGroupIdentifier() != null)
sb.append("SubnetGroupIdentifier: ").append(getSubnetGroupIdentifier()).append(",");
if (getVpcSecurityGroups() != null)
sb.append("VpcSecurityGroups: ").append(getVpcSecurityGroups());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof InstanceProfile == false)
return false;
InstanceProfile other = (InstanceProfile) obj;
if (other.getInstanceProfileArn() == null ^ this.getInstanceProfileArn() == null)
return false;
if (other.getInstanceProfileArn() != null && other.getInstanceProfileArn().equals(this.getInstanceProfileArn()) == false)
return false;
if (other.getAvailabilityZone() == null ^ this.getAvailabilityZone() == null)
return false;
if (other.getAvailabilityZone() != null && other.getAvailabilityZone().equals(this.getAvailabilityZone()) == false)
return false;
if (other.getKmsKeyArn() == null ^ this.getKmsKeyArn() == null)
return false;
if (other.getKmsKeyArn() != null && other.getKmsKeyArn().equals(this.getKmsKeyArn()) == false)
return false;
if (other.getPubliclyAccessible() == null ^ this.getPubliclyAccessible() == null)
return false;
if (other.getPubliclyAccessible() != null && other.getPubliclyAccessible().equals(this.getPubliclyAccessible()) == false)
return false;
if (other.getNetworkType() == null ^ this.getNetworkType() == null)
return false;
if (other.getNetworkType() != null && other.getNetworkType().equals(this.getNetworkType()) == false)
return false;
if (other.getInstanceProfileName() == null ^ this.getInstanceProfileName() == null)
return false;
if (other.getInstanceProfileName() != null && other.getInstanceProfileName().equals(this.getInstanceProfileName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getInstanceProfileCreationTime() == null ^ this.getInstanceProfileCreationTime() == null)
return false;
if (other.getInstanceProfileCreationTime() != null && other.getInstanceProfileCreationTime().equals(this.getInstanceProfileCreationTime()) == false)
return false;
if (other.getSubnetGroupIdentifier() == null ^ this.getSubnetGroupIdentifier() == null)
return false;
if (other.getSubnetGroupIdentifier() != null && other.getSubnetGroupIdentifier().equals(this.getSubnetGroupIdentifier()) == false)
return false;
if (other.getVpcSecurityGroups() == null ^ this.getVpcSecurityGroups() == null)
return false;
if (other.getVpcSecurityGroups() != null && other.getVpcSecurityGroups().equals(this.getVpcSecurityGroups()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getInstanceProfileArn() == null) ? 0 : getInstanceProfileArn().hashCode());
hashCode = prime * hashCode + ((getAvailabilityZone() == null) ? 0 : getAvailabilityZone().hashCode());
hashCode = prime * hashCode + ((getKmsKeyArn() == null) ? 0 : getKmsKeyArn().hashCode());
hashCode = prime * hashCode + ((getPubliclyAccessible() == null) ? 0 : getPubliclyAccessible().hashCode());
hashCode = prime * hashCode + ((getNetworkType() == null) ? 0 : getNetworkType().hashCode());
hashCode = prime * hashCode + ((getInstanceProfileName() == null) ? 0 : getInstanceProfileName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getInstanceProfileCreationTime() == null) ? 0 : getInstanceProfileCreationTime().hashCode());
hashCode = prime * hashCode + ((getSubnetGroupIdentifier() == null) ? 0 : getSubnetGroupIdentifier().hashCode());
hashCode = prime * hashCode + ((getVpcSecurityGroups() == null) ? 0 : getVpcSecurityGroups().hashCode());
return hashCode;
}
@Override
public InstanceProfile clone() {
try {
return (InstanceProfile) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.databasemigrationservice.model.transform.InstanceProfileMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}