Skip to content

accesscontextmanager.v1beta1.servicePerimeter

"ServicePerimeter is the Schema for the ServicePerimeters API. ServicePerimeter describes a set of GCP resources which can freely import and export data amongst themselves, but not export outside of the ServicePerimeter."

Index

Fields

fn new

new(name)

new returns an instance of ServicePerimeter

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"ServicePerimeterSpec defines the desired state of ServicePerimeter"

fn spec.withDeletionPolicy

withDeletionPolicy(deletionPolicy)

"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223"

fn spec.withManagementPolicies

withManagementPolicies(managementPolicies)

"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"

fn spec.withManagementPoliciesMixin

withManagementPoliciesMixin(managementPolicies)

"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"

Note: This function appends passed data to existing values

obj spec.forProvider

fn spec.forProvider.withDescription

withDescription(description)

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

fn spec.forProvider.withName

withName(name)

"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}"

fn spec.forProvider.withParent

withParent(parent)

"The AccessPolicy this ServicePerimeter lives in. Format: accessPolicies/{policy_id}"

fn spec.forProvider.withPerimeterType

withPerimeterType(perimeterType)

"Specifies the type of the Perimeter. There are two types: regular and bridge. Regular Service Perimeter contains resources, access levels, and restricted services. Every resource can be in at most ONE regular Service Perimeter. In addition to being in a regular service perimeter, a resource can also be in zero or more perimeter bridges. A perimeter bridge only contains resources. Cross project operations are permitted if all effected resources share some perimeter (whether bridge or regular). Perimeter Bridge does not contain access levels or services: those are governed entirely by the regular perimeter that resource is in. Perimeter Bridges are typically useful when building more complex topologies with many independent perimeters that need to share some data with a common perimeter, but should not be able to share data among themselves. Default value is PERIMETER_TYPE_REGULAR. Possible values are: PERIMETER_TYPE_REGULAR, PERIMETER_TYPE_BRIDGE."

fn spec.forProvider.withSpec

withSpec(spec)

"Proposed (or dry run) ServicePerimeter configuration. This configuration allows to specify and test ServicePerimeter configuration without enforcing actual access restrictions. Only allowed to be set when the useExplicitDryRunSpec flag is set. Structure is documented below."

fn spec.forProvider.withSpecMixin

withSpecMixin(spec)

"Proposed (or dry run) ServicePerimeter configuration. This configuration allows to specify and test ServicePerimeter configuration without enforcing actual access restrictions. Only allowed to be set when the useExplicitDryRunSpec flag is set. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withTitle

withTitle(title)

"Human readable title. Must be unique within the Policy."

fn spec.forProvider.withUseExplicitDryRunSpec

withUseExplicitDryRunSpec(useExplicitDryRunSpec)

"Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly exists for all Service Perimeters, and that spec is identical to the status for those Service Perimeters. When this flag is set, it inhibits the generation of the implicit spec, thereby allowing the user to explicitly provide a configuration (\"spec\") to use in a dry-run version of the Service Perimeter. This allows the user to test changes to the enforced config (\"status\") without actually enforcing them. This testing is done through analyzing the differences between currently enforced and suggested restrictions. useExplicitDryRunSpec must bet set to True if any of the fields in the spec are set to non-default values."

obj spec.forProvider.spec

"Proposed (or dry run) ServicePerimeter configuration. This configuration allows to specify and test ServicePerimeter configuration without enforcing actual access restrictions. Only allowed to be set when the useExplicitDryRunSpec flag is set. Structure is documented below."

fn spec.forProvider.spec.withAccessLevels

withAccessLevels(accessLevels)

"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 GCP calls with request origins within the perimeter. For Service Perimeter Bridge, must be empty. Format: accessPolicies/{policy_id}/accessLevels/{access_level_name}"

fn spec.forProvider.spec.withAccessLevelsMixin

withAccessLevelsMixin(accessLevels)

