Class UpdateAuthenticationProfileRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.connect.model.ConnectRequest
-
- software.amazon.awssdk.services.connect.model.UpdateAuthenticationProfileRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateAuthenticationProfileRequest.Builder,UpdateAuthenticationProfileRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateAuthenticationProfileRequest extends ConnectRequest implements ToCopyableBuilder<UpdateAuthenticationProfileRequest.Builder,UpdateAuthenticationProfileRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
UpdateAuthenticationProfileRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>
allowedIps()
A list of IP address range strings that are allowed to access the instance.String
authenticationProfileId()
A unique identifier for the authentication profile.List<String>
blockedIps()
A list of IP address range strings that are blocked from accessing the instance.static UpdateAuthenticationProfileRequest.Builder
builder()
String
description()
The description for the authentication profile.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasAllowedIps()
For responses, this returns true if the service returned a value for the AllowedIps property.boolean
hasBlockedIps()
For responses, this returns true if the service returned a value for the BlockedIps property.int
hashCode()
String
instanceId()
The identifier of the Amazon Connect instance.String
name()
The name for the authentication profile.Integer
periodicSessionDuration()
The short lived session duration configuration for users logged in to Amazon Connect, in minutes.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends UpdateAuthenticationProfileRequest.Builder>
serializableBuilderClass()
UpdateAuthenticationProfileRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
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
-
authenticationProfileId
public final String authenticationProfileId()
A unique identifier for the authentication profile.
- Returns:
- A unique identifier for the authentication profile.
-
instanceId
public final String instanceId()
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Returns:
- The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
-
name
public final String name()
The name for the authentication profile.
- Returns:
- The name for the authentication profile.
-
description
public final String description()
The description for the authentication profile.
- Returns:
- The description for the authentication profile.
-
hasAllowedIps
public final boolean hasAllowedIps()
For responses, this returns true if the service returned a value for the AllowedIps property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
allowedIps
public final List<String> allowedIps()
A list of IP address range strings that are allowed to access the instance. For more information on how to configure IP addresses, seeConfigure session timeouts in the Amazon Connect Administrator Guide.
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
hasAllowedIps()
method.- Returns:
- A list of IP address range strings that are allowed to access the instance. For more information on how to configure IP addresses, seeConfigure session timeouts in the Amazon Connect Administrator Guide.
-
hasBlockedIps
public final boolean hasBlockedIps()
For responses, this returns true if the service returned a value for the BlockedIps property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
blockedIps
public final List<String> blockedIps()
A list of IP address range strings that are blocked from accessing the instance. For more information on how to configure IP addresses, For more information on how to configure IP addresses, see Configure IP-based access control in the Amazon Connect Administrator Guide.
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
hasBlockedIps()
method.- Returns:
- A list of IP address range strings that are blocked from accessing the instance. For more information on how to configure IP addresses, For more information on how to configure IP addresses, see Configure IP-based access control in the Amazon Connect Administrator Guide.
-
periodicSessionDuration
public final Integer periodicSessionDuration()
The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, For more information on how to configure IP addresses, see Configure session timeouts in the Amazon Connect Administrator Guide.
- Returns:
- The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, For more information on how to configure IP addresses, see Configure session timeouts in the Amazon Connect Administrator Guide.
-
toBuilder
public UpdateAuthenticationProfileRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateAuthenticationProfileRequest.Builder,UpdateAuthenticationProfileRequest>
- Specified by:
toBuilder
in classConnectRequest
-
builder
public static UpdateAuthenticationProfileRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateAuthenticationProfileRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-