@cdktf/provider-kubernetes
Version:
Prebuilt kubernetes Provider for Terraform CDK (cdktf)
231 lines (230 loc) • 10.6 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface RoleConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/resources/role#id Role#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;
/**
* metadata block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/resources/role#metadata Role#metadata}
*/
readonly metadata: RoleMetadata;
/**
* rule block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/resources/role#rule Role#rule}
*/
readonly rule: RoleRule[] | cdktf.IResolvable;
}
export interface RoleMetadata {
/**
* An unstructured key value map stored with the role that may be used to store arbitrary metadata. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/resources/role#annotations Role#annotations}
*/
readonly annotations?: {
[key: string]: string;
};
/**
* Prefix, used by the server, to generate a unique name ONLY IF the `name` field has not been provided. This value will also be combined with a unique suffix. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#idempotency
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/resources/role#generate_name Role#generate_name}
*/
readonly generateName?: string;
/**
* Map of string keys and values that can be used to organize and categorize (scope and select) the role. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/resources/role#labels Role#labels}
*/
readonly labels?: {
[key: string]: string;
};
/**
* Name of the role, must be unique. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/resources/role#name Role#name}
*/
readonly name?: string;
/**
* Namespace defines the space within which name of the role must be unique.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/resources/role#namespace Role#namespace}
*/
readonly namespace?: string;
}
export declare function roleMetadataToTerraform(struct?: RoleMetadataOutputReference | RoleMetadata): any;
export declare function roleMetadataToHclTerraform(struct?: RoleMetadataOutputReference | RoleMetadata): any;
export declare class RoleMetadataOutputReference 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(): RoleMetadata | undefined;
set internalValue(value: RoleMetadata | undefined);
private _annotations?;
get annotations(): {
[key: string]: string;
};
set annotations(value: {
[key: string]: string;
});
resetAnnotations(): void;
get annotationsInput(): {
[key: string]: string;
} | undefined;
private _generateName?;
get generateName(): string;
set generateName(value: string);
resetGenerateName(): void;
get generateNameInput(): string | undefined;
get generation(): number;
private _labels?;
get labels(): {
[key: string]: string;
};
set labels(value: {
[key: string]: string;
});
resetLabels(): void;
get labelsInput(): {
[key: string]: string;
} | undefined;
private _name?;
get name(): string;
set name(value: string);
resetName(): void;
get nameInput(): string | undefined;
private _namespace?;
get namespace(): string;
set namespace(value: string);
resetNamespace(): void;
get namespaceInput(): string | undefined;
get resourceVersion(): string;
get uid(): string;
}
export interface RoleRule {
/**
* Name of the APIGroup that contains the resources
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/resources/role#api_groups Role#api_groups}
*/
readonly apiGroups: string[];
/**
* White list of names that the rule applies to
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/resources/role#resource_names Role#resource_names}
*/
readonly resourceNames?: string[];
/**
* List of resources that the rule applies to
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/resources/role#resources Role#resources}
*/
readonly resources: string[];
/**
* List of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/resources/role#verbs Role#verbs}
*/
readonly verbs: string[];
}
export declare function roleRuleToTerraform(struct?: RoleRule | cdktf.IResolvable): any;
export declare function roleRuleToHclTerraform(struct?: RoleRule | cdktf.IResolvable): any;
export declare class RoleRuleOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
private resolvableValue?;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
* @param complexObjectIndex the index of this item in the list
* @param complexObjectIsFromSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean);
get internalValue(): RoleRule | cdktf.IResolvable | undefined;
set internalValue(value: RoleRule | cdktf.IResolvable | undefined);
private _apiGroups?;
get apiGroups(): string[];
set apiGroups(value: string[]);
get apiGroupsInput(): string[] | undefined;
private _resourceNames?;
get resourceNames(): string[];
set resourceNames(value: string[]);
resetResourceNames(): void;
get resourceNamesInput(): string[] | undefined;
private _resources?;
get resources(): string[];
set resources(value: string[]);
get resourcesInput(): string[] | undefined;
private _verbs?;
get verbs(): string[];
set verbs(value: string[]);
get verbsInput(): string[] | undefined;
}
export declare class RoleRuleList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
internalValue?: RoleRule[] | cdktf.IResolvable;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
* @param wrapsSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean);
/**
* @param index the index of the item to return
*/
get(index: number): RoleRuleOutputReference;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/resources/role kubernetes_role}
*/
export declare class Role extends cdktf.TerraformResource {
static readonly tfResourceType = "kubernetes_role";
/**
* Generates CDKTF code for importing a Role 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 Role to import
* @param importFromId The id of the existing Role that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.38.0/docs/resources/role#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the Role 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/kubernetes/2.38.0/docs/resources/role kubernetes_role} 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 RoleConfig
*/
constructor(scope: Construct, id: string, config: RoleConfig);
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _metadata;
get metadata(): RoleMetadataOutputReference;
putMetadata(value: RoleMetadata): void;
get metadataInput(): RoleMetadata | undefined;
private _rule;
get rule(): RoleRuleList;
putRule(value: RoleRule[] | cdktf.IResolvable): void;
get ruleInput(): cdktf.IResolvable | RoleRule[] | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}