Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigee
  5. apigee/v1
  6. SecurityReport

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.apigee/v1.SecurityReport

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Submit a report request to be processed in the background. If the submission succeeds, the API returns a 200 status and an ID that refer to the report request. In addition to the HTTP status 200, the state of “enqueued” means that the request succeeded. Auto-naming is currently not supported for this resource. Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

Create SecurityReport Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SecurityReport(name: string, args: SecurityReportArgs, opts?: CustomResourceOptions);
@overload
def SecurityReport(resource_name: str,
                   args: SecurityReportArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def SecurityReport(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   environment_id: Optional[str] = None,
                   time_range: Optional[Any] = None,
                   organization_id: Optional[str] = None,
                   group_by_time_unit: Optional[str] = None,
                   envgroup_hostname: Optional[str] = None,
                   filter: Optional[str] = None,
                   csv_delimiter: Optional[str] = None,
                   limit: Optional[int] = None,
                   metrics: Optional[Sequence[GoogleCloudApigeeV1SecurityReportQueryMetricArgs]] = None,
                   mime_type: Optional[str] = None,
                   display_name: Optional[str] = None,
                   report_definition_id: Optional[str] = None,
                   dimensions: Optional[Sequence[str]] = None)
func NewSecurityReport(ctx *Context, name string, args SecurityReportArgs, opts ...ResourceOption) (*SecurityReport, error)
public SecurityReport(string name, SecurityReportArgs args, CustomResourceOptions? opts = null)
public SecurityReport(String name, SecurityReportArgs args)
public SecurityReport(String name, SecurityReportArgs args, CustomResourceOptions options)

type: google-native:apigee/v1:SecurityReport
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

The following reference example uses placeholder values for all input properties.

var securityReportResource = new GoogleNative.Apigee.V1.SecurityReport("securityReportResource", new()
{
    EnvironmentId = "string",
    TimeRange = "any",
    OrganizationId = "string",
    GroupByTimeUnit = "string",
    EnvgroupHostname = "string",
    Filter = "string",
    CsvDelimiter = "string",
    Limit = 0,
    Metrics = new[]
    {
        new GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1SecurityReportQueryMetricArgs
        {
            Name = "string",
            AggregationFunction = "string",
            Alias = "string",
            Operator = "string",
            Value = "string",
        },
    },
    MimeType = "string",
    DisplayName = "string",
    ReportDefinitionId = "string",
    Dimensions = new[]
    {
        "string",
    },
});
Copy
example, err := apigee.NewSecurityReport(ctx, "securityReportResource", &apigee.SecurityReportArgs{
	EnvironmentId:    pulumi.String("string"),
	TimeRange:        pulumi.Any("any"),
	OrganizationId:   pulumi.String("string"),
	GroupByTimeUnit:  pulumi.String("string"),
	EnvgroupHostname: pulumi.String("string"),
	Filter:           pulumi.String("string"),
	CsvDelimiter:     pulumi.String("string"),
	Limit:            pulumi.Int(0),
	Metrics: apigee.GoogleCloudApigeeV1SecurityReportQueryMetricArray{
		&apigee.GoogleCloudApigeeV1SecurityReportQueryMetricArgs{
			Name:                pulumi.String("string"),
			AggregationFunction: pulumi.String("string"),
			Alias:               pulumi.String("string"),
			Operator:            pulumi.String("string"),
			Value:               pulumi.String("string"),
		},
	},
	MimeType:           pulumi.String("string"),
	DisplayName:        pulumi.String("string"),
	ReportDefinitionId: pulumi.String("string"),
	Dimensions: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var securityReportResource = new SecurityReport("securityReportResource", SecurityReportArgs.builder()
    .environmentId("string")
    .timeRange("any")
    .organizationId("string")
    .groupByTimeUnit("string")
    .envgroupHostname("string")
    .filter("string")
    .csvDelimiter("string")
    .limit(0)
    .metrics(GoogleCloudApigeeV1SecurityReportQueryMetricArgs.builder()
        .name("string")
        .aggregationFunction("string")
        .alias("string")
        .operator("string")
        .value("string")
        .build())
    .mimeType("string")
    .displayName("string")
    .reportDefinitionId("string")
    .dimensions("string")
    .build());
Copy
security_report_resource = google_native.apigee.v1.SecurityReport("securityReportResource",
    environment_id="string",
    time_range="any",
    organization_id="string",
    group_by_time_unit="string",
    envgroup_hostname="string",
    filter="string",
    csv_delimiter="string",
    limit=0,
    metrics=[{
        "name": "string",
        "aggregation_function": "string",
        "alias": "string",
        "operator": "string",
        "value": "string",
    }],
    mime_type="string",
    display_name="string",
    report_definition_id="string",
    dimensions=["string"])
Copy
const securityReportResource = new google_native.apigee.v1.SecurityReport("securityReportResource", {
    environmentId: "string",
    timeRange: "any",
    organizationId: "string",
    groupByTimeUnit: "string",
    envgroupHostname: "string",
    filter: "string",
    csvDelimiter: "string",
    limit: 0,
    metrics: [{
        name: "string",
        aggregationFunction: "string",
        alias: "string",
        operator: "string",
        value: "string",
    }],
    mimeType: "string",
    displayName: "string",
    reportDefinitionId: "string",
    dimensions: ["string"],
});
Copy
type: google-native:apigee/v1:SecurityReport
properties:
    csvDelimiter: string
    dimensions:
        - string
    displayName: string
    envgroupHostname: string
    environmentId: string
    filter: string
    groupByTimeUnit: string
    limit: 0
    metrics:
        - aggregationFunction: string
          alias: string
          name: string
          operator: string
          value: string
    mimeType: string
    organizationId: string
    reportDefinitionId: string
    timeRange: any
Copy

SecurityReport Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SecurityReport resource accepts the following input properties:

EnvironmentId
This property is required.
Changes to this property will trigger replacement.
string
OrganizationId
This property is required.
Changes to this property will trigger replacement.
string
TimeRange This property is required. object
Time range for the query. Can use the following predefined strings to specify the time range: last60minutes last24hours last7days Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }
CsvDelimiter string
Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
Dimensions List<string>
A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
DisplayName string
Security Report display name which users can specify.
EnvgroupHostname string
Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname.
Filter string
Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
GroupByTimeUnit string
Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
Limit int
Maximum number of rows that can be returned in the result.
Metrics List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1SecurityReportQueryMetric>
A list of Metrics.
MimeType string
Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
ReportDefinitionId string
Report Definition ID.
EnvironmentId
This property is required.
Changes to this property will trigger replacement.
string
OrganizationId
This property is required.
Changes to this property will trigger replacement.
string
TimeRange This property is required. interface{}
Time range for the query. Can use the following predefined strings to specify the time range: last60minutes last24hours last7days Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }
CsvDelimiter string
Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
Dimensions []string
A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
DisplayName string
Security Report display name which users can specify.
EnvgroupHostname string
Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname.
Filter string
Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
GroupByTimeUnit string
Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
Limit int
Maximum number of rows that can be returned in the result.
Metrics []GoogleCloudApigeeV1SecurityReportQueryMetricArgs
A list of Metrics.
MimeType string
Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
ReportDefinitionId string
Report Definition ID.
environmentId
This property is required.
Changes to this property will trigger replacement.
String
organizationId
This property is required.
Changes to this property will trigger replacement.
String
timeRange This property is required. Object
Time range for the query. Can use the following predefined strings to specify the time range: last60minutes last24hours last7days Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }
csvDelimiter String
Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
dimensions List<String>
A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
displayName String
Security Report display name which users can specify.
envgroupHostname String
Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname.
filter String
Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
groupByTimeUnit String
Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
limit Integer
Maximum number of rows that can be returned in the result.
metrics List<GoogleCloudApigeeV1SecurityReportQueryMetric>
A list of Metrics.
mimeType String
Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
reportDefinitionId String
Report Definition ID.
environmentId
This property is required.
Changes to this property will trigger replacement.
string
organizationId
This property is required.
Changes to this property will trigger replacement.
string
timeRange This property is required. any
Time range for the query. Can use the following predefined strings to specify the time range: last60minutes last24hours last7days Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }
csvDelimiter string
Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
dimensions string[]
A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
displayName string
Security Report display name which users can specify.
envgroupHostname string
Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname.
filter string
Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
groupByTimeUnit string
Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
limit number
Maximum number of rows that can be returned in the result.
metrics GoogleCloudApigeeV1SecurityReportQueryMetric[]
A list of Metrics.
mimeType string
Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
reportDefinitionId string
Report Definition ID.
environment_id
This property is required.
Changes to this property will trigger replacement.
str
organization_id
This property is required.
Changes to this property will trigger replacement.
str
time_range This property is required. Any
Time range for the query. Can use the following predefined strings to specify the time range: last60minutes last24hours last7days Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }
csv_delimiter str
Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
dimensions Sequence[str]
A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
display_name str
Security Report display name which users can specify.
envgroup_hostname str
Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname.
filter str
Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
group_by_time_unit str
Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
limit int
Maximum number of rows that can be returned in the result.
metrics Sequence[GoogleCloudApigeeV1SecurityReportQueryMetricArgs]
A list of Metrics.
mime_type str
Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
report_definition_id str
Report Definition ID.
environmentId
This property is required.
Changes to this property will trigger replacement.
String
organizationId
This property is required.
Changes to this property will trigger replacement.
String
timeRange This property is required. Any
Time range for the query. Can use the following predefined strings to specify the time range: last60minutes last24hours last7days Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }
csvDelimiter String
Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
dimensions List<String>
A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
displayName String
Security Report display name which users can specify.
envgroupHostname String
Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname.
filter String
Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
groupByTimeUnit String
Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
limit Number
Maximum number of rows that can be returned in the result.
metrics List<Property Map>
A list of Metrics.
mimeType String
Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
reportDefinitionId String
Report Definition ID.

