Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

ServicePerimeter

Create a Service Perimeter. The longrunning operation from this RPC will have a successful status once the Service Perimeter has propagated to long-lasting storage. Service Perimeters containing errors will result in an error response for the first error encountered.

Create ServicePerimeter Resource

new ServicePerimeter(name: string, args: ServicePerimeterArgs, opts?: CustomResourceOptions);
@overload
def ServicePerimeter(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     access_policy_id: Optional[str] = None,
                     description: Optional[str] = None,
                     name: Optional[str] = None,
                     perimeter_type: Optional[ServicePerimeterPerimeterType] = None,
                     title: Optional[str] = None)
@overload
def ServicePerimeter(resource_name: str,
                     args: ServicePerimeterArgs,
                     opts: Optional[ResourceOptions] = None)
func NewServicePerimeter(ctx *Context, name string, args ServicePerimeterArgs, opts ...ResourceOption) (*ServicePerimeter, error)
public ServicePerimeter(string name, ServicePerimeterArgs args, CustomResourceOptions? opts = null)
public ServicePerimeter(String name, ServicePerimeterArgs args)
public ServicePerimeter(String name, ServicePerimeterArgs args, CustomResourceOptions options)
type: google-native:accesscontextmanager/v1beta:ServicePerimeter
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ServicePerimeterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ServicePerimeterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ServicePerimeterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ServicePerimeterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ServicePerimeterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ServicePerimeter Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ServicePerimeter resource accepts the following input properties:

AccessPolicyId string
Description string

Description of the ServicePerimeter and its use. Does not affect behavior.

Name string

Resource name for the ServicePerimeter. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policy_id}/servicePerimeters/{short_name}

PerimeterType Pulumi.GoogleNative.AccessContextManager.V1Beta.ServicePerimeterPerimeterType

Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, restricted/unrestricted service lists as well as access lists must be empty.

Title string

Human readable title. Must be unique within the Policy.

AccessPolicyId string
Description string

Description of the ServicePerimeter and its use. Does not affect behavior.

Name string

Resource name for the ServicePerimeter. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policy_id}/servicePerimeters/{short_name}

PerimeterType ServicePerimeterPerimeterType

Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, restricted/unrestricted service lists as well as access lists must be empty.

Title string

Human readable title. Must be unique within the Policy.

accessPolicyId String
description String

Description of the ServicePerimeter and its use. Does not affect behavior.

name String

Resource name for the ServicePerimeter. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policy_id}/servicePerimeters/{short_name}

perimeterType ServicePerimeterPerimeterType

Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, restricted/unrestricted service lists as well as access lists must be empty.

title String

Human readable title. Must be unique within the Policy.

accessPolicyId string
description string

Description of the ServicePerimeter and its use. Does not affect behavior.

name string

Resource name for the ServicePerimeter. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policy_id}/servicePerimeters/{short_name}

perimeterType ServicePerimeterPerimeterType

Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, restricted/unrestricted service lists as well as access lists must be empty.

title string

Human readable title. Must be unique within the Policy.

access_policy_id str
description str

Description of the ServicePerimeter and its use. Does not affect behavior.

name str

Resource name for the ServicePerimeter. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policy_id}/servicePerimeters/{short_name}

perimeter_type ServicePerimeterPerimeterType

Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, restricted/unrestricted service lists as well as access lists must be empty.

title str

Human readable title. Must be unique within the Policy.

accessPolicyId String
description String

Description of the ServicePerimeter and its use. Does not affect behavior.

name String

Resource name for the ServicePerimeter. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policy_id}/servicePerimeters/{short_name}

perimeterType "PERIMETER_TYPE_REGULAR" | "PERIMETER_TYPE_BRIDGE"

Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, restricted/unrestricted service lists as well as access lists must be empty.

title String

Human readable title. Must be unique within the Policy.

Outputs

All input properties are implicitly available as output properties. Additionally, the ServicePerimeter resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Status Pulumi.GoogleNative.AccessContextManager.V1Beta.Outputs.ServicePerimeterConfigResponse

Current ServicePerimeter configuration. Specifies sets of resources, restricted/unrestricted services and access levels that determine perimeter content and boundaries.

Id string

The provider-assigned unique ID for this managed resource.

Status ServicePerimeterConfigResponse