"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 GCP calls with request origins within the perimeter. For Service Perimeter Bridge, must be empty. Format: accessPolicies/{policy_id}/accessLevels/{access_level_name}"

Note: This function appends passed data to existing values

fn spec.forProvider.spec.withAccessLevelsRefs

withAccessLevelsRefs(accessLevelsRefs)

"References to AccessLevel to populate accessLevels."

fn spec.forProvider.spec.withAccessLevelsRefsMixin

withAccessLevelsRefsMixin(accessLevelsRefs)

"References to AccessLevel to populate accessLevels."

Note: This function appends passed data to existing values

fn spec.forProvider.spec.withEgressPolicies

withEgressPolicies(egressPolicies)

"List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. Structure is documented below."

fn spec.forProvider.spec.withEgressPoliciesMixin

withEgressPoliciesMixin(egressPolicies)

"List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.spec.withIngressPolicies

withIngressPolicies(ingressPolicies)

"List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. Structure is documented below."

fn spec.forProvider.spec.withIngressPoliciesMixin

withIngressPoliciesMixin(ingressPolicies)

"List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.spec.withResources

withResources(resources)

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

fn spec.forProvider.spec.withResourcesMixin

withResourcesMixin(resources)

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

Note: This function appends passed data to existing values

fn spec.forProvider.spec.withRestrictedServices

withRestrictedServices(restrictedServices)

"GCP 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."

fn spec.forProvider.spec.withRestrictedServicesMixin

withRestrictedServicesMixin(restrictedServices)

"GCP 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."

Note: This function appends passed data to existing values

fn spec.forProvider.spec.withVpcAccessibleServices

withVpcAccessibleServices(vpcAccessibleServices)

"Specifies how APIs are allowed to communicate within the Service Perimeter. Structure is documented below."

fn spec.forProvider.spec.withVpcAccessibleServicesMixin

withVpcAccessibleServicesMixin(vpcAccessibleServices)

"Specifies how APIs are allowed to communicate within the Service Perimeter. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.spec.accessLevelsRefs

"References to AccessLevel to populate accessLevels."

fn spec.forProvider.spec.accessLevelsRefs.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.spec.accessLevelsRefs.policy

"Policies for referencing."

fn spec.forProvider.spec.accessLevelsRefs.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.spec.accessLevelsRefs.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.spec.accessLevelsSelector

"Selector for a list of AccessLevel to populate accessLevels."

fn spec.forProvider.spec.accessLevelsSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.spec.accessLevelsSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.spec.accessLevelsSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.spec.accessLevelsSelector.policy

"Policies for selection."

fn spec.forProvider.spec.accessLevelsSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.spec.accessLevelsSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.spec.egressPolicies

"List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. Structure is documented below."

fn spec.forProvider.spec.egressPolicies.withEgressFrom

withEgressFrom(egressFrom)

"Defines conditions on the source of a request causing this EgressPolicy to apply. Structure is documented below."

fn spec.forProvider.spec.egressPolicies.withEgressFromMixin

withEgressFromMixin(egressFrom)

"Defines conditions on the source of a request causing this EgressPolicy to apply. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.spec.egressPolicies.withEgressTo

withEgressTo(egressTo)

"Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. Structure is documented below."

fn spec.forProvider.spec.egressPolicies.withEgressToMixin

withEgressToMixin(egressTo)

"Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.spec.egressPolicies.egressFrom

"Defines conditions on the source of a request causing this EgressPolicy to apply. Structure is documented below."

fn spec.forProvider.spec.egressPolicies.egressFrom.withIdentities

withIdentities(identities)

"A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only."

fn spec.forProvider.spec.egressPolicies.egressFrom.withIdentitiesMixin

withIdentitiesMixin(identities)

"A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only."

Note: This function appends passed data to existing values

fn spec.forProvider.spec.egressPolicies.egressFrom.withIdentityType

withIdentityType(identityType)

"Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of identities field will be allowed access. Possible values are: IDENTITY_TYPE_UNSPECIFIED, ANY_IDENTITY, ANY_USER_ACCOUNT, ANY_SERVICE_ACCOUNT."

