Package types (0.4.0)

API documentation for cloudsecuritycompliance_v1.types package.

Classes

AggregateFrameworkComplianceReportRequest

The request message for [AggregateFrameworkComplianceReport][].

AggregateFrameworkComplianceReportResponse

The response message for [AggregateFrameworkComplianceReport][].

AggregatedComplianceReport

The aggregated compliance report.

AllowedValues

The allowed set of values for the parameter.

AttributeSubstitutionRule

The attribute at the given path that's substituted entirely.

AuditConfig

The audit configuration for Compliance Manager.

BucketDestination

A Cloud Storage bucket destination.

CELExpression

A Common Expression Language (CEL) expression that's used to create a rule.

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

CalculateEffectiveCmEnrollmentRequest

The request message for [CalculateEffectiveCmEnrollment][].

CalculateEffectiveCmEnrollmentResponse

The response message for [CalculateEffectiveCmEnrollment][].

CloudControl

A cloud control is a set of rules and associated metadata that you can use to define your organization's security or compliance intent.

CloudControlAssessmentDetails

The cloud control assessment details for non-manual cloud controls.

CloudControlAuditDetails

The details for a cloud control audit.

CloudControlCategory

The category for the cloud control.

CloudControlDeployment

A cloud control deployment represents the deployment of a particular cloud control on a target resource. Supported target resources are organizations/{organizationID}, folders/{folderID}, and projects/{projectID}.

CloudControlDeploymentReference

The reference to a cloud control deployment.

CloudControlDetails

The details of a cloud control.

CloudControlGroupAuditDetails

The details for a cloud control group.

CloudControlMetadata

The enforcement mode and parameters of a cloud control deployment.

CloudControlReport

The cloud control report.

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

CloudProvider

The cloud provider that's associated with the cloud control.

CmEnrollment

The settings for Compliance Manager at a specific resource scope.=

ComplianceState

The state of compliance after evaluation is complete.

ControlAssessmentDetails

The details for a control assessment.

ControlComplianceSummary

The details for control compliance.

ControlFamily

The regulatory family of the control.

CreateCloudControlRequest

The request message for [CreateCloudControl][].

CreateFrameworkAuditRequest

The request message for [CreateFrameworkAudit][].

CreateFrameworkDeploymentRequest

The request message for [CreateFrameworkDeployment][].

CreateFrameworkRequest

The request message for [CreateFramework][].

DeleteCloudControlRequest

The request message for [DeleteCloudControl][].

DeleteFrameworkDeploymentRequest

The request message for [DeleteFrameworkDeployment][].

DeleteFrameworkRequest

Request message for [DeleteFramework][].

DeploymentState

The state of the deployment resource.

EnforcementMode

The enforcement mode for the cloud control.

EvaluationState

The evaluation state of the control.

EvidenceDetails

The evidence details for a finding.

FetchFrameworkComplianceReportRequest

The request message for [FetchFrameworkComplianceReport][].

FindingClass

A finding is a record of assessment data like security, risk, health, or privacy.

FindingDetails

The details for a finding.

FindingSummary

The details for a finding.

FolderCreationConfig

The configuration that's required to create a folder to be used as the target resource for a deployment.

Framework

A framework is a collection of cloud controls and regulatory controls that represent security best practices or industry-defined standards such as FedRAMP or NIST.

FrameworkAudit

A framework audit.

FrameworkAuditDestination

A destination for the framework audit.

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

FrameworkCategory

The category for the framework.

FrameworkComplianceReport

The response message for [GetFrameworkComplianceReport][].

FrameworkComplianceSummary

The details for a framework compliance summary.

FrameworkDeployment

Framework deployments represent the assignment of a framework to a target resource. Supported target resources are organizations, folders, and projects.

FrameworkDeploymentReference

The reference to a framework deployment.

FrameworkReference

The reference of a framework, in the format organizations/{organization}/locations/{location}/frameworks/{framework}. The only supported location is global.

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

GenerateFrameworkAuditScopeReportRequest

