com.amazonaws.services.securitytoken.model.GetSessionTokenRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sts 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.securitytoken.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetSessionTokenRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions
* range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default.
* Sessions for Amazon Web Services account owners are restricted to a maximum of 3,600 seconds (one hour). If the
* duration is longer than one hour, the session for Amazon Web Services account owners defaults to one hour.
*
*/
private Integer durationSeconds;
/**
*
* The identification number of the MFA device that is associated with the IAM user who is making the
* GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA
* authentication. The value is either the serial number for a hardware device (such as GAHT12345678)
* or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user).
* You can find the device for an IAM user by going to the Amazon Web Services Management Console and viewing the
* user's security credentials.
*
*
* The regex used to validate this parameter is a string of characters consisting of upper- and lower-case
* alphanumeric characters with no spaces. You can also include underscores or any of the following characters:
* =,.@:/-
*
*/
private String serialNumber;
/**
*
* The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA
* code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set
* of temporary security credentials. A user who fails to provide the code receives an "access denied" response when
* requesting resources that require MFA authentication.
*
*
* The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
*
*/
private String tokenCode;
/**
*
* The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions
* range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default.
* Sessions for Amazon Web Services account owners are restricted to a maximum of 3,600 seconds (one hour). If the
* duration is longer than one hour, the session for Amazon Web Services account owners defaults to one hour.
*
*
* @param durationSeconds
* The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user
* sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours)
* as the default. Sessions for Amazon Web Services account owners are restricted to a maximum of 3,600
* seconds (one hour). If the duration is longer than one hour, the session for Amazon Web Services account
* owners defaults to one hour.
*/
public void setDurationSeconds(Integer durationSeconds) {
this.durationSeconds = durationSeconds;
}
/**
*
* The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions
* range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default.
* Sessions for Amazon Web Services account owners are restricted to a maximum of 3,600 seconds (one hour). If the
* duration is longer than one hour, the session for Amazon Web Services account owners defaults to one hour.
*
*
* @return The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user
* sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12
* hours) as the default. Sessions for Amazon Web Services account owners are restricted to a maximum of
* 3,600 seconds (one hour). If the duration is longer than one hour, the session for Amazon Web Services
* account owners defaults to one hour.
*/
public Integer getDurationSeconds() {
return this.durationSeconds;
}
/**
*
* The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions
* range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default.
* Sessions for Amazon Web Services account owners are restricted to a maximum of 3,600 seconds (one hour). If the
* duration is longer than one hour, the session for Amazon Web Services account owners defaults to one hour.
*
*
* @param durationSeconds
* The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user
* sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours)
* as the default. Sessions for Amazon Web Services account owners are restricted to a maximum of 3,600
* seconds (one hour). If the duration is longer than one hour, the session for Amazon Web Services account
* owners defaults to one hour.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSessionTokenRequest withDurationSeconds(Integer durationSeconds) {
setDurationSeconds(durationSeconds);
return this;
}
/**
*
* The identification number of the MFA device that is associated with the IAM user who is making the
* GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA
* authentication. The value is either the serial number for a hardware device (such as GAHT12345678)
* or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user).
* You can find the device for an IAM user by going to the Amazon Web Services Management Console and viewing the
* user's security credentials.
*
*
* The regex used to validate this parameter is a string of characters consisting of upper- and lower-case
* alphanumeric characters with no spaces. You can also include underscores or any of the following characters:
* =,.@:/-
*
*
* @param serialNumber
* The identification number of the MFA device that is associated with the IAM user who is making the
* GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA
* authentication. The value is either the serial number for a hardware device (such as
* GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as
* arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the
* Amazon Web Services Management Console and viewing the user's security credentials.
*
* The regex used to validate this parameter is a string of characters consisting of upper- and lower-case
* alphanumeric characters with no spaces. You can also include underscores or any of the following
* characters: =,.@:/-
*/
public void setSerialNumber(String serialNumber) {
this.serialNumber = serialNumber;
}
/**
*
* The identification number of the MFA device that is associated with the IAM user who is making the
* GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA
* authentication. The value is either the serial number for a hardware device (such as GAHT12345678)
* or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user).
* You can find the device for an IAM user by going to the Amazon Web Services Management Console and viewing the
* user's security credentials.
*
*
* The regex used to validate this parameter is a string of characters consisting of upper- and lower-case
* alphanumeric characters with no spaces. You can also include underscores or any of the following characters:
* =,.@:/-
*
*
* @return The identification number of the MFA device that is associated with the IAM user who is making the
* GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA
* authentication. The value is either the serial number for a hardware device (such as
* GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as
* arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the
* Amazon Web Services Management Console and viewing the user's security credentials.
*
* The regex used to validate this parameter is a string of characters consisting of upper- and lower-case
* alphanumeric characters with no spaces. You can also include underscores or any of the following
* characters: =,.@:/-
*/
public String getSerialNumber() {
return this.serialNumber;
}
/**
*
* The identification number of the MFA device that is associated with the IAM user who is making the
* GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA
* authentication. The value is either the serial number for a hardware device (such as GAHT12345678)
* or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user).
* You can find the device for an IAM user by going to the Amazon Web Services Management Console and viewing the
* user's security credentials.
*
*
* The regex used to validate this parameter is a string of characters consisting of upper- and lower-case
* alphanumeric characters with no spaces. You can also include underscores or any of the following characters:
* =,.@:/-
*
*
* @param serialNumber
* The identification number of the MFA device that is associated with the IAM user who is making the
* GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA
* authentication. The value is either the serial number for a hardware device (such as
* GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as
* arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the
* Amazon Web Services Management Console and viewing the user's security credentials.
*
* The regex used to validate this parameter is a string of characters consisting of upper- and lower-case
* alphanumeric characters with no spaces. You can also include underscores or any of the following
* characters: =,.@:/-
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSessionTokenRequest withSerialNumber(String serialNumber) {
setSerialNumber(serialNumber);
return this;
}
/**
*
* The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA
* code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set
* of temporary security credentials. A user who fails to provide the code receives an "access denied" response when
* requesting resources that require MFA authentication.
*
*
* The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
*
*
* @param tokenCode
* The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an
* MFA code, specify this value. If MFA authentication is required, the user must provide a code when
* requesting a set of temporary security credentials. A user who fails to provide the code receives an
* "access denied" response when requesting resources that require MFA authentication.
*
* The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
*/
public void setTokenCode(String tokenCode) {
this.tokenCode = tokenCode;
}
/**
*
* The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA
* code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set
* of temporary security credentials. A user who fails to provide the code receives an "access denied" response when
* requesting resources that require MFA authentication.
*
*
* The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
*
*
* @return The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit
* an MFA code, specify this value. If MFA authentication is required, the user must provide a code when
* requesting a set of temporary security credentials. A user who fails to provide the code receives an
* "access denied" response when requesting resources that require MFA authentication.
*
* The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
*/
public String getTokenCode() {
return this.tokenCode;
}
/**
*
* The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA
* code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set
* of temporary security credentials. A user who fails to provide the code receives an "access denied" response when
* requesting resources that require MFA authentication.
*
*
* The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
*
*
* @param tokenCode
* The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an
* MFA code, specify this value. If MFA authentication is required, the user must provide a code when
* requesting a set of temporary security credentials. A user who fails to provide the code receives an
* "access denied" response when requesting resources that require MFA authentication.
*
* The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSessionTokenRequest withTokenCode(String tokenCode) {
setTokenCode(tokenCode);
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 (getDurationSeconds() != null)
sb.append("DurationSeconds: ").append(getDurationSeconds()).append(",");
if (getSerialNumber() != null)
sb.append("SerialNumber: ").append(getSerialNumber()).append(",");
if (getTokenCode() != null)
sb.append("TokenCode: ").append(getTokenCode());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetSessionTokenRequest == false)
return false;
GetSessionTokenRequest other = (GetSessionTokenRequest) obj;
if (other.getDurationSeconds() == null ^ this.getDurationSeconds() == null)
return false;
if (other.getDurationSeconds() != null && other.getDurationSeconds().equals(this.getDurationSeconds()) == false)
return false;
if (other.getSerialNumber() == null ^ this.getSerialNumber() == null)
return false;
if (other.getSerialNumber() != null && other.getSerialNumber().equals(this.getSerialNumber()) == false)
return false;
if (other.getTokenCode() == null ^ this.getTokenCode() == null)
return false;
if (other.getTokenCode() != null && other.getTokenCode().equals(this.getTokenCode()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDurationSeconds() == null) ? 0 : getDurationSeconds().hashCode());
hashCode = prime * hashCode + ((getSerialNumber() == null) ? 0 : getSerialNumber().hashCode());
hashCode = prime * hashCode + ((getTokenCode() == null) ? 0 : getTokenCode().hashCode());
return hashCode;
}
@Override
public GetSessionTokenRequest clone() {
return (GetSessionTokenRequest) super.clone();
}
}