Class IpAccessSettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<IpAccessSettings.Builder,
IpAccessSettings>
The IP access settings resource that can be associated with a web portal.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe additional encryption context of the IP access settings.A list of web portal ARNs that this IP access settings resource is associated with.static IpAccessSettings.Builder
builder()
final Instant
The creation date timestamp of the IP access settings.final String
The customer managed key used to encrypt sensitive information in the IP access settings.final String
The description of the IP access settings.final String
The display name of the IP access settings.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AdditionalEncryptionContext property.final boolean
For responses, this returns true if the service returned a value for the AssociatedPortalArns property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the IpRules property.final String
The ARN of the IP access settings resource.ipRules()
The IP rules of the IP access settings.static Class
<? extends IpAccessSettings.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasAdditionalEncryptionContext
public final boolean hasAdditionalEncryptionContext()For responses, this returns true if the service returned a value for the AdditionalEncryptionContext 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. -
additionalEncryptionContext
The additional encryption context of the IP access settings.
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
hasAdditionalEncryptionContext()
method.- Returns:
- The additional encryption context of the IP access settings.
-
hasAssociatedPortalArns
public final boolean hasAssociatedPortalArns()For responses, this returns true if the service returned a value for the AssociatedPortalArns 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. -
associatedPortalArns
A list of web portal ARNs that this IP access settings resource is associated with.
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
hasAssociatedPortalArns()
method.- Returns:
- A list of web portal ARNs that this IP access settings resource is associated with.
-
creationDate
The creation date timestamp of the IP access settings.
- Returns:
- The creation date timestamp of the IP access settings.
-
customerManagedKey
The customer managed key used to encrypt sensitive information in the IP access settings.
- Returns:
- The customer managed key used to encrypt sensitive information in the IP access settings.
-
description
The description of the IP access settings.
- Returns:
- The description of the IP access settings.
-
displayName
The display name of the IP access settings.
- Returns:
- The display name of the IP access settings.
-
ipAccessSettingsArn
The ARN of the IP access settings resource.
- Returns:
- The ARN of the IP access settings resource.
-
hasIpRules
public final boolean hasIpRules()For responses, this returns true if the service returned a value for the IpRules 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. -
ipRules
The IP rules of the IP access settings.
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
hasIpRules()
method.- Returns:
- The IP rules of the IP access settings.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<IpAccessSettings.Builder,
IpAccessSettings> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
-
sdkFields
-