Class NetworkConfigurationInfo
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<NetworkConfigurationInfo.Builder,NetworkConfigurationInfo>
The network access controls for your Identity Center instance. These controls restrict which networks can reach your instance and applications.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionAllows access from the IPv4 or IPv6 CIDR blocks that you specify, in addition to the VPCs allowed byRestrictSourceVpcs.builder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.Exempts the applications that you specify from the network access control, so that access to them is unchanged.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the AllowSourceIps property.final booleanFor responses, this returns true if the service returned a value for the ExcludeApplicationArns property.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the RestrictSourceVpcs property.Limits access to the VPC endpoints in the VPCs that you specify.static Class<? extends NetworkConfigurationInfo.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final BooleanSpecifies whether access to your Identity Center instance and to applications must originate from a VPC endpoint.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
vpceAccessRequired
Specifies whether access to your Identity Center instance and to applications must originate from a VPC endpoint. When this value is
trueand no other field is specified, access is allowed from any VPC in your organization, or from any VPC in the Amazon Web Services account for an account instance, and applies to all applications. When this value isfalse, no network access control is enforced and the values ofRestrictSourceVpcs,AllowSourceIps, andExcludeApplicationArnsare cleared.- Returns:
- Specifies whether access to your Identity Center instance and to applications must originate from a VPC
endpoint. When this value is
trueand no other field is specified, access is allowed from any VPC in your organization, or from any VPC in the Amazon Web Services account for an account instance, and applies to all applications. When this value isfalse, no network access control is enforced and the values ofRestrictSourceVpcs,AllowSourceIps, andExcludeApplicationArnsare cleared.
-
hasRestrictSourceVpcs
public final boolean hasRestrictSourceVpcs()For responses, this returns true if the service returned a value for the RestrictSourceVpcs 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. -
restrictSourceVpcs
Limits access to the VPC endpoints in the VPCs that you specify. These VPCs must be in your organization, or in the Amazon Web Services account for an account instance. If you don't specify this value, access is allowed from any VPC in your organization or Amazon Web Services account.
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
hasRestrictSourceVpcs()method.- Returns:
- Limits access to the VPC endpoints in the VPCs that you specify. These VPCs must be in your organization, or in the Amazon Web Services account for an account instance. If you don't specify this value, access is allowed from any VPC in your organization or Amazon Web Services account.
-
hasAllowSourceIps
public final boolean hasAllowSourceIps()For responses, this returns true if the service returned a value for the AllowSourceIps 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. -
allowSourceIps
Allows access from the IPv4 or IPv6 CIDR blocks that you specify, in addition to the VPCs allowed by
RestrictSourceVpcs. If you don't specify this value, no additional IP address ranges are allowed.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
hasAllowSourceIps()method.- Returns:
- Allows access from the IPv4 or IPv6 CIDR blocks that you specify, in addition to the VPCs allowed by
RestrictSourceVpcs. If you don't specify this value, no additional IP address ranges are allowed.
-
hasExcludeApplicationArns
public final boolean hasExcludeApplicationArns()For responses, this returns true if the service returned a value for the ExcludeApplicationArns 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. -
excludeApplicationArns
Exempts the applications that you specify from the network access control, so that access to them is unchanged. You can specify both Amazon Web Services managed applications and customer managed applications, and you can use wildcards. These applications are not restricted by
RestrictSourceVpcsorAllowSourceIps. If you don't specify this value, the controls apply to all applications.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
hasExcludeApplicationArns()method.- Returns:
- Exempts the applications that you specify from the network access control, so that access to them is
unchanged. You can specify both Amazon Web Services managed applications and customer managed
applications, and you can use wildcards. These applications are not restricted by
RestrictSourceVpcsorAllowSourceIps. If you don't specify this value, the controls apply to all applications.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<NetworkConfigurationInfo.Builder,NetworkConfigurationInfo> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin 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
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-