Outputs

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

Created string
Creation time of the query.
Error string
Error is set when query fails.
ExecutionTime string
ExecutionTime is available only after the query is completed.
Id string
The provider-assigned unique ID for this managed resource.
QueryParams Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1SecurityReportMetadataResponse
Contains information like metrics, dimenstions etc of the Security Report.
Result Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1SecurityReportResultMetadataResponse
Result is available only after the query is completed.
ResultFileSize string
ResultFileSize is available only after the query is completed.
ResultRows string
ResultRows is available only after the query is completed.
Self string
Self link of the query. Example: /organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd or following format if query is running at host level: /organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
State string
Query state could be "enqueued", "running", "completed", "expired" and "failed".
Updated string
Last updated timestamp for the query.
Created string
Creation time of the query.
Error string
Error is set when query fails.
ExecutionTime string
ExecutionTime is available only after the query is completed.
Id string
The provider-assigned unique ID for this managed resource.
QueryParams GoogleCloudApigeeV1SecurityReportMetadataResponse
Contains information like metrics, dimenstions etc of the Security Report.
Result GoogleCloudApigeeV1SecurityReportResultMetadataResponse
Result is available only after the query is completed.
ResultFileSize string
ResultFileSize is available only after the query is completed.
ResultRows string
ResultRows is available only after the query is completed.
Self string
Self link of the query. Example: /organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd or following format if query is running at host level: /organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
State string
Query state could be "enqueued", "running", "completed", "expired" and "failed".
Updated string
Last updated timestamp for the query.
created String
Creation time of the query.
error String
Error is set when query fails.
executionTime String
ExecutionTime is available only after the query is completed.
id String
The provider-assigned unique ID for this managed resource.
queryParams GoogleCloudApigeeV1SecurityReportMetadataResponse
Contains information like metrics, dimenstions etc of the Security Report.
result GoogleCloudApigeeV1SecurityReportResultMetadataResponse
Result is available only after the query is completed.
resultFileSize String
ResultFileSize is available only after the query is completed.
resultRows String
ResultRows is available only after the query is completed.
self String
Self link of the query. Example: /organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd or following format if query is running at host level: /organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
state String
Query state could be "enqueued", "running", "completed", "expired" and "failed".
updated String
Last updated timestamp for the query.
created string
Creation time of the query.
error string
Error is set when query fails.
executionTime string
ExecutionTime is available only after the query is completed.
id string
The provider-assigned unique ID for this managed resource.
queryParams GoogleCloudApigeeV1SecurityReportMetadataResponse
Contains information like metrics, dimenstions etc of the Security Report.
result GoogleCloudApigeeV1SecurityReportResultMetadataResponse
Result is available only after the query is completed.
resultFileSize string
ResultFileSize is available only after the query is completed.
resultRows string
ResultRows is available only after the query is completed.
self string
Self link of the query. Example: /organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd or following format if query is running at host level: /organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
state string
Query state could be "enqueued", "running", "completed", "expired" and "failed".
updated string
Last updated timestamp for the query.
created str
Creation time of the query.
error str
Error is set when query fails.
execution_time str
ExecutionTime is available only after the query is completed.
id str
The provider-assigned unique ID for this managed resource.
query_params GoogleCloudApigeeV1SecurityReportMetadataResponse
Contains information like metrics, dimenstions etc of the Security Report.
result GoogleCloudApigeeV1SecurityReportResultMetadataResponse
Result is available only after the query is completed.
result_file_size str
ResultFileSize is available only after the query is completed.
result_rows str
ResultRows is available only after the query is completed.
self str
Self link of the query. Example: /organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd or following format if query is running at host level: /organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
state str
Query state could be "enqueued", "running", "completed", "expired" and "failed".
updated str
Last updated timestamp for the query.
created String
Creation time of the query.
error String
Error is set when query fails.
executionTime String
ExecutionTime is available only after the query is completed.
id String
The provider-assigned unique ID for this managed resource.
queryParams Property Map
Contains information like metrics, dimenstions etc of the Security Report.
result Property Map
Result is available only after the query is completed.
resultFileSize String
ResultFileSize is available only after the query is completed.
resultRows String
ResultRows is available only after the query is completed.
self String
Self link of the query. Example: /organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd or following format if query is running at host level: /organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
state String
Query state could be "enqueued", "running", "completed", "expired" and "failed".
updated String
Last updated timestamp for the query.

