Class: Aws::IdentityStore::Types::NetworkConfigurationDetails

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb

Overview

The network configuration that controls how an identity store can be accessed. This object is returned as part of service API responses.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_allow_source_ips ⇒ Array<String>

A list of IP address CIDR ranges that are allowed to access the identity store API operations. A request from an IP address in this list bypasses the identity store's other API network controls: it's permitted even if it doesn't come through a VPC endpoint required by VpceAccessRequired, and even if it doesn't originate from a VPC in ApiRestrictSourceVpcs. If this field is empty, no such IP address exception applies.

Returns:

  • (Array<String>) 


1954
1955
1956
1957
1958
1959
1960
1961
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1954

class NetworkConfigurationDetails < Struct.new(
  :vpce_access_required,
  :api_restrict_source_vpcs,
  :api_allow_source_ips,
  :scim_allow_source_ips)
  SENSITIVE = []
  include Aws::Structure
end

#api_restrict_source_vpcs ⇒ Array<String>

A list of virtual private cloud (VPC) IDs that are allowed to access the identity store API operations. A request is denied unless it originates from a VPC in this list, or from an IP address in ApiAllowSourceIps if one is configured. If this field is empty, access isn't restricted to specific VPCs, but the VPC endpoint requirement from VpceAccessRequired still applies.

Returns:

  • (Array<String>) 


1954
1955
1956
1957
1958
1959
1960
1961
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1954

class NetworkConfigurationDetails < Struct.new(
  :vpce_access_required,
  :api_restrict_source_vpcs,
  :api_allow_source_ips,
  :scim_allow_source_ips)
  SENSITIVE = []
  include Aws::Structure
end

#scim_allow_source_ips ⇒ Array<String>

A list of IP address CIDR ranges that are allowed to access the identity store through the System for Cross-domain Identity Management (SCIM) protocol. Requests from IP addresses outside these ranges are denied. If this field is empty, SCIM requests remain subject to the identity store's other network controls, such as the VPC endpoint requirement.

Returns:

  • (Array<String>) 


1954
1955
1956
1957
1958
1959
1960
1961
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1954

class NetworkConfigurationDetails < Struct.new(
  :vpce_access_required,
  :api_restrict_source_vpcs,
  :api_allow_source_ips,
  :scim_allow_source_ips)
  SENSITIVE = []
  include Aws::Structure
end

#vpce_access_required ⇒ Boolean

Specifies whether the identity store can be accessed only through a virtual private cloud (VPC) endpoint. When set to true, requests must originate from a VPC endpoint.

Returns:

  • (Boolean) 


1954
1955
1956
1957
1958
1959
1960
1961
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1954

class NetworkConfigurationDetails < Struct.new(
  :vpce_access_required,
  :api_restrict_source_vpcs,
  :api_allow_source_ips,
  :scim_allow_source_ips)
  SENSITIVE = []
  include Aws::Structure
end