obj spec.forProvider.spec.egressPolicies.egressTo

"Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. Structure is documented below."

fn spec.forProvider.spec.egressPolicies.egressTo.withExternalResources

withExternalResources(externalResources)

"A list of external resources that are allowed to be accessed. A request matches if it contains an external resource in this list (Example: s3://bucket/path). Currently '*' is not allowed."

fn spec.forProvider.spec.egressPolicies.egressTo.withExternalResourcesMixin

withExternalResourcesMixin(externalResources)

"A list of external resources that are allowed to be accessed. A request matches if it contains an external resource in this list (Example: s3://bucket/path). Currently '*' is not allowed."

Note: This function appends passed data to existing values

fn spec.forProvider.spec.egressPolicies.egressTo.withOperations

withOperations(operations)

"A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. Structure is documented below."

fn spec.forProvider.spec.egressPolicies.egressTo.withOperationsMixin

withOperationsMixin(operations)

"A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.spec.egressPolicies.egressTo.withResources

withResources(resources)

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

fn spec.forProvider.spec.egressPolicies.egressTo.withResourcesMixin

withResourcesMixin(resources)

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

Note: This function appends passed data to existing values

obj spec.forProvider.spec.egressPolicies.egressTo.operations

"A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. Structure is documented below."

fn spec.forProvider.spec.egressPolicies.egressTo.operations.withMethodSelectors

withMethodSelectors(methodSelectors)

"API methods or permissions to allow. Method or permission must belong to the service specified by serviceName field. A single MethodSelector entry with * specified for the method field will allow all methods AND permissions for the service specified in serviceName. Structure is documented below."

fn spec.forProvider.spec.egressPolicies.egressTo.operations.withMethodSelectorsMixin

withMethodSelectorsMixin(methodSelectors)

"API methods or permissions to allow. Method or permission must belong to the service specified by serviceName field. A single MethodSelector entry with * specified for the method field will allow all methods AND permissions for the service specified in serviceName. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.spec.egressPolicies.egressTo.operations.withServiceName

withServiceName(serviceName)

"The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with serviceName field set to * will allow all methods AND permissions for all services."

obj spec.forProvider.spec.egressPolicies.egressTo.operations.methodSelectors

"API methods or permissions to allow. Method or permission must belong to the service specified by serviceName field. A single MethodSelector entry with * specified for the method field will allow all methods AND permissions for the service specified in serviceName. Structure is documented below."

fn spec.forProvider.spec.egressPolicies.egressTo.operations.methodSelectors.withMethod

withMethod(method)

"Value for method should be a valid method name for the corresponding serviceName in ApiOperation. If * used as value for method, then ALL methods and permissions are allowed."

fn spec.forProvider.spec.egressPolicies.egressTo.operations.methodSelectors.withPermission

withPermission(permission)

"Value for permission should be a valid Cloud IAM permission for the corresponding serviceName in ApiOperation."

obj spec.forProvider.spec.ingressPolicies

"List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. Structure is documented below."

fn spec.forProvider.spec.ingressPolicies.withIngressFrom

withIngressFrom(ingressFrom)

"Defines the conditions on the source of a request causing this IngressPolicy to apply. Structure is documented below."

fn spec.forProvider.spec.ingressPolicies.withIngressFromMixin

withIngressFromMixin(ingressFrom)

"Defines the conditions on the source of a request causing this IngressPolicy to apply. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.spec.ingressPolicies.withIngressTo

withIngressTo(ingressTo)

"Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. Structure is documented below."

fn spec.forProvider.spec.ingressPolicies.withIngressToMixin

withIngressToMixin(ingressTo)

"Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.spec.ingressPolicies.ingressFrom

"Defines the conditions on the source of a request causing this IngressPolicy to apply. Structure is documented below."

fn spec.forProvider.spec.ingressPolicies.ingressFrom.withIdentities