Supporting Types

GoogleCloudApigeeV1SecurityReportMetadataResponse
, GoogleCloudApigeeV1SecurityReportMetadataResponseArgs

Dimensions This property is required. List<string>
Dimensions of the SecurityReport.
EndTimestamp This property is required. string
End timestamp of the query range.
Metrics This property is required. List<string>
Metrics of the SecurityReport. Example: ["name:bot_count,func:sum,alias:sum_bot_count"]
MimeType This property is required. string
MIME type / Output format.
StartTimestamp This property is required. string
Start timestamp of the query range.
TimeUnit This property is required. string
Query GroupBy time unit. Example: "seconds", "minute", "hour"
Dimensions This property is required. []string
Dimensions of the SecurityReport.
EndTimestamp This property is required. string
End timestamp of the query range.
Metrics This property is required. []string
Metrics of the SecurityReport. Example: ["name:bot_count,func:sum,alias:sum_bot_count"]
MimeType This property is required. string
MIME type / Output format.
StartTimestamp This property is required. string
Start timestamp of the query range.
TimeUnit This property is required. string
Query GroupBy time unit. Example: "seconds", "minute", "hour"
dimensions This property is required. List<String>
Dimensions of the SecurityReport.
endTimestamp This property is required. String
End timestamp of the query range.
metrics This property is required. List<String>
Metrics of the SecurityReport. Example: ["name:bot_count,func:sum,alias:sum_bot_count"]
mimeType This property is required. String
MIME type / Output format.
startTimestamp This property is required. String
Start timestamp of the query range.
timeUnit This property is required. String
Query GroupBy time unit. Example: "seconds", "minute", "hour"
dimensions This property is required. string[]
Dimensions of the SecurityReport.
endTimestamp This property is required. string
End timestamp of the query range.
metrics This property is required. string[]
Metrics of the SecurityReport. Example: ["name:bot_count,func:sum,alias:sum_bot_count"]
mimeType This property is required. string
MIME type / Output format.
startTimestamp This property is required. string
Start timestamp of the query range.
timeUnit This property is required. string
Query GroupBy time unit. Example: "seconds", "minute", "hour"
dimensions This property is required. Sequence[str]
Dimensions of the SecurityReport.
end_timestamp This property is required. str
End timestamp of the query range.
metrics This property is required. Sequence[str]
Metrics of the SecurityReport. Example: ["name:bot_count,func:sum,alias:sum_bot_count"]
mime_type This property is required. str
MIME type / Output format.
start_timestamp This property is required. str
Start timestamp of the query range.
time_unit This property is required. str
Query GroupBy time unit. Example: "seconds", "minute", "hour"
dimensions This property is required. List<String>
Dimensions of the SecurityReport.
endTimestamp This property is required. String
End timestamp of the query range.
metrics This property is required. List<String>
Metrics of the SecurityReport. Example: ["name:bot_count,func:sum,alias:sum_bot_count"]
mimeType This property is required. String
MIME type / Output format.
startTimestamp This property is required. String
Start timestamp of the query range.
timeUnit This property is required. String
Query GroupBy time unit. Example: "seconds", "minute", "hour"

