@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
274 lines • 10.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Represents a feedback report from an Advanced API Security customer.
* Manages customer feedback about ML models.
*
* To get more information about SecurityFeedback, see:
*
* * [API documentation](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.securityFeedback/create)
* * How-to Guides
* * [Create a SecurityFeedback](https://docs.cloud.google.com/apigee/docs/api-security/abuse-detection#exclude-traffic-from-abuse-detection)
*
* ## Example Usage
*
* ### Apigee Security Feedback Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const current = gcp.organizations.getClientConfig({});
* const apigeeNetwork = new gcp.compute.Network("apigee_network", {name: "apigee-network"});
* const apigeeRange = new gcp.compute.GlobalAddress("apigee_range", {
* name: "apigee-range",
* purpose: "VPC_PEERING",
* addressType: "INTERNAL",
* prefixLength: 16,
* network: apigeeNetwork.id,
* });
* const apigeeVpcConnection = new gcp.servicenetworking.Connection("apigee_vpc_connection", {
* network: apigeeNetwork.id,
* service: "servicenetworking.googleapis.com",
* reservedPeeringRanges: [apigeeRange.name],
* });
* const apigeeOrg = new gcp.apigee.Organization("apigee_org", {
* analyticsRegion: "us-central1",
* projectId: current.then(current => current.project),
* authorizedNetwork: apigeeNetwork.id,
* }, {
* dependsOn: [apigeeVpcConnection],
* });
* const apigeeOrgSecurityAddonsConfig = new gcp.apigee.AddonsConfig("apigee_org_security_addons_config", {
* org: apigeeOrg.name,
* addonsConfig: {
* apiSecurityConfig: {
* enabled: true,
* },
* },
* });
* const securityFeedback = new gcp.apigee.SecurityFeedback("security_feedback", {
* feedbackId: "my-feedback",
* orgId: apigeeOrg.id,
* displayName: "terraform test display name",
* feedbackType: "EXCLUDED_DETECTION",
* reason: "INTERNAL_SYSTEM",
* comment: "terraform test comment",
* feedbackContexts: [
* {
* attribute: "ATTRIBUTE_ENVIRONMENTS",
* values: [apigeeEnvironment.name],
* },
* {
* attribute: "ATTRIBUTE_IP_ADDRESS_RANGES",
* values: [
* "10.0.0.0",
* "172.16.0.0/12",
* ],
* },
* ],
* }, {
* dependsOn: [apigeeOrgSecurityAddonsConfig],
* });
* ```
*
* ## Import
*
* SecurityFeedback can be imported using any of these accepted formats:
*
* * `{{org_id}}/securityFeedback/{{feedback_id}}`
* * `{{org_id}}/{{feedback_id}}`
*
* When using the `pulumi import` command, SecurityFeedback can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:apigee/securityFeedback:SecurityFeedback default {{org_id}}/securityFeedback/{{feedback_id}}
* $ pulumi import gcp:apigee/securityFeedback:SecurityFeedback default {{org_id}}/{{feedback_id}}
* ```
*/
export declare class SecurityFeedback extends pulumi.CustomResource {
/**
* Get an existing SecurityFeedback 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?: SecurityFeedbackState, opts?: pulumi.CustomResourceOptions): SecurityFeedback;
/**
* Returns true if the given object is an instance of SecurityFeedback. 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 SecurityFeedback;
/**
* Optional text the user can provide for additional, unstructured context.
*/
readonly comment: pulumi.Output<string | undefined>;
/**
* The time when this specific feedback id was created.
*/
readonly createTime: 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>;
/**
* The display name of the feedback.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* One or more attribute/value pairs for constraining the feedback.
* Structure is documented below.
*/
readonly feedbackContexts: pulumi.Output<outputs.apigee.SecurityFeedbackFeedbackContext[]>;
/**
* Resource ID of the security feedback.
*/
readonly feedbackId: pulumi.Output<string>;
/**
* The type of feedback being submitted.
* Possible values are: `EXCLUDED_DETECTION`.
*/
readonly feedbackType: pulumi.Output<string>;
/**
* Name of the security feedback resource,
* in the format `organizations/{{org_name}}/securityFeedback/{{feedback_id}}`.
*/
readonly name: pulumi.Output<string>;
/**
* The Apigee Organization associated with the Apigee Security Feedback,
* in the format `organizations/{{org_name}}`.
*/
readonly orgId: pulumi.Output<string>;
/**
* The reason for the feedback.
* Possible values are: `INTERNAL_SYSTEM`, `NON_RISK_CLIENT`, `NAT`, `PENETRATION_TEST`, `OTHER`.
*/
readonly reason: pulumi.Output<string | undefined>;
/**
* The time when this specific feedback id was updated.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a SecurityFeedback 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: SecurityFeedbackArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SecurityFeedback resources.
*/
export interface SecurityFeedbackState {
/**
* Optional text the user can provide for additional, unstructured context.
*/
comment?: pulumi.Input<string | undefined>;
/**
* The time when this specific feedback id was created.
*/
createTime?: 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>;
/**
* The display name of the feedback.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* One or more attribute/value pairs for constraining the feedback.
* Structure is documented below.
*/
feedbackContexts?: pulumi.Input<pulumi.Input<inputs.apigee.SecurityFeedbackFeedbackContext>[] | undefined>;
/**
* Resource ID of the security feedback.
*/
feedbackId?: pulumi.Input<string | undefined>;
/**
* The type of feedback being submitted.
* Possible values are: `EXCLUDED_DETECTION`.
*/
feedbackType?: pulumi.Input<string | undefined>;
/**
* Name of the security feedback resource,
* in the format `organizations/{{org_name}}/securityFeedback/{{feedback_id}}`.
*/
name?: pulumi.Input<string | undefined>;
/**
* The Apigee Organization associated with the Apigee Security Feedback,
* in the format `organizations/{{org_name}}`.
*/
orgId?: pulumi.Input<string | undefined>;
/**
* The reason for the feedback.
* Possible values are: `INTERNAL_SYSTEM`, `NON_RISK_CLIENT`, `NAT`, `PENETRATION_TEST`, `OTHER`.
*/
reason?: pulumi.Input<string | undefined>;
/**
* The time when this specific feedback id was updated.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a SecurityFeedback resource.
*/
export interface SecurityFeedbackArgs {
/**
* Optional text the user can provide for additional, unstructured context.
*/
comment?: 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>;
/**
* The display name of the feedback.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* One or more attribute/value pairs for constraining the feedback.
* Structure is documented below.
*/
feedbackContexts: pulumi.Input<pulumi.Input<inputs.apigee.SecurityFeedbackFeedbackContext>[]>;
/**
* Resource ID of the security feedback.
*/
feedbackId: pulumi.Input<string>;
/**
* The type of feedback being submitted.
* Possible values are: `EXCLUDED_DETECTION`.
*/
feedbackType: pulumi.Input<string>;
/**
* The Apigee Organization associated with the Apigee Security Feedback,
* in the format `organizations/{{org_name}}`.
*/
orgId: pulumi.Input<string>;
/**
* The reason for the feedback.
* Possible values are: `INTERNAL_SYSTEM`, `NON_RISK_CLIENT`, `NAT`, `PENETRATION_TEST`, `OTHER`.
*/
reason?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=securityFeedback.d.ts.map