@microsoft/terraform-cdk-constructs 0.0.3-pre.6 → 1.0.0

package/lib/core-azure/lib/azapi/providers-azapi/resource-action/index.d.ts

@@ -0,0 +1,387 @@
+import * as cdktf from "cdktf";
+import { Construct } from "constructs";
+export interface ResourceActionConfig extends cdktf.TerraformMetaArguments {
+    /**
+     * The name of the resource action. It's also possible to make HTTP requests towards the resource ID if leave this field empty.
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#action ResourceAction#action}
+     */
+    readonly action?: string;
+    /**
+     * A dynamic attribute that contains the request body.
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#body ResourceAction#body}
+     */
+    readonly body?: {
+        [key: string]: any;
+    };
+    /**
+     * A map of headers to include in the request
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#headers ResourceAction#headers}
+     */
+    readonly headers?: {
+        [key: string]: string;
+    };
+    /**
+     * A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#locks ResourceAction#locks}
+     */
+    readonly locks?: string[];
+    /**
+     * Specifies the HTTP method of the azure resource action. Allowed values are `POST`, `PATCH`, `PUT` and `DELETE`. Defaults to `POST`.
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#method ResourceAction#method}
+     */
+    readonly method?: string;
+    /**
+     * A map of query parameters to include in the request
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#query_parameters ResourceAction#query_parameters}
+     */
+    readonly queryParameters?: {
+        [key: string]: string[];
+    } | cdktf.IResolvable;
+    /**
+     * The ID of an existing Azure source.
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#resource_id ResourceAction#resource_id}
+     */
+    readonly resourceId: string;
+    /**
+    * The attribute can accept either a list or a map.
+  
+  - **List**: A list of paths that need to be exported from the response body. Setting it to `["*"]` will export the full response body. Here's an example. If it sets to `["properties.loginServer", "properties.policies.quarantinePolicy.status"]`, it will set the following HCL object to the computed property output.
+  
+      ```text
+      {
+          properties = {
+              loginServer = "registry1.azurecr.io"
+              policies = {
+                  quarantinePolicy = {
+                      status = "disabled"
+                  }
+              }
+          }
+      }
+      ```
+  
+  - **Map**: A map where the key is the name for the result and the value is a JMESPath query string to filter the response. Here's an example. If it sets to `{"login_server": "properties.loginServer", "quarantine_status": "properties.policies.quarantinePolicy.status"}`, it will set the following HCL object to the computed property output.
+  
+      ```text
+      {
+          "login_server" = "registry1.azurecr.io"
+          "quarantine_status" = "disabled"
+      }
+      ```
+  
+  To learn more about JMESPath, visit [JMESPath](https://jmespath.org/).
+  
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#response_export_values ResourceAction#response_export_values}
+    */
+    readonly responseExportValues?: {
+        [key: string]: any;
+    };
+    /**
+     * The retry object supports the following attributes:
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#retry ResourceAction#retry}
+     */
+    readonly retry?: ResourceActionRetry;
+    /**
+    * The attribute can accept either a list or a map.
+  
+  - **List**: A list of paths that need to be exported from the response body. Setting it to `["*"]` will export the full response body. Here's an example. If it sets to `["properties.loginServer", "properties.policies.quarantinePolicy.status"]`, it will set the following HCL object to the computed property output.
+  
+      ```text
+      {
+          properties = {
+              loginServer = "registry1.azurecr.io"
+              policies = {
+                  quarantinePolicy = {
+                      status = "disabled"
+                  }
+              }
+          }
+      }
+      ```
+  
+  - **Map**: A map where the key is the name for the result and the value is a JMESPath query string to filter the response. Here's an example. If it sets to `{"login_server": "properties.loginServer", "quarantine_status": "properties.policies.quarantinePolicy.status"}`, it will set the following HCL object to the computed property output.
+  
+      ```text
+      {
+          "login_server" = "registry1.azurecr.io"
+          "quarantine_status" = "disabled"
+      }
+      ```
+  
+  To learn more about JMESPath, visit [JMESPath](https://jmespath.org/).
+  
+    *
+    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#sensitive_response_export_values ResourceAction#sensitive_response_export_values}
+    */
+    readonly sensitiveResponseExportValues?: {
+        [key: string]: any;
+    };
+    /**
+     * In a format like `<resource-type>@<api-version>`. `<resource-type>` is the Azure resource type, for example, `Microsoft.Storage/storageAccounts`. `<api-version>` is version of the API used to manage this azure resource.
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#type ResourceAction#type}
+     */
+    readonly type: string;
+    /**
+     * When to perform the action, value must be one of: `apply`, `destroy`. Default is `apply`.
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#when ResourceAction#when}
+     */
+    readonly when?: string;
+    /**
+     * timeouts block
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#timeouts ResourceAction#timeouts}
+     */
+    readonly timeouts?: ResourceActionTimeouts;
+}
+export interface ResourceActionRetry {
+    /**
+     * A list of regular expressions to match against error messages. If any of the regular expressions match, the request will be retried.
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#error_message_regex ResourceAction#error_message_regex}
+     */
+    readonly errorMessageRegex: string[];
+    /**
+     * The base number of seconds to wait between retries. Default is `10`.
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#interval_seconds ResourceAction#interval_seconds}
+     */
+    readonly intervalSeconds?: number;
+    /**
+     * The maximum number of seconds to wait between retries. Default is `180`.
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#max_interval_seconds ResourceAction#max_interval_seconds}
+     */
+    readonly maxIntervalSeconds?: number;
+    /**
+     * The multiplier to apply to the interval between retries. Default is `1.5`.
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#multiplier ResourceAction#multiplier}
+     */
+    readonly multiplier?: number;
+    /**
+     * The randomization factor to apply to the interval between retries. The formula for the randomized interval is: `RetryInterval * (random value in range [1 - RandomizationFactor, 1 + RandomizationFactor])`. Therefore set to zero `0.0` for no randomization. Default is `0.5`.
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#randomization_factor ResourceAction#randomization_factor}
+     */
+    readonly randomizationFactor?: number;
+}
+export declare function resourceActionRetryToTerraform(struct?: ResourceActionRetry | cdktf.IResolvable): any;
+export declare class ResourceActionRetryOutputReference extends cdktf.ComplexObject {
+    private isEmptyObject;
+    private resolvableValue?;
+    /**
+     * @param terraformResource The parent resource
+     * @param terraformAttribute The attribute on the parent resource this class is referencing
+     */
+    constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string);
+    get internalValue(): ResourceActionRetry | cdktf.IResolvable | undefined;
+    set internalValue(value: ResourceActionRetry | cdktf.IResolvable | undefined);
+    private _errorMessageRegex?;
+    get errorMessageRegex(): string[];
+    set errorMessageRegex(value: string[]);
+    get errorMessageRegexInput(): string[] | undefined;
+    private _intervalSeconds?;
+    get intervalSeconds(): number;
+    set intervalSeconds(value: number);
+    resetIntervalSeconds(): void;
+    get intervalSecondsInput(): number | undefined;
+    private _maxIntervalSeconds?;
+    get maxIntervalSeconds(): number;
+    set maxIntervalSeconds(value: number);
+    resetMaxIntervalSeconds(): void;
+    get maxIntervalSecondsInput(): number | undefined;
+    private _multiplier?;
+    get multiplier(): number;
+    set multiplier(value: number);
+    resetMultiplier(): void;
+    get multiplierInput(): number | undefined;
+    private _randomizationFactor?;
+    get randomizationFactor(): number;
+    set randomizationFactor(value: number);
+    resetRandomizationFactor(): void;
+    get randomizationFactorInput(): number | undefined;
+}
+export interface ResourceActionTimeouts {
+    /**
+     * A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#create ResourceAction#create}
+     */
+    readonly create?: string;
+    /**
+     * A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#delete ResourceAction#delete}
+     */
+    readonly delete?: string;
+    /**
+     * A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#read ResourceAction#read}
+     */
+    readonly read?: string;
+    /**
+     * A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
+     *
+     * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action#update ResourceAction#update}
+     */
+    readonly update?: string;
+}
+export declare function resourceActionTimeoutsToTerraform(struct?: ResourceActionTimeouts | cdktf.IResolvable): any;
+export declare class ResourceActionTimeoutsOutputReference extends cdktf.ComplexObject {
+    private isEmptyObject;
+    private resolvableValue?;
+    /**
+     * @param terraformResource The parent resource
+     * @param terraformAttribute The attribute on the parent resource this class is referencing
+     */
+    constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string);
+    get internalValue(): ResourceActionTimeouts | cdktf.IResolvable | undefined;
+    set internalValue(value: ResourceActionTimeouts | cdktf.IResolvable | undefined);
+    private _create?;
+    get create(): string;
+    set create(value: string);
+    resetCreate(): void;
+    get createInput(): string | undefined;
+    private _delete?;
+    get delete(): string;
+    set delete(value: string);
+    resetDelete(): void;
+    get deleteInput(): string | undefined;
+    private _read?;
+    get read(): string;
+    set read(value: string);
+    resetRead(): void;
+    get readInput(): string | undefined;
+    private _update?;
+    get update(): string;
+    set update(value: string);
+    resetUpdate(): void;
+    get updateInput(): string | undefined;
+}
+/**
+ * Represents a {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action azapi_resource_action}
+ */
+export declare class ResourceAction extends cdktf.TerraformResource {
+    static readonly tfResourceType = "azapi_resource_action";
+    /**
+     * Create a new {@link https://registry.terraform.io/providers/azure/azapi/2.7.0/docs/resources/resource_action azapi_resource_action} Resource
+     *
+     * @param scope The scope in which to define this construct
+     * @param id The scoped construct ID. Must be unique amongst siblings in the same scope
+     * @param options ResourceActionConfig
+     */
+    constructor(scope: Construct, id: string, config: ResourceActionConfig);
+    private _action?;
+    get action(): string;
+    set action(value: string);
+    resetAction(): void;
+    get actionInput(): string | undefined;
+    private _body?;
+    get body(): {
+        [key: string]: any;
+    };
+    set body(value: {
+        [key: string]: any;
+    });
+    resetBody(): void;
+    get bodyInput(): {
+        [key: string]: any;
+    } | undefined;
+    private _headers?;
+    get headers(): {
+        [key: string]: string;
+    };
+    set headers(value: {
+        [key: string]: string;
+    });
+    resetHeaders(): void;
+    get headersInput(): {
+        [key: string]: string;
+    } | undefined;
+    get id(): string;
+    private _locks?;
+    get locks(): string[];
+    set locks(value: string[]);
+    resetLocks(): void;
+    get locksInput(): string[] | undefined;
+    private _method?;
+    get method(): string;
+    set method(value: string);
+    resetMethod(): void;
+    get methodInput(): string | undefined;
+    private _output;
+    get output(): cdktf.AnyMap;
+    private _queryParameters?;
+    get queryParameters(): {
+        [key: string]: string[];
+    } | cdktf.IResolvable;
+    set queryParameters(value: {
+        [key: string]: string[];
+    } | cdktf.IResolvable);
+    resetQueryParameters(): void;
+    get queryParametersInput(): cdktf.IResolvable | {
+        [key: string]: string[];
+    } | undefined;
+    private _resourceId?;
+    get resourceId(): string;
+    set resourceId(value: string);
+    get resourceIdInput(): string | undefined;
+    private _responseExportValues?;
+    get responseExportValues(): {
+        [key: string]: any;
+    };
+    set responseExportValues(value: {
+        [key: string]: any;
+    });
+    resetResponseExportValues(): void;
+    get responseExportValuesInput(): {
+        [key: string]: any;
+    } | undefined;
+    private _retry;
+    get retry(): ResourceActionRetryOutputReference;
+    putRetry(value: ResourceActionRetry): void;
+    resetRetry(): void;
+    get retryInput(): cdktf.IResolvable | ResourceActionRetry | undefined;
+    private _sensitiveOutput;
+    get sensitiveOutput(): cdktf.AnyMap;
+    private _sensitiveResponseExportValues?;
+    get sensitiveResponseExportValues(): {
+        [key: string]: any;
+    };
+    set sensitiveResponseExportValues(value: {
+        [key: string]: any;
+    });
+    resetSensitiveResponseExportValues(): void;
+    get sensitiveResponseExportValuesInput(): {
+        [key: string]: any;
+    } | undefined;
+    private _type?;
+    get type(): string;
+    set type(value: string);
+    get typeInput(): string | undefined;
+    private _when?;
+    get when(): string;
+    set when(value: string);
+    resetWhen(): void;
+    get whenInput(): string | undefined;
+    private _timeouts;
+    get timeouts(): ResourceActionTimeoutsOutputReference;
+    putTimeouts(value: ResourceActionTimeouts): void;
+    resetTimeouts(): void;
+    get timeoutsInput(): cdktf.IResolvable | ResourceActionTimeouts | undefined;
+    protected synthesizeAttributes(): {
+        [name: string]: any;
+    };
+}