withIdentities(identities)

"A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only."

fn spec.forProvider.spec.ingressPolicies.ingressFrom.withIdentitiesMixin

withIdentitiesMixin(identities)

"A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only."

Note: This function appends passed data to existing values

fn spec.forProvider.spec.ingressPolicies.ingressFrom.withIdentityType

withIdentityType(identityType)

"Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of identities field will be allowed access. Possible values are: IDENTITY_TYPE_UNSPECIFIED, ANY_IDENTITY, ANY_USER_ACCOUNT, ANY_SERVICE_ACCOUNT."

fn spec.forProvider.spec.ingressPolicies.ingressFrom.withSources

withSources(sources)

"Sources that this IngressPolicy authorizes access from. Structure is documented below."

fn spec.forProvider.spec.ingressPolicies.ingressFrom.withSourcesMixin

withSourcesMixin(sources)

"Sources that this IngressPolicy authorizes access from. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.spec.ingressPolicies.ingressFrom.sources

"Sources that this IngressPolicy authorizes access from. Structure is documented below."

fn spec.forProvider.spec.ingressPolicies.ingressFrom.sources.withAccessLevel

withAccessLevel(accessLevel)

"An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an 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. If * is specified, then all IngressSources will be allowed."

fn spec.forProvider.spec.ingressPolicies.ingressFrom.sources.withResource

withResource(resource)

"A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects are allowed. Format projects/{project_number} The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. * is not allowed, the case of allowing all Google Cloud resources only is not supported."

obj spec.forProvider.spec.ingressPolicies.ingressTo

"Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. Structure is documented below."

fn spec.forProvider.spec.ingressPolicies.ingressTo.withOperations

withOperations(operations)

"A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. Structure is documented below."

fn spec.forProvider.spec.ingressPolicies.ingressTo.withOperationsMixin

withOperationsMixin(operations)

"A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.spec.ingressPolicies.ingressTo.withResources

withResources(resources)

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

fn spec.forProvider.spec.ingressPolicies.ingressTo.withResourcesMixin

withResourcesMixin(resources)

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

Note: This function appends passed data to existing values

obj spec.forProvider.spec.ingressPolicies.ingressTo.operations

"A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. Structure is documented below."

fn spec.forProvider.spec.ingressPolicies.ingressTo.operations.withMethodSelectors

withMethodSelectors(methodSelectors)

"API methods or permissions to allow. Method or permission must belong to the service specified by serviceName field. A single MethodSelector entry with * specified for the method field will allow all methods AND permissions for the service specified in serviceName. Structure is documented below."

fn spec.forProvider.spec.ingressPolicies.ingressTo.operations.withMethodSelectorsMixin

withMethodSelectorsMixin(methodSelectors)

"API methods or permissions to allow. Method or permission must belong to the service specified by serviceName field. A single MethodSelector entry with * specified for the method field will allow all methods AND permissions for the service specified in serviceName. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.spec.ingressPolicies.ingressTo.operations.withServiceName

withServiceName(serviceName)

"The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with serviceName field set to * will allow all methods AND permissions for all services."

obj spec.forProvider.spec.ingressPolicies.ingressTo.operations.methodSelectors

"API methods or permissions to allow. Method or permission must belong to the service specified by serviceName field. A single MethodSelector entry with * specified for the method field will allow all methods AND permissions for the service specified in serviceName. Structure is documented below."

fn spec.forProvider.spec.ingressPolicies.ingressTo.operations.methodSelectors.withMethod

withMethod(method)

"Value for method should be a valid method name for the corresponding serviceName in ApiOperation. If * used as value for method, then ALL methods and permissions are allowed."

fn spec.forProvider.spec.ingressPolicies.ingressTo.operations.methodSelectors.withPermission

withPermission(permission)

"Value for permission should be a valid Cloud IAM permission for the corresponding serviceName in ApiOperation."

obj spec.forProvider.spec.vpcAccessibleServices