GoogleCloudApigeeV1SecurityReportQueryMetric
, GoogleCloudApigeeV1SecurityReportQueryMetricArgs

Name This property is required. string
Metric name.
AggregationFunction string
Aggregation function: avg, min, max, or sum.
Alias string
Alias for the metric. Alias will be used to replace metric name in query results.
Operator string
One of +, -, /, %, *.
Value string
Operand value should be provided when operator is set.
Name This property is required. string
Metric name.
AggregationFunction string
Aggregation function: avg, min, max, or sum.
Alias string
Alias for the metric. Alias will be used to replace metric name in query results.
Operator string
One of +, -, /, %, *.
Value string
Operand value should be provided when operator is set.
name This property is required. String
Metric name.
aggregationFunction String
Aggregation function: avg, min, max, or sum.
alias String
Alias for the metric. Alias will be used to replace metric name in query results.
operator String
One of +, -, /, %, *.
value String
Operand value should be provided when operator is set.
name This property is required. string
Metric name.
aggregationFunction string
Aggregation function: avg, min, max, or sum.
alias string
Alias for the metric. Alias will be used to replace metric name in query results.
operator string
One of +, -, /, %, *.
value string
Operand value should be provided when operator is set.
name This property is required. str
Metric name.
aggregation_function str
Aggregation function: avg, min, max, or sum.
alias str
Alias for the metric. Alias will be used to replace metric name in query results.
operator str
One of +, -, /, %, *.
value str
Operand value should be provided when operator is set.
name This property is required. String
Metric name.
aggregationFunction String
Aggregation function: avg, min, max, or sum.
alias String
Alias for the metric. Alias will be used to replace metric name in query results.
operator String
One of +, -, /, %, *.
value String
Operand value should be provided when operator is set.

