@cdktf/provider-azurerm
Version:
Prebuilt azurerm Provider for Terraform CDK (cdktf)
189 lines (188 loc) • 8.92 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface PolicyDefinitionConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/policy_definition#description PolicyDefinition#description}
*/
readonly description?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/policy_definition#display_name PolicyDefinition#display_name}
*/
readonly displayName: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/policy_definition#id PolicyDefinition#id}
*
* Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
* If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
*/
readonly id?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/policy_definition#management_group_id PolicyDefinition#management_group_id}
*/
readonly managementGroupId?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/policy_definition#metadata PolicyDefinition#metadata}
*/
readonly metadata?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/policy_definition#mode PolicyDefinition#mode}
*/
readonly mode: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/policy_definition#name PolicyDefinition#name}
*/
readonly name: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/policy_definition#parameters PolicyDefinition#parameters}
*/
readonly parameters?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/policy_definition#policy_rule PolicyDefinition#policy_rule}
*/
readonly policyRule?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/policy_definition#policy_type PolicyDefinition#policy_type}
*/
readonly policyType: string;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/policy_definition#timeouts PolicyDefinition#timeouts}
*/
readonly timeouts?: PolicyDefinitionTimeouts;
}
export interface PolicyDefinitionTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/policy_definition#create PolicyDefinition#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/policy_definition#delete PolicyDefinition#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/policy_definition#read PolicyDefinition#read}
*/
readonly read?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/policy_definition#update PolicyDefinition#update}
*/
readonly update?: string;
}
export declare function policyDefinitionTimeoutsToTerraform(struct?: PolicyDefinitionTimeouts | cdktf.IResolvable): any;
export declare function policyDefinitionTimeoutsToHclTerraform(struct?: PolicyDefinitionTimeouts | cdktf.IResolvable): any;
export declare class PolicyDefinitionTimeoutsOutputReference 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(): PolicyDefinitionTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: PolicyDefinitionTimeouts | 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/hashicorp/azurerm/3.116.0/docs/resources/policy_definition azurerm_policy_definition}
*/
export declare class PolicyDefinition extends cdktf.TerraformResource {
static readonly tfResourceType = "azurerm_policy_definition";
/**
* Generates CDKTF code for importing a PolicyDefinition resource upon running "cdktf plan <stack-name>"
* @param scope The scope in which to define this construct
* @param importToId The construct id used in the generated config for the PolicyDefinition to import
* @param importFromId The id of the existing PolicyDefinition that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/policy_definition#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the PolicyDefinition to import is found
*/
static generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: cdktf.TerraformProvider): cdktf.ImportableResource;
/**
* Create a new {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/policy_definition azurerm_policy_definition} 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 PolicyDefinitionConfig
*/
constructor(scope: Construct, id: string, config: PolicyDefinitionConfig);
private _description?;
get description(): string;
set description(value: string);
resetDescription(): void;
get descriptionInput(): string | undefined;
private _displayName?;
get displayName(): string;
set displayName(value: string);
get displayNameInput(): string | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _managementGroupId?;
get managementGroupId(): string;
set managementGroupId(value: string);
resetManagementGroupId(): void;
get managementGroupIdInput(): string | undefined;
private _metadata?;
get metadata(): string;
set metadata(value: string);
resetMetadata(): void;
get metadataInput(): string | undefined;
private _mode?;
get mode(): string;
set mode(value: string);
get modeInput(): string | undefined;
private _name?;
get name(): string;
set name(value: string);
get nameInput(): string | undefined;
private _parameters?;
get parameters(): string;
set parameters(value: string);
resetParameters(): void;
get parametersInput(): string | undefined;
private _policyRule?;
get policyRule(): string;
set policyRule(value: string);
resetPolicyRule(): void;
get policyRuleInput(): string | undefined;
private _policyType?;
get policyType(): string;
set policyType(value: string);
get policyTypeInput(): string | undefined;
get roleDefinitionIds(): string[];
private _timeouts;
get timeouts(): PolicyDefinitionTimeoutsOutputReference;
putTimeouts(value: PolicyDefinitionTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | PolicyDefinitionTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}