Current ServicePerimeter configuration. Specifies sets of resources, restricted/unrestricted services and access levels that determine perimeter content and boundaries.

id String

The provider-assigned unique ID for this managed resource.

status ServicePerimeterConfigResponse

Current ServicePerimeter configuration. Specifies sets of resources, restricted/unrestricted services and access levels that determine perimeter content and boundaries.

id string

The provider-assigned unique ID for this managed resource.

status ServicePerimeterConfigResponse

Current ServicePerimeter configuration. Specifies sets of resources, restricted/unrestricted services and access levels that determine perimeter content and boundaries.

id str

The provider-assigned unique ID for this managed resource.

status ServicePerimeterConfigResponse

Current ServicePerimeter configuration. Specifies sets of resources, restricted/unrestricted services and access levels that determine perimeter content and boundaries.

id String

The provider-assigned unique ID for this managed resource.

status Property Map

Current ServicePerimeter configuration. Specifies sets of resources, restricted/unrestricted services and access levels that determine perimeter content and boundaries.

Supporting Types

ServicePerimeterConfigResponse

AccessLevels List<string>

A list of AccessLevel resource names that allow resources within the ServicePerimeter to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel is a syntax error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: "accessPolicies/MY_POLICY/accessLevels/MY_LEVEL". For Service Perimeter Bridge, must be empty.

Resources List<string>

A list of Google Cloud resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}

RestrictedServices List<string>

Google Cloud services that are subject to the Service Perimeter restrictions. Must contain a list of services. For example, if storage.googleapis.com is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions.

UnrestrictedServices List<string>

Google Cloud services that are not subject to the Service Perimeter restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard means that unless explicitly specified by "restricted_services" list, any service is treated as unrestricted.

Deprecated:

Google Cloud services that are not subject to the Service Perimeter restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard means that unless explicitly specified by "restricted_services" list, any service is treated as unrestricted.

VpcAccessibleServices Pulumi.GoogleNative.AccessContextManager.V1Beta.Inputs.VpcAccessibleServicesResponse

Beta. Configuration for APIs allowed within Perimeter.

AccessLevels []string

A list of AccessLevel resource names that allow resources within the ServicePerimeter to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel is a syntax error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: "accessPolicies/MY_POLICY/accessLevels/MY_LEVEL". For Service Perimeter Bridge, must be empty.

Resources []string

A list of Google Cloud resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}

RestrictedServices []string

Google Cloud services that are subject to the Service Perimeter restrictions. Must contain a list of services. For example, if storage.googleapis.com is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions.

UnrestrictedServices []string

Google Cloud services that are not subject to the Service Perimeter restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard means that unless explicitly specified by "restricted_services" list, any service is treated as unrestricted.

Deprecated:

Google Cloud services that are not subject to the Service Perimeter restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard means that unless explicitly specified by "restricted_services" list, any service is treated as unrestricted.

VpcAccessibleServices VpcAccessibleServicesResponse

Beta. Configuration for APIs allowed within Perimeter.

accessLevels List<String>

A list of AccessLevel resource names that allow resources within the ServicePerimeter to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel is a syntax error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: "accessPolicies/MY_POLICY/accessLevels/MY_LEVEL". For Service Perimeter Bridge, must be empty.

resources List<String>

A list of Google Cloud resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}

restrictedServices List<String>

Google Cloud services that are subject to the Service Perimeter restrictions. Must contain a list of services. For example, if storage.googleapis.com is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions.

unrestrictedServices List<String>

Google Cloud services that are not subject to the Service Perimeter restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard means that unless explicitly specified by "restricted_services" list, any service is treated as unrestricted.

Deprecated:

Google Cloud services that are not subject to the Service Perimeter restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard means that unless explicitly specified by "restricted_services" list, any service is treated as unrestricted.

vpcAccessibleServices VpcAccessibleServicesResponse

Beta. Configuration for APIs allowed within Perimeter.

accessLevels string[]

A list of AccessLevel resource names that allow resources within the ServicePerimeter to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel is a syntax error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: "accessPolicies/MY_POLICY/accessLevels/MY_LEVEL". For Service Perimeter Bridge, must be empty.

resources string[]

A list of Google Cloud resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}

restrictedServices string[]

Google Cloud services that are subject to the Service Perimeter restrictions. Must contain a list of services. For example, if storage.googleapis.com is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions.

