UNPKG

@pulumi/gcp

Version:

A Pulumi package for creating and managing Google Cloud Platform resources.

291 lines • 14 kB
import * as pulumi from "@pulumi/pulumi"; /** * Represents a Regional SSL policy. SSL policies give you the ability to control the * features of SSL that your SSL proxy or HTTPS load balancer negotiates. * * To get more information about RegionSslPolicy, see: * * * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/regionSslPolicies) * * How-to Guides * * [Using SSL Policies](https://cloud.google.com/compute/docs/load-balancing/ssl-policies) * * ## Import * * RegionSslPolicy can be imported using any of these accepted formats: * * * `projects/{{project}}/regions/{{region}}/sslPolicies/{{name}}` * * `{{project}}/{{region}}/{{name}}` * * `{{region}}/{{name}}` * * `{{name}}` * * When using the `pulumi import` command, RegionSslPolicy can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:compute/regionSslPolicy:RegionSslPolicy default projects/{{project}}/regions/{{region}}/sslPolicies/{{name}} * $ pulumi import gcp:compute/regionSslPolicy:RegionSslPolicy default {{project}}/{{region}}/{{name}} * $ pulumi import gcp:compute/regionSslPolicy:RegionSslPolicy default {{region}}/{{name}} * $ pulumi import gcp:compute/regionSslPolicy:RegionSslPolicy default {{name}} * ``` */ export declare class RegionSslPolicy extends pulumi.CustomResource { /** * Get an existing RegionSslPolicy 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?: RegionSslPolicyState, opts?: pulumi.CustomResourceOptions): RegionSslPolicy; /** * Returns true if the given object is an instance of RegionSslPolicy. 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 RegionSslPolicy; /** * Creation timestamp in RFC3339 text format. */ readonly creationTimestamp: pulumi.Output<string>; /** * A list of features enabled when the selected profile is CUSTOM. The * method returns the set of features that can be specified in this * list. This field must be empty if the profile is not CUSTOM. * See the [official documentation](https://cloud.google.com/compute/docs/load-balancing/ssl-policies#profilefeaturesupport) * for which ciphers are available to use. **Note**: this argument * *must* be present when using the `CUSTOM` profile. This argument * *must not* be present when using any other profile. */ readonly customFeatures: pulumi.Output<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. */ readonly deletionPolicy: pulumi.Output<string>; /** * An optional description of this resource. */ readonly description: pulumi.Output<string | undefined>; /** * The list of features enabled in the SSL policy. */ readonly enabledFeatures: pulumi.Output<string[]>; /** * Fingerprint of this resource. A hash of the contents stored in this * object. This field is used in optimistic locking. */ readonly fingerprint: pulumi.Output<string>; /** * The minimum version of SSL protocol that can be used by the clients * to establish a connection with the load balancer. When set to * `TLS_1_3`, the profile field must be set to `RESTRICTED`. * Default value is `TLS_1_0`. * Possible values are: `TLS_1_0`, `TLS_1_1`, `TLS_1_2`, `TLS_1_3`. */ readonly minTlsVersion: pulumi.Output<string | undefined>; /** * Name of the resource. Provided by the client when the resource is * created. The name must be 1-63 characters long, and comply with * RFC1035. Specifically, the name must be 1-63 characters long and match * the regular expression `a-z?` which means the * first character must be a lowercase letter, and all following * characters must be a dash, lowercase letter, or digit, except the last * character, which cannot be a dash. */ readonly name: pulumi.Output<string>; /** * Profile specifies the set of SSL features that can be used by the * load balancer when negotiating SSL with clients. If using `CUSTOM`, * the set of SSL features to enable must be specified in the * `customFeatures` field. * See the [official documentation](https://cloud.google.com/compute/docs/load-balancing/ssl-policies#profilefeaturesupport) * for information on what cipher suites each profile provides. If * `CUSTOM` is used, the `customFeatures` attribute **must be set**. * If set to `FIPS_202205`, `minTlsVersion` must also be set to * `TLS_1_2`. * Default value is `COMPATIBLE`. * Possible values are: `COMPATIBLE`, `MODERN`, `RESTRICTED`, `CUSTOM`, `FIPS_202205`. */ readonly profile: pulumi.Output<string | undefined>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output<string>; /** * The region where the regional SSL policy resides. */ readonly region: pulumi.Output<string>; /** * The URI of the created resource. */ readonly selfLink: pulumi.Output<string>; /** * Create a RegionSslPolicy 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?: RegionSslPolicyArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering RegionSslPolicy resources. */ export interface RegionSslPolicyState { /** * Creation timestamp in RFC3339 text format. */ creationTimestamp?: pulumi.Input<string | undefined>; /** * A list of features enabled when the selected profile is CUSTOM. The * method returns the set of features that can be specified in this * list. This field must be empty if the profile is not CUSTOM. * See the [official documentation](https://cloud.google.com/compute/docs/load-balancing/ssl-policies#profilefeaturesupport) * for which ciphers are available to use. **Note**: this argument * *must* be present when using the `CUSTOM` profile. This argument * *must not* be present when using any other profile. */ customFeatures?: pulumi.Input<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>; /** * An optional description of this resource. */ description?: pulumi.Input<string | undefined>; /** * The list of features enabled in the SSL policy. */ enabledFeatures?: pulumi.Input<pulumi.Input<string>[] | undefined>; /** * Fingerprint of this resource. A hash of the contents stored in this * object. This field is used in optimistic locking. */ fingerprint?: pulumi.Input<string | undefined>; /** * The minimum version of SSL protocol that can be used by the clients * to establish a connection with the load balancer. When set to * `TLS_1_3`, the profile field must be set to `RESTRICTED`. * Default value is `TLS_1_0`. * Possible values are: `TLS_1_0`, `TLS_1_1`, `TLS_1_2`, `TLS_1_3`. */ minTlsVersion?: pulumi.Input<string | undefined>; /** * Name of the resource. Provided by the client when the resource is * created. The name must be 1-63 characters long, and comply with * RFC1035. Specifically, the name must be 1-63 characters long and match * the regular expression `a-z?` which means the * first character must be a lowercase letter, and all following * characters must be a dash, lowercase letter, or digit, except the last * character, which cannot be a dash. */ name?: pulumi.Input<string | undefined>; /** * Profile specifies the set of SSL features that can be used by the * load balancer when negotiating SSL with clients. If using `CUSTOM`, * the set of SSL features to enable must be specified in the * `customFeatures` field. * See the [official documentation](https://cloud.google.com/compute/docs/load-balancing/ssl-policies#profilefeaturesupport) * for information on what cipher suites each profile provides. If * `CUSTOM` is used, the `customFeatures` attribute **must be set**. * If set to `FIPS_202205`, `minTlsVersion` must also be set to * `TLS_1_2`. * Default value is `COMPATIBLE`. * Possible values are: `COMPATIBLE`, `MODERN`, `RESTRICTED`, `CUSTOM`, `FIPS_202205`. */ profile?: pulumi.Input<string | undefined>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input<string | undefined>; /** * The region where the regional SSL policy resides. */ region?: pulumi.Input<string | undefined>; /** * The URI of the created resource. */ selfLink?: pulumi.Input<string | undefined>; } /** * The set of arguments for constructing a RegionSslPolicy resource. */ export interface RegionSslPolicyArgs { /** * A list of features enabled when the selected profile is CUSTOM. The * method returns the set of features that can be specified in this * list. This field must be empty if the profile is not CUSTOM. * See the [official documentation](https://cloud.google.com/compute/docs/load-balancing/ssl-policies#profilefeaturesupport) * for which ciphers are available to use. **Note**: this argument * *must* be present when using the `CUSTOM` profile. This argument * *must not* be present when using any other profile. */ customFeatures?: pulumi.Input<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>; /** * An optional description of this resource. */ description?: pulumi.Input<string | undefined>; /** * The minimum version of SSL protocol that can be used by the clients * to establish a connection with the load balancer. When set to * `TLS_1_3`, the profile field must be set to `RESTRICTED`. * Default value is `TLS_1_0`. * Possible values are: `TLS_1_0`, `TLS_1_1`, `TLS_1_2`, `TLS_1_3`. */ minTlsVersion?: pulumi.Input<string | undefined>; /** * Name of the resource. Provided by the client when the resource is * created. The name must be 1-63 characters long, and comply with * RFC1035. Specifically, the name must be 1-63 characters long and match * the regular expression `a-z?` which means the * first character must be a lowercase letter, and all following * characters must be a dash, lowercase letter, or digit, except the last * character, which cannot be a dash. */ name?: pulumi.Input<string | undefined>; /** * Profile specifies the set of SSL features that can be used by the * load balancer when negotiating SSL with clients. If using `CUSTOM`, * the set of SSL features to enable must be specified in the * `customFeatures` field. * See the [official documentation](https://cloud.google.com/compute/docs/load-balancing/ssl-policies#profilefeaturesupport) * for information on what cipher suites each profile provides. If * `CUSTOM` is used, the `customFeatures` attribute **must be set**. * If set to `FIPS_202205`, `minTlsVersion` must also be set to * `TLS_1_2`. * Default value is `COMPATIBLE`. * Possible values are: `COMPATIBLE`, `MODERN`, `RESTRICTED`, `CUSTOM`, `FIPS_202205`. */ profile?: pulumi.Input<string | undefined>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input<string | undefined>; /** * The region where the regional SSL policy resides. */ region?: pulumi.Input<string | undefined>; } //# sourceMappingURL=regionSslPolicy.d.ts.map