Package Classes (0.2.0)

Summary of entries of Classes for google-cloud-cloudsecuritycompliance.

Classes

ConfigAsyncClient

Config Service manages compliance frameworks, cloud controls, and their configurations.

ConfigClient

Config Service manages compliance frameworks, cloud controls, and their configurations.

ListCloudControlsAsyncPager

A pager for iterating through list_cloud_controls requests.

This class thinly wraps an initial ListCloudControlsResponse object, and provides an __aiter__ method to iterate through its cloud_controls field.

If there are more pages, the __aiter__ method will make additional ListCloudControls requests and continue to iterate through the cloud_controls field on the corresponding responses.

All the usual ListCloudControlsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCloudControlsPager

A pager for iterating through list_cloud_controls requests.

This class thinly wraps an initial ListCloudControlsResponse object, and provides an __iter__ method to iterate through its cloud_controls field.

If there are more pages, the __iter__ method will make additional ListCloudControls requests and continue to iterate through the cloud_controls field on the corresponding responses.

All the usual ListCloudControlsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListFrameworksAsyncPager

A pager for iterating through list_frameworks requests.

This class thinly wraps an initial ListFrameworksResponse object, and provides an __aiter__ method to iterate through its frameworks field.

If there are more pages, the __aiter__ method will make additional ListFrameworks requests and continue to iterate through the frameworks field on the corresponding responses.

All the usual ListFrameworksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListFrameworksPager

A pager for iterating through list_frameworks requests.

This class thinly wraps an initial ListFrameworksResponse object, and provides an __iter__ method to iterate through its frameworks field.

If there are more pages, the __iter__ method will make additional ListFrameworks requests and continue to iterate through the frameworks field on the corresponding responses.

All the usual ListFrameworksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

DeploymentAsyncClient

Deployment service allows users to manage deployments of Frameworks and Cloud Controls on a target resource.

DeploymentClient

Deployment service allows users to manage deployments of Frameworks and Cloud Controls on a target resource.

ListCloudControlDeploymentsAsyncPager

A pager for iterating through list_cloud_control_deployments requests.

This class thinly wraps an initial ListCloudControlDeploymentsResponse object, and provides an __aiter__ method to iterate through its cloud_control_deployments field.

If there are more pages, the __aiter__ method will make additional ListCloudControlDeployments requests and continue to iterate through the cloud_control_deployments field on the corresponding responses.

All the usual ListCloudControlDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCloudControlDeploymentsPager

A pager for iterating through list_cloud_control_deployments requests.

This class thinly wraps an initial ListCloudControlDeploymentsResponse object, and provides an __iter__ method to iterate through its cloud_control_deployments field.

If there are more pages, the __iter__ method will make additional ListCloudControlDeployments requests and continue to iterate through the cloud_control_deployments field on the corresponding responses.

All the usual ListCloudControlDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListFrameworkDeploymentsAsyncPager

A pager for iterating through list_framework_deployments requests.

This class thinly wraps an initial ListFrameworkDeploymentsResponse object, and provides an __aiter__ method to iterate through its framework_deployments field.

If there are more pages, the __aiter__ method will make additional ListFrameworkDeployments requests and continue to iterate through the framework_deployments field on the corresponding responses.

All the usual ListFrameworkDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListFrameworkDeploymentsPager

A pager for iterating through list_framework_deployments requests.

This class thinly wraps an initial ListFrameworkDeploymentsResponse object, and provides an __iter__ method to iterate through its framework_deployments field.

If there are more pages, the __iter__ method will make additional ListFrameworkDeployments requests and continue to iterate through the framework_deployments field on the corresponding responses.

All the usual ListFrameworkDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AllowedValues

Allowed set of values for the parameter.

AttributeSubstitutionRule

Attribute at the given path is substituted entirely.

CELExpression

A CEL expression <https://cloud.google.com/certificate-authority-service/docs/using-cel>__.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CloudControl

A CloudControl is the fundamental unit encapsulating the rules to meet a specific security or compliance intent. It can contain various rule types (like Organization Policies, CEL expressions, etc.) enabling different enforcement modes (Preventive, Detective, Audit). CloudControls are often parameterized for reusability and can be either BUILT_IN (provided by Google) or CUSTOM (defined by the user).

CloudControlCategory

The category of the cloud control.

CloudControlDeployment

CloudControlDeployment represents deployment of a CloudControl on a target resource. Supported target resources are organizations/{organization}, folders/{folder}, and projects/{project}.

CloudControlDeploymentReference

The reference to a CloudControlDeployment.

CloudControlDetails

CloudControlDetails contains the details of a CloudControl.

CloudControlMetadata

CloudControlMetadata contains the enforcement mode and parameters of a Cloud Control Deployment.

CloudProvider

The cloud platform.

CreateCloudControlRequest

Request message for creating a CloudControl

CreateFrameworkDeploymentRequest

Request message for CreateFrameworkDeployment API.

CreateFrameworkRequest

Request message for creating a Framework

DeleteCloudControlRequest

Request message for deleting a CloudControl.

DeleteFrameworkDeploymentRequest

Request message for DeleteFrameworkDeployment.

DeleteFrameworkRequest

