@cdktf/provider-azurerm
Version:
Prebuilt azurerm Provider for Terraform CDK (cdktf)
212 lines (211 loc) • 11.1 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface ApiManagementNamedValueConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/api_management_named_value#api_management_name ApiManagementNamedValue#api_management_name}
*/
readonly apiManagementName: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/api_management_named_value#display_name ApiManagementNamedValue#display_name}
*/
readonly displayName: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/api_management_named_value#id ApiManagementNamedValue#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/api_management_named_value#name ApiManagementNamedValue#name}
*/
readonly name: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/api_management_named_value#resource_group_name ApiManagementNamedValue#resource_group_name}
*/
readonly resourceGroupName: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/api_management_named_value#secret ApiManagementNamedValue#secret}
*/
readonly secret?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/api_management_named_value#tags ApiManagementNamedValue#tags}
*/
readonly tags?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/api_management_named_value#value ApiManagementNamedValue#value}
*/
readonly value?: string;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/api_management_named_value#timeouts ApiManagementNamedValue#timeouts}
*/
readonly timeouts?: ApiManagementNamedValueTimeouts;
/**
* value_from_key_vault block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/api_management_named_value#value_from_key_vault ApiManagementNamedValue#value_from_key_vault}
*/
readonly valueFromKeyVault?: ApiManagementNamedValueValueFromKeyVault;
}
export interface ApiManagementNamedValueTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/api_management_named_value#create ApiManagementNamedValue#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/api_management_named_value#delete ApiManagementNamedValue#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/api_management_named_value#read ApiManagementNamedValue#read}
*/
readonly read?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/api_management_named_value#update ApiManagementNamedValue#update}
*/
readonly update?: string;
}
export declare function apiManagementNamedValueTimeoutsToTerraform(struct?: ApiManagementNamedValueTimeouts | cdktf.IResolvable): any;
export declare function apiManagementNamedValueTimeoutsToHclTerraform(struct?: ApiManagementNamedValueTimeouts | cdktf.IResolvable): any;
export declare class ApiManagementNamedValueTimeoutsOutputReference 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(): ApiManagementNamedValueTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: ApiManagementNamedValueTimeouts | 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;
}
export interface ApiManagementNamedValueValueFromKeyVault {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/api_management_named_value#identity_client_id ApiManagementNamedValue#identity_client_id}
*/
readonly identityClientId?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/api_management_named_value#secret_id ApiManagementNamedValue#secret_id}
*/
readonly secretId: string;
}
export declare function apiManagementNamedValueValueFromKeyVaultToTerraform(struct?: ApiManagementNamedValueValueFromKeyVaultOutputReference | ApiManagementNamedValueValueFromKeyVault): any;
export declare function apiManagementNamedValueValueFromKeyVaultToHclTerraform(struct?: ApiManagementNamedValueValueFromKeyVaultOutputReference | ApiManagementNamedValueValueFromKeyVault): any;
export declare class ApiManagementNamedValueValueFromKeyVaultOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
/**
* @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(): ApiManagementNamedValueValueFromKeyVault | undefined;
set internalValue(value: ApiManagementNamedValueValueFromKeyVault | undefined);
private _identityClientId?;
get identityClientId(): string;
set identityClientId(value: string);
resetIdentityClientId(): void;
get identityClientIdInput(): string | undefined;
private _secretId?;
get secretId(): string;
set secretId(value: string);
get secretIdInput(): string | undefined;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/api_management_named_value azurerm_api_management_named_value}
*/
export declare class ApiManagementNamedValue extends cdktf.TerraformResource {
static readonly tfResourceType = "azurerm_api_management_named_value";
/**
* Generates CDKTF code for importing a ApiManagementNamedValue 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 ApiManagementNamedValue to import
* @param importFromId The id of the existing ApiManagementNamedValue that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/api_management_named_value#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the ApiManagementNamedValue 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/api_management_named_value azurerm_api_management_named_value} 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 ApiManagementNamedValueConfig
*/
constructor(scope: Construct, id: string, config: ApiManagementNamedValueConfig);
private _apiManagementName?;
get apiManagementName(): string;
set apiManagementName(value: string);
get apiManagementNameInput(): 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 _name?;
get name(): string;
set name(value: string);
get nameInput(): string | undefined;
private _resourceGroupName?;
get resourceGroupName(): string;
set resourceGroupName(value: string);
get resourceGroupNameInput(): string | undefined;
private _secret?;
get secret(): boolean | cdktf.IResolvable;
set secret(value: boolean | cdktf.IResolvable);
resetSecret(): void;
get secretInput(): boolean | cdktf.IResolvable | undefined;
private _tags?;
get tags(): string[];
set tags(value: string[]);
resetTags(): void;
get tagsInput(): string[] | undefined;
private _value?;
get value(): string;
set value(value: string);
resetValue(): void;
get valueInput(): string | undefined;
private _timeouts;
get timeouts(): ApiManagementNamedValueTimeoutsOutputReference;
putTimeouts(value: ApiManagementNamedValueTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | ApiManagementNamedValueTimeouts | undefined;
private _valueFromKeyVault;
get valueFromKeyVault(): ApiManagementNamedValueValueFromKeyVaultOutputReference;
putValueFromKeyVault(value: ApiManagementNamedValueValueFromKeyVault): void;
resetValueFromKeyVault(): void;
get valueFromKeyVaultInput(): ApiManagementNamedValueValueFromKeyVault | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}