"Specifies how APIs are allowed to communicate within the Service Perimeter. Structure is documented below."

fn spec.forProvider.spec.vpcAccessibleServices.withAllowedServices

withAllowedServices(allowedServices)

"The list of APIs usable within the Service Perimeter. Must be empty unless enableRestriction is True."

fn spec.forProvider.spec.vpcAccessibleServices.withAllowedServicesMixin

withAllowedServicesMixin(allowedServices)

"The list of APIs usable within the Service Perimeter. Must be empty unless enableRestriction is True."

Note: This function appends passed data to existing values

fn spec.forProvider.spec.vpcAccessibleServices.withEnableRestriction

withEnableRestriction(enableRestriction)

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

obj spec.initProvider

"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler."

fn spec.initProvider.withDescription

withDescription(description)

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

fn spec.initProvider.withName

withName(name)

"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}"

fn spec.initProvider.withParent

withParent(parent)

"The AccessPolicy this ServicePerimeter lives in. Format: accessPolicies/{policy_id}"

fn spec.initProvider.withPerimeterType

withPerimeterType(perimeterType)

"Specifies the type of the Perimeter. There are two types: regular and bridge. Regular Service Perimeter contains resources, access levels, and restricted services. Every resource can be in at most ONE regular Service Perimeter. In addition to being in a regular service perimeter, a resource can also be in zero or more perimeter bridges. A perimeter bridge only contains resources. Cross project operations are permitted if all effected resources share some perimeter (whether bridge or regular). Perimeter Bridge does not contain access levels or services: those are governed entirely by the regular perimeter that resource is in. Perimeter Bridges are typically useful when building more complex topologies with many independent perimeters that need to share some data with a common perimeter, but should not be able to share data among themselves. Default value is PERIMETER_TYPE_REGULAR. Possible values are: PERIMETER_TYPE_REGULAR, PERIMETER_TYPE_BRIDGE."

fn spec.initProvider.withSpec

withSpec(spec)

"Proposed (or dry run) ServicePerimeter configuration. This configuration allows to specify and test ServicePerimeter configuration without enforcing actual access restrictions. Only allowed to be set when the useExplicitDryRunSpec flag is set. Structure is documented below."

fn spec.initProvider.withSpecMixin

withSpecMixin(spec)

"Proposed (or dry run) ServicePerimeter configuration. This configuration allows to specify and test ServicePerimeter configuration without enforcing actual access restrictions. Only allowed to be set when the useExplicitDryRunSpec flag is set. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withTitle

withTitle(title)

"Human readable title. Must be unique within the Policy."

fn spec.initProvider.withUseExplicitDryRunSpec

withUseExplicitDryRunSpec(useExplicitDryRunSpec)

"Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly exists for all Service Perimeters, and that spec is identical to the status for those Service Perimeters. When this flag is set, it inhibits the generation of the implicit spec, thereby allowing the user to explicitly provide a configuration (\"spec\") to use in a dry-run version of the Service Perimeter. This allows the user to test changes to the enforced config (\"status\") without actually enforcing them. This testing is done through analyzing the differences between currently enforced and suggested restrictions. useExplicitDryRunSpec must bet set to True if any of the fields in the spec are set to non-default values."

obj spec.initProvider.spec

"Proposed (or dry run) ServicePerimeter configuration. This configuration allows to specify and test ServicePerimeter configuration without enforcing actual access restrictions. Only allowed to be set when the useExplicitDryRunSpec flag is set. Structure is documented below."

fn spec.initProvider.spec.withEgressPolicies

withEgressPolicies(egressPolicies)

"List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. Structure is documented below."

fn spec.initProvider.spec.withEgressPoliciesMixin

withEgressPoliciesMixin(egressPolicies)

"List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.spec.withIngressPolicies

withIngressPolicies(ingressPolicies)

"List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. Structure is documented below."

fn spec.initProvider.spec.withIngressPoliciesMixin

withIngressPoliciesMixin(ingressPolicies)

"List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.spec.withResources