The request message for [GenerateFrameworkAuditScopeReport][].

GenerateFrameworkAuditScopeReportResponse

The response message for [GenerateFrameworkAuditScopeReport][].

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

GetCloudControlDeploymentRequest

The request message for [GetCloudControlDeployment][].

GetCloudControlRequest

The request message for [GetCloudControl][].

GetFrameworkAuditRequest

The request message for [GetFrameworkAudit][].

GetFrameworkDeploymentRequest

The request message for [GetFrameworkDeployment][].

GetFrameworkRequest

The request message for [GetFramework][].

IntRange

The number range for number parameters.

ListCloudControlDeploymentsRequest

The request message for [ListCloudControlDeployments][].

ListCloudControlDeploymentsResponse

The response message for [ListCloudControlDeployments][].

ListCloudControlsRequest

Request message for [ListCloudControls][].

ListCloudControlsResponse

The response message for [ListCloudControls][].

ListControlComplianceSummariesRequest

The request message for [ListControlComplianceSummaries][].

ListControlComplianceSummariesResponse

The response message for [ListControlComplianceSummaries][].

ListFindingSummariesRequest

The request message for [ListFindingSummaries][].

ListFindingSummariesResponse

The response message for [ListFindingSummaries][].

ListFrameworkAuditsRequest

The request message for [ListFrameworkAudits][].

ListFrameworkAuditsResponse

The response message for [ListFrameworkAudits][].

ListFrameworkComplianceSummariesRequest

The request message for ListFrameworkComplianceSummariesRequest.

ListFrameworkComplianceSummariesResponse

The response message for ListFrameworkComplianceSummariesResponse.

ListFrameworkDeploymentsRequest

The request message for [ListFrameworkDeployments][].

ListFrameworkDeploymentsResponse

The response message for [ListFrameworkDeployments][].

ListFrameworksRequest

Request message for [ListFrameworks][].

ListFrameworksResponse

The response message for [ListFrameworks][]. Returns a paginated list of Framework resources.

ManualCloudControlAssessmentDetails

The details for a manual cloud control assessment.

ObservationDetails

The observation details for a finding.

OperationMetadata

The metadata for the long-running operation.

ParamValue

The 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 are key-value pairs that let you provide your custom location requirements, environment requirements, or other settings that are relevant to the cloud control.

ParameterSpec

The parameter specification for the cloud control.

ParameterSubstitutionRule

The 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

The placeholder that's substituted in the rendered string.

ProjectCreationConfig

The configuration that's required to create a project to be used as the target resource of a deployment.

RegexpPattern

The regular expression (regex) validator for parameter values.

RegulatoryControlResponsibilityType

The responsibility type for the regulatory control.

ReportSummary

Additional information for an audit operation.

Rule

A rule in 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 threat is a threat that can access,
    modify, or delete data or execute unauthorized
    code within existing resources.
HIGH (2):
    A high-risk vulnerability can be easily
    discovered and exploited in combination with
    other vulnerabilities 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.

    A high-risk threat is a threat that can create
    new computational resources in an environment
    but can't access data or execute code in
    existing resources.
MEDIUM (3):
    A medium-risk vulnerability can 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.

    A medium-risk threat can cause operational
    impact but might not access data or execute
    unauthorized code.
LOW (4):
    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.

    A low-risk threat is a threat that has obtained
    minimal access to an environment but can't
    access data, execute code, or create resources.

SimilarControls

The similar controls.

StringList

A list of strings for the parameter value.

TargetResourceConfig

The name of the target resource or the configuration that's required 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

The configuration that's required to create a 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

TargetResourceDetails

The details for a target resource.

TargetResourceType

The type of resource that a control or framework can be applied to.

UpdateCloudControlRequest

The request message for [UpdateCloudControl][].

UpdateCmEnrollmentRequest

The request message for [UpdateCmEnrollment][].

UpdateFrameworkRequest

The request message for [UpdateFramework][].

Validation

The 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