@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
359 lines • 16.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* VPC Flow Logs Config is a resource that lets you configure Flow Logs for Organization.
*
* ## Example Usage
*
* ### Network Management Org Vpc Flow Logs Config Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const org_test = new gcp.networkmanagement.OrganizationVpcFlowLogsConfig("org-test", {
* vpcFlowLogsConfigId: "basic-org-test-id",
* location: "global",
* organization: "123456789",
* });
* ```
*
* ## Import
*
* OrganizationVpcFlowLogsConfig can be imported using any of these accepted formats:
*
* * `organizations/{{organization}}/locations/{{location}}/vpcFlowLogsConfigs/{{vpc_flow_logs_config_id}}`
* * `{{organization}}/{{location}}/{{vpc_flow_logs_config_id}}`
*
* When using the `pulumi import` command, OrganizationVpcFlowLogsConfig can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:networkmanagement/organizationVpcFlowLogsConfig:OrganizationVpcFlowLogsConfig default organizations/{{organization}}/locations/{{location}}/vpcFlowLogsConfigs/{{vpc_flow_logs_config_id}}
* $ pulumi import gcp:networkmanagement/organizationVpcFlowLogsConfig:OrganizationVpcFlowLogsConfig default {{organization}}/{{location}}/{{vpc_flow_logs_config_id}}
* ```
*/
export declare class OrganizationVpcFlowLogsConfig extends pulumi.CustomResource {
/**
* Get an existing OrganizationVpcFlowLogsConfig resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: OrganizationVpcFlowLogsConfigState, opts?: pulumi.CustomResourceOptions): OrganizationVpcFlowLogsConfig;
/**
* Returns true if the given object is an instance of OrganizationVpcFlowLogsConfig. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is OrganizationVpcFlowLogsConfig;
/**
* Optional. The aggregation interval for the logs. Default value is
* INTERVAL_5_SEC. Possible values: INTERVAL_5_SEC INTERVAL_30_SEC INTERVAL_1_MIN INTERVAL_5_MIN INTERVAL_10_MIN INTERVAL_15_MIN
*/
readonly aggregationInterval: pulumi.Output<string>;
/**
* Output only. The time the config was created.
*/
readonly createTime: pulumi.Output<string>;
/**
* Determines whether to include cross project annotations in the logs.
* This field is available only for organization configurations. If not
* specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED.
* Possible values:
* CROSS_PROJECT_METADATA_ENABLED
* CROSS_PROJECT_METADATA_DISABLED
* Possible values are: `CROSS_PROJECT_METADATA_ENABLED`, `CROSS_PROJECT_METADATA_DISABLED`.
*/
readonly crossProjectMetadata: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum
* of 512 characters.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Optional. Export filter used to define which VPC Flow Logs should be logged.
*/
readonly filterExpr: pulumi.Output<string | undefined>;
/**
* Optional. The value of the field must be in (0, 1]. The sampling rate
* of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the
* sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use
* the state field instead. Default value is 1.0
*/
readonly flowSampling: pulumi.Output<number>;
/**
* Optional. Resource labels to represent the user-provided metadata.
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource
* within its parent collection as described in https://google.aip.dev/122. See documentation
* for resource type `networkmanagement.googleapis.com/VpcFlowLogsConfig`.
*/
readonly location: pulumi.Output<string>;
/**
* Optional. Configures whether all, none or a subset of metadata fields
* should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.
* Possible values: METADATA_UNSPECIFIED INCLUDE_ALL_METADATA EXCLUDE_ALL_METADATA CUSTOM_METADATA
*/
readonly metadata: pulumi.Output<string>;
/**
* Optional. Custom metadata fields to include in the reported VPC flow
* logs. Can only be specified if \"metadata\" was set to CUSTOM_METADATA.
*/
readonly metadataFields: pulumi.Output<string[] | undefined>;
/**
* Identifier. Unique name of the configuration using the form: `organizations/{org_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`
*/
readonly name: pulumi.Output<string>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
readonly organization: pulumi.Output<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Optional. The state of the VPC Flow Log configuration. Default value
* is ENABLED. When creating a new configuration, it must be enabled.
* Possible values: ENABLED DISABLED
*/
readonly state: pulumi.Output<string>;
/**
* Output only. The time the config was updated.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Required. ID of the `VpcFlowLogsConfig`.
*/
readonly vpcFlowLogsConfigId: pulumi.Output<string>;
/**
* Create a OrganizationVpcFlowLogsConfig resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: OrganizationVpcFlowLogsConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering OrganizationVpcFlowLogsConfig resources.
*/
export interface OrganizationVpcFlowLogsConfigState {
/**
* Optional. The aggregation interval for the logs. Default value is
* INTERVAL_5_SEC. Possible values: INTERVAL_5_SEC INTERVAL_30_SEC INTERVAL_1_MIN INTERVAL_5_MIN INTERVAL_10_MIN INTERVAL_15_MIN
*/
aggregationInterval?: pulumi.Input<string | undefined>;
/**
* Output only. The time the config was created.
*/
createTime?: pulumi.Input<string | undefined>;
/**
* Determines whether to include cross project annotations in the logs.
* This field is available only for organization configurations. If not
* specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED.
* Possible values:
* CROSS_PROJECT_METADATA_ENABLED
* CROSS_PROJECT_METADATA_DISABLED
* Possible values are: `CROSS_PROJECT_METADATA_ENABLED`, `CROSS_PROJECT_METADATA_DISABLED`.
*/
crossProjectMetadata?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum
* of 512 characters.
*/
description?: pulumi.Input<string | undefined>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Optional. Export filter used to define which VPC Flow Logs should be logged.
*/
filterExpr?: pulumi.Input<string | undefined>;
/**
* Optional. The value of the field must be in (0, 1]. The sampling rate
* of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the
* sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use
* the state field instead. Default value is 1.0
*/
flowSampling?: pulumi.Input<number | undefined>;
/**
* Optional. Resource labels to represent the user-provided metadata.
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource
* within its parent collection as described in https://google.aip.dev/122. See documentation
* for resource type `networkmanagement.googleapis.com/VpcFlowLogsConfig`.
*/
location?: pulumi.Input<string | undefined>;
/**
* Optional. Configures whether all, none or a subset of metadata fields
* should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.
* Possible values: METADATA_UNSPECIFIED INCLUDE_ALL_METADATA EXCLUDE_ALL_METADATA CUSTOM_METADATA
*/
metadata?: pulumi.Input<string | undefined>;
/**
* Optional. Custom metadata fields to include in the reported VPC flow
* logs. Can only be specified if \"metadata\" was set to CUSTOM_METADATA.
*/
metadataFields?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Identifier. Unique name of the configuration using the form: `organizations/{org_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`
*/
name?: pulumi.Input<string | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
organization?: pulumi.Input<string | undefined>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Optional. The state of the VPC Flow Log configuration. Default value
* is ENABLED. When creating a new configuration, it must be enabled.
* Possible values: ENABLED DISABLED
*/
state?: pulumi.Input<string | undefined>;
/**
* Output only. The time the config was updated.
*/
updateTime?: pulumi.Input<string | undefined>;
/**
* Required. ID of the `VpcFlowLogsConfig`.
*/
vpcFlowLogsConfigId?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a OrganizationVpcFlowLogsConfig resource.
*/
export interface OrganizationVpcFlowLogsConfigArgs {
/**
* Optional. The aggregation interval for the logs. Default value is
* INTERVAL_5_SEC. Possible values: INTERVAL_5_SEC INTERVAL_30_SEC INTERVAL_1_MIN INTERVAL_5_MIN INTERVAL_10_MIN INTERVAL_15_MIN
*/
aggregationInterval?: pulumi.Input<string | undefined>;
/**
* Determines whether to include cross project annotations in the logs.
* This field is available only for organization configurations. If not
* specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED.
* Possible values:
* CROSS_PROJECT_METADATA_ENABLED
* CROSS_PROJECT_METADATA_DISABLED
* Possible values are: `CROSS_PROJECT_METADATA_ENABLED`, `CROSS_PROJECT_METADATA_DISABLED`.
*/
crossProjectMetadata?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum
* of 512 characters.
*/
description?: pulumi.Input<string | undefined>;
/**
* Optional. Export filter used to define which VPC Flow Logs should be logged.
*/
filterExpr?: pulumi.Input<string | undefined>;
/**
* Optional. The value of the field must be in (0, 1]. The sampling rate
* of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the
* sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use
* the state field instead. Default value is 1.0
*/
flowSampling?: pulumi.Input<number | undefined>;
/**
* Optional. Resource labels to represent the user-provided metadata.
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource
* within its parent collection as described in https://google.aip.dev/122. See documentation
* for resource type `networkmanagement.googleapis.com/VpcFlowLogsConfig`.
*/
location: pulumi.Input<string>;
/**
* Optional. Configures whether all, none or a subset of metadata fields
* should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.
* Possible values: METADATA_UNSPECIFIED INCLUDE_ALL_METADATA EXCLUDE_ALL_METADATA CUSTOM_METADATA
*/
metadata?: pulumi.Input<string | undefined>;
/**
* Optional. Custom metadata fields to include in the reported VPC flow
* logs. Can only be specified if \"metadata\" was set to CUSTOM_METADATA.
*/
metadataFields?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
organization: pulumi.Input<string>;
/**
* Optional. The state of the VPC Flow Log configuration. Default value
* is ENABLED. When creating a new configuration, it must be enabled.
* Possible values: ENABLED DISABLED
*/
state?: pulumi.Input<string | undefined>;
/**
* Required. ID of the `VpcFlowLogsConfig`.
*/
vpcFlowLogsConfigId: pulumi.Input<string>;
}
//# sourceMappingURL=organizationVpcFlowLogsConfig.d.ts.map