withResources(resources)

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

fn spec.initProvider.spec.withResourcesMixin

withResourcesMixin(resources)

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

Note: This function appends passed data to existing values

fn spec.initProvider.spec.withRestrictedServices

withRestrictedServices(restrictedServices)

"GCP 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."

fn spec.initProvider.spec.withRestrictedServicesMixin

withRestrictedServicesMixin(restrictedServices)

"GCP 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."

Note: This function appends passed data to existing values

fn spec.initProvider.spec.withVpcAccessibleServices

withVpcAccessibleServices(vpcAccessibleServices)

"Specifies how APIs are allowed to communicate within the Service Perimeter. Structure is documented below."

fn spec.initProvider.spec.withVpcAccessibleServicesMixin

withVpcAccessibleServicesMixin(vpcAccessibleServices)

"Specifies how APIs are allowed to communicate within the Service Perimeter. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.spec.egressPolicies

"List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. Structure is documented below."

fn spec.initProvider.spec.egressPolicies.withEgressFrom

withEgressFrom(egressFrom)

"Defines conditions on the source of a request causing this EgressPolicy to apply. Structure is documented below."

fn spec.initProvider.spec.egressPolicies.withEgressFromMixin

withEgressFromMixin(egressFrom)

"Defines conditions on the source of a request causing this EgressPolicy to apply. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.spec.egressPolicies.withEgressTo

withEgressTo(egressTo)

"Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. Structure is documented below."

fn spec.initProvider.spec.egressPolicies.withEgressToMixin

withEgressToMixin(egressTo)

"Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.spec.egressPolicies.egressFrom

"Defines conditions on the source of a request causing this EgressPolicy to apply. Structure is documented below."

fn spec.initProvider.spec.egressPolicies.egressFrom.withIdentities

withIdentities(identities)

"A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only."

fn spec.initProvider.spec.egressPolicies.egressFrom.withIdentitiesMixin

withIdentitiesMixin(identities)

"A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only."

Note: This function appends passed data to existing values

fn spec.initProvider.spec.egressPolicies.egressFrom.withIdentityType

withIdentityType(identityType)

"Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of identities field will be allowed access. Possible values are: IDENTITY_TYPE_UNSPECIFIED, ANY_IDENTITY, ANY_USER_ACCOUNT, ANY_SERVICE_ACCOUNT."

obj spec.initProvider.spec.egressPolicies.egressTo

"Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. Structure is documented below."

fn spec.initProvider.spec.egressPolicies.egressTo.withExternalResources

withExternalResources(externalResources)

"A list of external resources that are allowed to be accessed. A request matches if it contains an external resource in this list (Example: s3://bucket/path). Currently '*' is not allowed."

fn spec.initProvider.spec.egressPolicies.egressTo.withExternalResourcesMixin

withExternalResourcesMixin(externalResources)

"A list of external resources that are allowed to be accessed. A request matches if it contains an external resource in this list (Example: s3://bucket/path). Currently '*' is not allowed."

Note: This function appends passed data to existing values

fn spec.initProvider.spec.egressPolicies.egressTo.withOperations

withOperations(operations)

"A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. Structure is documented below."

fn spec.initProvider.spec.egressPolicies.egressTo.withOperationsMixin

withOperationsMixin(operations)

"A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.spec.egressPolicies.egressTo.withResources

withResources(resources)

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

fn spec.initProvider.spec.egressPolicies.egressTo.withResourcesMixin

withResourcesMixin(resources)

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

Note: This function appends passed data to existing values

obj spec.initProvider.spec.egressPolicies.egressTo.operations

"A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. Structure is documented below."

fn spec.initProvider.spec.egressPolicies.egressTo.operations.withMethodSelectors

withMethodSelectors(methodSelectors)

"API methods or permissions to allow. Method or permission must belong to the service specified by serviceName field. A single MethodSelector entry with * specified for the method field will allow all methods AND permissions for the service specified in serviceName. Structure is documented below."

