@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
229 lines • 9.16 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Security profile for risk assessment version 2 in Apigee.
*
* To get more information about SecurityProfileV2, see:
*
* * [API documentation](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.securityProfilesV2/create)
* * How-to Guides
* * [Creating a security profile](https://cloud.google.com/apigee/docs/api-security/security-scores#security-profiles-v2)
*
* ## Example Usage
*
* ### Apigee Security Profile V2 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 securityProfileV2 = new gcp.apigee.SecurityProfileV2("security_profile_v2", {
* profileId: "my-profile",
* orgId: apigeeOrg.id,
* description: "terraform test description",
* profileAssessmentConfigs: [
* {
* assessment: "auth-policies-check",
* weight: "MAJOR",
* },
* {
* assessment: "mediation-policies-check",
* weight: "MODERATE",
* },
* {
* assessment: "threat-policies-check",
* weight: "MINOR",
* },
* ],
* }, {
* dependsOn: [apigeeOrgSecurityAddonsConfig],
* });
* ```
*
* ## Import
*
* SecurityProfileV2 can be imported using any of these accepted formats:
*
* * `{{org_id}}/securityProfilesV2/{{profile_id}}`
* * `{{org_id}}/{{profile_id}}`
*
* When using the `pulumi import` command, SecurityProfileV2 can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:apigee/securityProfileV2:SecurityProfileV2 default {{org_id}}/securityProfilesV2/{{profile_id}}
* $ pulumi import gcp:apigee/securityProfileV2:SecurityProfileV2 default {{org_id}}/{{profile_id}}
* ```
*/
export declare class SecurityProfileV2 extends pulumi.CustomResource {
/**
* Get an existing SecurityProfileV2 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?: SecurityProfileV2State, opts?: pulumi.CustomResourceOptions): SecurityProfileV2;
/**
* Returns true if the given object is an instance of SecurityProfileV2. 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 SecurityProfileV2;
/**
* The timestamp at which this profile 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>;
/**
* Description of the security profile.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Name of the security profile v2 resource,
* in the format `organizations/{{org_name}}/securityProfilesV2/{{profile_id}}`.
*/
readonly name: pulumi.Output<string>;
/**
* The Apigee Organization associated with the Apigee Security Profile V2,
* in the format `organizations/{{org_name}}`.
*/
readonly orgId: pulumi.Output<string>;
/**
* A map of the assessment name and the assessment config.
* Structure is documented below.
*/
readonly profileAssessmentConfigs: pulumi.Output<outputs.apigee.SecurityProfileV2ProfileAssessmentConfig[]>;
/**
* Resource ID of the security profile.
*/
readonly profileId: pulumi.Output<string>;
/**
* The timestamp at which this profile was most recently updated.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a SecurityProfileV2 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: SecurityProfileV2Args, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SecurityProfileV2 resources.
*/
export interface SecurityProfileV2State {
/**
* The timestamp at which this profile 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>;
/**
* Description of the security profile.
*/
description?: pulumi.Input<string | undefined>;
/**
* Name of the security profile v2 resource,
* in the format `organizations/{{org_name}}/securityProfilesV2/{{profile_id}}`.
*/
name?: pulumi.Input<string | undefined>;
/**
* The Apigee Organization associated with the Apigee Security Profile V2,
* in the format `organizations/{{org_name}}`.
*/
orgId?: pulumi.Input<string | undefined>;
/**
* A map of the assessment name and the assessment config.
* Structure is documented below.
*/
profileAssessmentConfigs?: pulumi.Input<pulumi.Input<inputs.apigee.SecurityProfileV2ProfileAssessmentConfig>[] | undefined>;
/**
* Resource ID of the security profile.
*/
profileId?: pulumi.Input<string | undefined>;
/**
* The timestamp at which this profile was most recently updated.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a SecurityProfileV2 resource.
*/
export interface SecurityProfileV2Args {
/**
* 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>;
/**
* Description of the security profile.
*/
description?: pulumi.Input<string | undefined>;
/**
* The Apigee Organization associated with the Apigee Security Profile V2,
* in the format `organizations/{{org_name}}`.
*/
orgId: pulumi.Input<string>;
/**
* A map of the assessment name and the assessment config.
* Structure is documented below.
*/
profileAssessmentConfigs: pulumi.Input<pulumi.Input<inputs.apigee.SecurityProfileV2ProfileAssessmentConfig>[]>;
/**
* Resource ID of the security profile.
*/
profileId: pulumi.Input<string>;
}
//# sourceMappingURL=securityProfileV2.d.ts.map