Class: Aws::IdentityStore::Types::NetworkConfiguration

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. You provide this object in a request.

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 you don't specify a value, no such IP address exception applies.

Returns:

  • (Array<String>) 


1906
1907
1908
1909
1910
1911
1912
1913
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1906

class NetworkConfiguration < 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 you specified one. If you don't specify a value, access isn't restricted to specific VPCs, but the VPC endpoint requirement set by VpceAccessRequired still applies.

Returns:

  • (Array<String>) 


1906
1907
1908
1909
1910
1911
1912
1913
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1906

class NetworkConfiguration < 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 you don't specify a value, SCIM requests remain subject to the identity store's other network controls, such as the VPC endpoint requirement set by VpceAccessRequired.

For example, to allow SCIM traffic from the public internet while still requiring the identity store API operations to be accessed through a VPC endpoint, set VpceAccessRequired to true and set this value to 0.0.0.0/0.

Returns:

  • (Array<String>) 


1906
1907
1908
1909
1910
1911
1912
1913
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1906

class NetworkConfiguration < 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.

This value must be set to either true or false when you provide NetworkConfiguration in a request.

Returns:

  • (Boolean) 


1906
1907
1908
1909
1910
1911
1912
1913
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1906

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