-
Notifications
You must be signed in to change notification settings - Fork 1.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Resource v1 SCC Findings Export to BQ Project Config #11595
Merged
NickElliot
merged 4 commits into
GoogleCloudPlatform:main
from
vijaykanthm:scc-bigquery-export-v1-project-level-config
Sep 12, 2024
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
130 changes: 130 additions & 0 deletions
130
mmv1/products/securitycenter/ProjectSccBigQueryExports.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
# Copyright 2024 Google Inc. | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
--- !ruby/object:Api::Resource | ||
name: 'ProjectSccBigQueryExports' | ||
base_url: projects/{{project}}/bigQueryExports | ||
self_link: projects/{{project}}/bigQueryExports/{{big_query_export_id}} | ||
create_url: projects/{{project}}/bigQueryExports?bigQueryExportId={{big_query_export_id}} | ||
update_verb: :PATCH | ||
update_mask: true | ||
import_format: | ||
- 'projects/{{project}}/bigQueryExports/{{big_query_export_id}}' | ||
description: | | ||
A Cloud Security Command Center (Cloud SCC) Big Query Export Config. | ||
It represents exporting Security Command Center data, including assets, findings, and security marks | ||
using gcloud scc bqexports | ||
~> **Note:** In order to use Cloud SCC resources, your organization must be enrolled | ||
in [SCC Standard/Premium](https://cloud.google.com/security-command-center/docs/quickstart-security-command-center). | ||
Without doing so, you may run into errors during resource creation. | ||
references: !ruby/object:Api::Resource::ReferenceLinks | ||
guides: | ||
'Official Documentation': 'https://cloud.google.com/security-command-center/docs/how-to-analyze-findings-in-big-query' | ||
api: 'https://cloud.google.com/security-command-center/docs/reference/rest/v1/projects.bigQueryExports' | ||
examples: | ||
- !ruby/object:Provider::Terraform::Examples | ||
name: 'scc_project_big_query_export_config_basic' | ||
primary_resource_id: 'custom_big_query_export_config' | ||
external_providers: ["random", "time"] | ||
skip_test: true | ||
vars: | ||
big_query_export_id: 'my-export' | ||
dataset: 'my-dataset' | ||
dataset_id: 'my_dataset_id' | ||
name: 'my-export' | ||
test_env_vars: | ||
org_id: :ORG_ID | ||
project: :PROJECT_NAME | ||
ignore_read_extra: | ||
- 'project' | ||
parameters: | ||
- !ruby/object:Api::Type::String | ||
name: bigQueryExportId | ||
required: true | ||
immutable: true | ||
url_param_only: true | ||
description: | | ||
This must be unique within the organization. | ||
properties: | ||
- !ruby/object:Api::Type::String | ||
name: name | ||
output: true | ||
description: | | ||
The resource name of this export, in the format | ||
`projects/{{project}}/bigQueryExports/{{big_query_export_id}}`. | ||
This field is provided in responses, and is ignored when provided in create requests. | ||
- !ruby/object:Api::Type::String | ||
name: description | ||
description: | | ||
The description of the notification config (max of 1024 characters). | ||
validation: !ruby/object:Provider::Terraform::Validation | ||
function: 'validation.StringLenBetween(0, 1024)' | ||
- !ruby/object:Api::Type::String | ||
name: dataset | ||
description: | | ||
The dataset to write findings' updates to. | ||
Its format is "projects/[projectId]/datasets/[bigquery_dataset_id]". | ||
BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). | ||
- !ruby/object:Api::Type::String | ||
name: createTime | ||
output: true | ||
description: | | ||
The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation. | ||
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. | ||
Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". | ||
- !ruby/object:Api::Type::String | ||
name: updateTime | ||
output: true | ||
description: | | ||
The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update. | ||
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. | ||
Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". | ||
- !ruby/object:Api::Type::String | ||
name: mostRecentEditor | ||
output: true | ||
description: | | ||
Email address of the user who last edited the BigQuery export. | ||
This field is set by the server and will be ignored if provided on export creation or update. | ||
- !ruby/object:Api::Type::String | ||
name: principal | ||
output: true | ||
description: | | ||
The service account that needs permission to create table and upload data to the BigQuery dataset. | ||
- !ruby/object:Api::Type::String | ||
name: filter | ||
description: | | ||
Expression that defines the filter to apply across create/update | ||
events of findings. The | ||
expression is a list of zero or more restrictions combined via | ||
logical operators AND and OR. Parentheses are supported, and OR | ||
has higher precedence than AND. | ||
|
||
Restrictions have the form <field> <operator> <value> and may have | ||
a - character in front of them to indicate negation. The fields | ||
map to those defined in the corresponding resource. | ||
|
||
The supported operators are: | ||
|
||
* = for all value types. | ||
* \>, <, >=, <= for integer values. | ||
* :, meaning substring matching, for strings. | ||
|
||
The supported value types are: | ||
|
||
* string literals in quotes. | ||
* integer literals without quotes. | ||
* boolean literals true and false without quotes. | ||
|
||
See | ||
[Filtering notifications](https://cloud.google.com/security-command-center/docs/how-to-api-filter-notifications) | ||
for information on how to write a filter. |
25 changes: 25 additions & 0 deletions
25
mmv1/templates/terraform/examples/scc_project_big_query_export_config_basic.tf.erb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
resource "google_bigquery_dataset" "default" { | ||
dataset_id = "<%= ctx[:vars]['dataset_id'] %>" | ||
friendly_name = "test" | ||
description = "This is a test description" | ||
location = "US" | ||
default_table_expiration_ms = 3600000 | ||
default_partition_expiration_ms = null | ||
|
||
labels = { | ||
env = "default" | ||
} | ||
|
||
lifecycle { | ||
ignore_changes = [default_partition_expiration_ms] | ||
} | ||
} | ||
|
||
resource "google_scc_project_scc_big_query_exports" "<%= ctx[:primary_resource_id] %>" { | ||
name = "<%= ctx[:vars]['name'] %>" | ||
big_query_export_id = "<%= ctx[:vars]['big_query_export_id'] %>" | ||
project = "<%= ctx[:test_env_vars]['project'] %>" | ||
dataset = google_bigquery_dataset.default.id | ||
description = "Cloud Security Command Center Findings Big Query Export Config" | ||
filter = "state=\"ACTIVE\" AND NOT mute=\"MUTED\"" | ||
} |
123 changes: 123 additions & 0 deletions
123
...ty/terraform/services/securitycenter/resource_scc_project_big_query_export_config_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,123 @@ | ||
package securitycenter_test | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/hashicorp/terraform-plugin-testing/helper/resource" | ||
"github.com/hashicorp/terraform-provider-google/google/acctest" | ||
"github.com/hashicorp/terraform-provider-google/google/envvar" | ||
) | ||
|
||
func TestAccSecurityCenterProjectBigQueryExportConfig_basic(t *testing.T) { | ||
t.Parallel() | ||
|
||
randomSuffix := acctest.RandString(t, 10) | ||
dataset_id := "tf_test_" + randomSuffix | ||
orgID := envvar.GetTestOrgFromEnv(t) | ||
|
||
context := map[string]interface{}{ | ||
"org_id": orgID, | ||
"random_suffix": randomSuffix, | ||
"dataset_id": dataset_id, | ||
"big_query_export_id": "tf-test-export-" + randomSuffix, | ||
"project": envvar.GetTestProjectFromEnv(), | ||
} | ||
|
||
acctest.VcrTest(t, resource.TestCase{ | ||
PreCheck: func() { acctest.AccTestPreCheck(t) }, | ||
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t), | ||
ExternalProviders: map[string]resource.ExternalProvider{ | ||
"random": {}, | ||
"time": {}, | ||
}, | ||
Steps: []resource.TestStep{ | ||
{ | ||
Config: testAccSecurityCenterProjectBigQueryExportConfig_basic(context), | ||
}, | ||
{ | ||
ResourceName: "google_scc_project_scc_big_query_exports.default", | ||
ImportState: true, | ||
ImportStateVerify: true, | ||
ImportStateVerifyIgnore: []string{"update_time", "project"}, | ||
}, | ||
{ | ||
Config: testAccSecurityCenterProjectBigQueryExportConfig_update(context), | ||
}, | ||
{ | ||
ResourceName: "google_scc_project_scc_big_query_exports.default", | ||
ImportState: true, | ||
ImportStateVerify: true, | ||
ImportStateVerifyIgnore: []string{"update_time", "project"}, | ||
}, | ||
}, | ||
}) | ||
} | ||
|
||
func testAccSecurityCenterProjectBigQueryExportConfig_basic(context map[string]interface{}) string { | ||
return acctest.Nprintf(` | ||
|
||
resource "google_bigquery_dataset" "default" { | ||
dataset_id = "%{dataset_id}" | ||
friendly_name = "test" | ||
description = "This is a test description" | ||
location = "US" | ||
default_table_expiration_ms = 3600000 | ||
default_partition_expiration_ms = null | ||
|
||
labels = { | ||
env = "default" | ||
} | ||
|
||
lifecycle { | ||
ignore_changes = [default_partition_expiration_ms] | ||
} | ||
} | ||
|
||
resource "time_sleep" "wait_1_minute" { | ||
depends_on = [google_bigquery_dataset.default] | ||
create_duration = "3m" | ||
} | ||
|
||
resource "google_scc_project_scc_big_query_exports" "default" { | ||
big_query_export_id = "%{big_query_export_id}" | ||
project = "%{project}" | ||
dataset = google_bigquery_dataset.default.id | ||
description = "Cloud Security Command Center Findings Big Query Export Config" | ||
filter = "state=\"ACTIVE\" AND NOT mute=\"MUTED\"" | ||
|
||
depends_on = [time_sleep.wait_1_minute] | ||
} | ||
|
||
`, context) | ||
} | ||
|
||
func testAccSecurityCenterProjectBigQueryExportConfig_update(context map[string]interface{}) string { | ||
return acctest.Nprintf(` | ||
|
||
resource "google_bigquery_dataset" "default" { | ||
dataset_id = "%{dataset_id}" | ||
friendly_name = "test" | ||
description = "This is a test description" | ||
location = "US" | ||
default_table_expiration_ms = 3600000 | ||
default_partition_expiration_ms = null | ||
|
||
labels = { | ||
env = "default" | ||
} | ||
|
||
lifecycle { | ||
ignore_changes = [default_partition_expiration_ms] | ||
} | ||
} | ||
|
||
resource "google_scc_project_scc_big_query_exports" "default" { | ||
big_query_export_id = "%{big_query_export_id}" | ||
project = "%{project}" | ||
dataset = google_bigquery_dataset.default.id | ||
description = "SCC Findings Big Query Export Update" | ||
filter = "state=\"ACTIVE\" AND NOT mute=\"MUTED\"" | ||
} | ||
|
||
`, context) | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Drive-by comment: These should be singular, not plural. The file name will also need to change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Addressed.