fn spec.initProvider.spec.egressPolicies.egressTo.operations.withMethodSelectorsMixin

withMethodSelectorsMixin(methodSelectors)

"API methods or permissions to allow. Method or permission must belong to the service specified by serviceName field. A single MethodSelector entry with * specified for the method field will allow all methods AND permissions for the service specified in serviceName. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.spec.egressPolicies.egressTo.operations.withServiceName

withServiceName(serviceName)

"The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with serviceName field set to * will allow all methods AND permissions for all services."

obj spec.initProvider.spec.egressPolicies.egressTo.operations.methodSelectors

"API methods or permissions to allow. Method or permission must belong to the service specified by serviceName field. A single MethodSelector entry with * specified for the method field will allow all methods AND permissions for the service specified in serviceName. Structure is documented below."

fn spec.initProvider.spec.egressPolicies.egressTo.operations.methodSelectors.withMethod

withMethod(method)

"Value for method should be a valid method name for the corresponding serviceName in ApiOperation. If * used as value for method, then ALL methods and permissions are allowed."

fn spec.initProvider.spec.egressPolicies.egressTo.operations.methodSelectors.withPermission

withPermission(permission)

"Value for permission should be a valid Cloud IAM permission for the corresponding serviceName in ApiOperation."

obj spec.initProvider.spec.ingressPolicies

"List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. Structure is documented below."

fn spec.initProvider.spec.ingressPolicies.withIngressFrom

withIngressFrom(ingressFrom)

"Defines the conditions on the source of a request causing this IngressPolicy to apply. Structure is documented below."

fn spec.initProvider.spec.ingressPolicies.withIngressFromMixin

withIngressFromMixin(ingressFrom)

"Defines the conditions on the source of a request causing this IngressPolicy to apply. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.spec.ingressPolicies.withIngressTo

withIngressTo(ingressTo)

"Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. Structure is documented below."

fn spec.initProvider.spec.ingressPolicies.withIngressToMixin

withIngressToMixin(ingressTo)

"Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.spec.ingressPolicies.ingressFrom

"Defines the conditions on the source of a request causing this IngressPolicy to apply. Structure is documented below."

fn spec.initProvider.spec.ingressPolicies.ingressFrom.withIdentities

withIdentities(identities)

"A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only."

fn spec.initProvider.spec.ingressPolicies.ingressFrom.withIdentitiesMixin

withIdentitiesMixin(identities)

"A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only."

Note: This function appends passed data to existing values

fn spec.initProvider.spec.ingressPolicies.ingressFrom.withIdentityType

withIdentityType(identityType)

"Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of identities field will be allowed access. Possible values are: IDENTITY_TYPE_UNSPECIFIED, ANY_IDENTITY, ANY_USER_ACCOUNT, ANY_SERVICE_ACCOUNT."

fn spec.initProvider.spec.ingressPolicies.ingressFrom.withSources

withSources(sources)

"Sources that this IngressPolicy authorizes access from. Structure is documented below."

fn spec.initProvider.spec.ingressPolicies.ingressFrom.withSourcesMixin

withSourcesMixin(sources)

"Sources that this IngressPolicy authorizes access from. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.spec.ingressPolicies.ingressFrom.sources

"Sources that this IngressPolicy authorizes access from. Structure is documented below."

fn spec.initProvider.spec.ingressPolicies.ingressFrom.sources.withAccessLevel

withAccessLevel(accessLevel)

"An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an 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. If * is specified, then all IngressSources will be allowed."

fn spec.initProvider.spec.ingressPolicies.ingressFrom.sources.withResource

withResource(resource)

"A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects are allowed. Format projects/{project_number} The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. * is not allowed, the case of allowing all Google Cloud resources only is not supported."

obj spec.initProvider.spec.ingressPolicies.ingressTo

"Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. Structure is documented below."

fn spec.initProvider.spec.ingressPolicies.ingressTo.withOperations

withOperations(operations)

"A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. Structure is documented below."