GoogleCloudApigeeV1SecurityReportResultMetadataResponse
, GoogleCloudApigeeV1SecurityReportResultMetadataResponseArgs

Expires This property is required. string
Expire_time is set to 7 days after report creation. Query result will be unaccessable after this time. Example: "2021-05-04T13:38:52-07:00"
Self This property is required. string
Self link of the query results. Example: /organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result or following format if query is running at host level: /organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result
Expires This property is required. string
Expire_time is set to 7 days after report creation. Query result will be unaccessable after this time. Example: "2021-05-04T13:38:52-07:00"
Self This property is required. string
Self link of the query results. Example: /organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result or following format if query is running at host level: /organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result
expires This property is required. String
Expire_time is set to 7 days after report creation. Query result will be unaccessable after this time. Example: "2021-05-04T13:38:52-07:00"
self This property is required. String
Self link of the query results. Example: /organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result or following format if query is running at host level: /organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result
expires This property is required. string
Expire_time is set to 7 days after report creation. Query result will be unaccessable after this time. Example: "2021-05-04T13:38:52-07:00"
self This property is required. string
Self link of the query results. Example: /organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result or following format if query is running at host level: /organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result
expires This property is required. str
Expire_time is set to 7 days after report creation. Query result will be unaccessable after this time. Example: "2021-05-04T13:38:52-07:00"
self This property is required. str
Self link of the query results. Example: /organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result or following format if query is running at host level: /organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result
expires This property is required. String
Expire_time is set to 7 days after report creation. Query result will be unaccessable after this time. Example: "2021-05-04T13:38:52-07:00"
self This property is required. String
Self link of the query results. Example: /organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result or following format if query is running at host level: /organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native