unrestrictedServices string[]

Google Cloud services that are not subject to the Service Perimeter restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard means that unless explicitly specified by "restricted_services" list, any service is treated as unrestricted.

Deprecated:

Google Cloud services that are not subject to the Service Perimeter restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard means that unless explicitly specified by "restricted_services" list, any service is treated as unrestricted.

vpcAccessibleServices VpcAccessibleServicesResponse

Beta. Configuration for APIs allowed within Perimeter.

access_levels Sequence[str]

A list of AccessLevel resource names that allow resources within the ServicePerimeter to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel is a syntax error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: "accessPolicies/MY_POLICY/accessLevels/MY_LEVEL". For Service Perimeter Bridge, must be empty.

resources Sequence[str]

A list of Google Cloud resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}

restricted_services Sequence[str]

Google Cloud services that are subject to the Service Perimeter restrictions. Must contain a list of services. For example, if storage.googleapis.com is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions.

unrestricted_services Sequence[str]

Google Cloud services that are not subject to the Service Perimeter restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard means that unless explicitly specified by "restricted_services" list, any service is treated as unrestricted.

Deprecated:

Google Cloud services that are not subject to the Service Perimeter restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard means that unless explicitly specified by "restricted_services" list, any service is treated as unrestricted.

vpc_accessible_services VpcAccessibleServicesResponse

Beta. Configuration for APIs allowed within Perimeter.

accessLevels List<String>

A list of AccessLevel resource names that allow resources within the ServicePerimeter to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel is a syntax error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: "accessPolicies/MY_POLICY/accessLevels/MY_LEVEL". For Service Perimeter Bridge, must be empty.

resources List<String>

A list of Google Cloud resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}

restrictedServices List<String>

Google Cloud services that are subject to the Service Perimeter restrictions. Must contain a list of services. For example, if storage.googleapis.com is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions.

unrestrictedServices List<String>

Google Cloud services that are not subject to the Service Perimeter restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard means that unless explicitly specified by "restricted_services" list, any service is treated as unrestricted.

Deprecated:

Google Cloud services that are not subject to the Service Perimeter restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard means that unless explicitly specified by "restricted_services" list, any service is treated as unrestricted.

vpcAccessibleServices Property Map

Beta. Configuration for APIs allowed within Perimeter.

ServicePerimeterPerimeterType

PerimeterTypeRegular
PERIMETER_TYPE_REGULAR

Regular Perimeter.

PerimeterTypeBridge
PERIMETER_TYPE_BRIDGE

Perimeter Bridge.

ServicePerimeterPerimeterTypePerimeterTypeRegular
PERIMETER_TYPE_REGULAR

Regular Perimeter.

ServicePerimeterPerimeterTypePerimeterTypeBridge
PERIMETER_TYPE_BRIDGE

Perimeter Bridge.

PerimeterTypeRegular
PERIMETER_TYPE_REGULAR

Regular Perimeter.

PerimeterTypeBridge
PERIMETER_TYPE_BRIDGE

Perimeter Bridge.

PerimeterTypeRegular
PERIMETER_TYPE_REGULAR

Regular Perimeter.

PerimeterTypeBridge
PERIMETER_TYPE_BRIDGE

Perimeter Bridge.

PERIMETER_TYPE_REGULAR
PERIMETER_TYPE_REGULAR

Regular Perimeter.

PERIMETER_TYPE_BRIDGE
PERIMETER_TYPE_BRIDGE

Perimeter Bridge.

"PERIMETER_TYPE_REGULAR"
PERIMETER_TYPE_REGULAR

Regular Perimeter.

"PERIMETER_TYPE_BRIDGE"
PERIMETER_TYPE_BRIDGE

Perimeter Bridge.

VpcAccessibleServicesResponse

AllowedServices List<string>

The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter.

EnableRestriction bool

Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'.

AllowedServices []string

The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter.

EnableRestriction bool

Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'.

allowedServices List<String>

The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter.

enableRestriction Boolean

Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'.

allowedServices string[]

The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter.

enableRestriction boolean

Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'.

allowed_services Sequence[str]

The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter.

enable_restriction bool

Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'.

allowedServices List<String>

The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter.

enableRestriction Boolean

Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0