fn spec.initProvider.spec.ingressPolicies.ingressTo.withOperationsMixin

withOperationsMixin(operations)

"A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.spec.ingressPolicies.ingressTo.withResources

withResources(resources)

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

fn spec.initProvider.spec.ingressPolicies.ingressTo.withResourcesMixin

withResourcesMixin(resources)

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

Note: This function appends passed data to existing values

obj spec.initProvider.spec.ingressPolicies.ingressTo.operations

"A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter. Structure is documented below."

fn spec.initProvider.spec.ingressPolicies.ingressTo.operations.withMethodSelectors

withMethodSelectors(methodSelectors)

"API methods or permissions to allow. Method or permission must belong to the service specified by serviceName field. A single MethodSelector entry with * specified for the method field will allow all methods AND permissions for the service specified in serviceName. Structure is documented below."

fn spec.initProvider.spec.ingressPolicies.ingressTo.operations.withMethodSelectorsMixin

withMethodSelectorsMixin(methodSelectors)

"API methods or permissions to allow. Method or permission must belong to the service specified by serviceName field. A single MethodSelector entry with * specified for the method field will allow all methods AND permissions for the service specified in serviceName. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.spec.ingressPolicies.ingressTo.operations.withServiceName

withServiceName(serviceName)

"The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with serviceName field set to * will allow all methods AND permissions for all services."

obj spec.initProvider.spec.ingressPolicies.ingressTo.operations.methodSelectors

"API methods or permissions to allow. Method or permission must belong to the service specified by serviceName field. A single MethodSelector entry with * specified for the method field will allow all methods AND permissions for the service specified in serviceName. Structure is documented below."

fn spec.initProvider.spec.ingressPolicies.ingressTo.operations.methodSelectors.withMethod

withMethod(method)

"Value for method should be a valid method name for the corresponding serviceName in ApiOperation. If * used as value for method, then ALL methods and permissions are allowed."

fn spec.initProvider.spec.ingressPolicies.ingressTo.operations.methodSelectors.withPermission

withPermission(permission)

"Value for permission should be a valid Cloud IAM permission for the corresponding serviceName in ApiOperation."

obj spec.initProvider.spec.vpcAccessibleServices

"Specifies how APIs are allowed to communicate within the Service Perimeter. Structure is documented below."

fn spec.initProvider.spec.vpcAccessibleServices.withAllowedServices

withAllowedServices(allowedServices)

"The list of APIs usable within the Service Perimeter. Must be empty unless enableRestriction is True."

fn spec.initProvider.spec.vpcAccessibleServices.withAllowedServicesMixin

withAllowedServicesMixin(allowedServices)

"The list of APIs usable within the Service Perimeter. Must be empty unless enableRestriction is True."

Note: This function appends passed data to existing values

fn spec.initProvider.spec.vpcAccessibleServices.withEnableRestriction

withEnableRestriction(enableRestriction)

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

obj spec.providerConfigRef

"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."

fn spec.providerConfigRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerConfigRef.policy

"Policies for referencing."

fn spec.providerConfigRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerConfigRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.providerRef

"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef"

fn spec.providerRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerRef.policy

"Policies for referencing."

fn spec.providerRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo

"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."

fn spec.publishConnectionDetailsTo.withName

withName(name)

"Name is the name of the connection secret."

obj spec.publishConnectionDetailsTo.configRef

"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."

fn spec.publishConnectionDetailsTo.configRef.withName

withName(name)

"Name of the referenced object."

obj spec.publishConnectionDetailsTo.configRef.policy

"Policies for referencing."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo.metadata

"Metadata is the metadata for connection secret."

fn spec.publishConnectionDetailsTo.metadata.withAnnotations

withAnnotations(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withLabels

withLabels(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withType

withType(type)

"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."

obj spec.writeConnectionSecretToRef

"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."

fn spec.writeConnectionSecretToRef.withName

withName(name)

"Name of the secret."

fn spec.writeConnectionSecretToRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."