Request message for deleting a Framework.

DeploymentState

DeploymentState represents the state of the Deployment resource.

EnforcementMode

The enforcement mode of the cloud control.

FolderCreationConfig

FolderCreationConfig contains the config to create a new folder to be used as the target_resource of a deployment.

Framework

A Framework is a collection of CloudControls to address security and compliance requirements. Frameworks can be used for prevention, detection, and auditing. They can be either built-in, industry-standard frameworks provided by GCP/AZURE/AWS (e.g., NIST, FedRAMP) or custom frameworks created by users.

FrameworkType

The type of the framework.

FrameworkCategory

The category of the framework.

FrameworkDeployment

FrameworkDeployment represents deployment of a Framework on a target resource. Supported target resources are organizations/{organization}, folders/{folder}, and projects/{project}.

FrameworkDeploymentReference

The reference to a FrameworkDeployment.

FrameworkReference

FrameworkReference contains the reference of a framework.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GetCloudControlDeploymentRequest

Request message for GetCloudControlDeployment.

GetCloudControlRequest

Request message for getting a CloudControl.

GetFrameworkDeploymentRequest

Request message for GetFrameworkDeployment.

GetFrameworkRequest

Request message for getting a Framework.

IntRange

Number range for number parameters.

ListCloudControlDeploymentsRequest

Request message for ListCloudControlDeployments.

ListCloudControlDeploymentsResponse

Response message for ListCloudControlDeployments.

ListCloudControlsRequest

Request message for listing CloudControls.

ListCloudControlsResponse

Response message for ListCloudControls.

ListFrameworkDeploymentsRequest

Request message for ListFrameworkDeployments.

ListFrameworkDeploymentsResponse

Response message for ListFrameworkDeployments.

ListFrameworksRequest

Request message for listing Frameworks.

ListFrameworksResponse

Response message for listing Frameworks. Contains a paginated list of Framework resources.

OperationMetadata

Represents the metadata of the long-running operation.

ParamValue

Possible parameter value types.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Parameter

Parameters is a key-value pair.

ParameterSpec

A parameter spec of the cloud control.

ValueType

The type of the parameter value.

ParameterSubstitutionRule

Parameter substitution rules.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PlaceholderSubstitutionRule

Placeholder is substituted in the rendered string.

ProjectCreationConfig

ProjectCreationConfig contains the config to create a new project to be used as the target_resource of a deployment.

RegexpPattern

Regular Expression Validator for parameter values.

Rule

A rule of the cloud control.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RuleActionType

The action type of the rule.

Severity

The severity of the finding.

    A critical vulnerability is easily discoverable
    by an external actor, exploitable, and results
    in the direct ability to execute arbitrary code,
    exfiltrate data, and otherwise gain additional
    access and privileges to cloud resources and
    workloads. Examples include publicly accessible
    unprotected user data and public SSH access with
    weak or no passwords.

    Threat:

    Indicates a threat that is able to access,
    modify, or delete data or execute unauthorized
    code within existing resources.
HIGH (2):
    Vulnerability:

    A high risk vulnerability can be easily
    discovered and exploited in combination with
    other vulnerabilities in order to gain direct
    access and the ability to execute arbitrary
    code, exfiltrate data, and otherwise gain
    additional access and privileges to cloud
    resources and workloads. An example is a
    database with weak or no passwords that is only
    accessible internally. This database could
    easily be compromised by an actor that had
    access to the internal network.

    Threat:

    Indicates a threat that is able to create new
    computational resources in an environment but
    not able to access data or execute code in
    existing resources.
MEDIUM (3):
    Vulnerability:

    A medium risk vulnerability could be used by an
    actor to gain access to resources or privileges
    that enable them to eventually (through multiple
    steps or a complex exploit) gain access and the
    ability to execute arbitrary code or exfiltrate
    data. An example is a service account with
    access to more projects than it should have. If
    an actor gains access to the service account,
    they could potentially use that access to
    manipulate a project the service account was not
    intended to.

    Threat:

    Indicates a threat that is able to cause
    operational impact but may not access data or
    execute unauthorized code.
LOW (4):
    Vulnerability:

    A low risk vulnerability hampers a security
    organization's ability to detect vulnerabilities
    or active threats in their deployment, or
    prevents the root cause investigation of
    security issues. An example is monitoring and
    logs being disabled for resource configurations
    and access.

    Threat:

    Indicates a threat that has obtained minimal
    access to an environment but is not able to
    access data, execute code, or create resources.

StringList

A list of strings.

TargetResourceConfig

TargetResourceConfig contains either the name of the target_resource or contains the config to create a new target_resource.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TargetResourceCreationConfig

TargetResourceCreationConfig contains the config to create a new resource to be used as the target_resource of a deployment.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TargetResourceType

TargetResourceType represents the type of resource that a control or framework can be applied to.

UpdateCloudControlRequest

Request message for UpdateCloudControl.

UpdateFrameworkRequest

Request message for updating a Framework.

Validation

Validation of the parameter.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Modules

pagers

API documentation for cloudsecuritycompliance_v1.services.config.pagers module.

pagers

API documentation for cloudsecuritycompliance_v1.services.deployment.pagers module.