@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
228 lines (227 loc) • 10.2 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface IamRoleConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/iam_role#assume_role_policy IamRole#assume_role_policy}
*/
readonly assumeRolePolicy: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/iam_role#description IamRole#description}
*/
readonly description?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/iam_role#force_detach_policies IamRole#force_detach_policies}
*/
readonly forceDetachPolicies?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/iam_role#id IamRole#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/aws/6.25.0/docs/resources/iam_role#managed_policy_arns IamRole#managed_policy_arns}
*/
readonly managedPolicyArns?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/iam_role#max_session_duration IamRole#max_session_duration}
*/
readonly maxSessionDuration?: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/iam_role#name IamRole#name}
*/
readonly name?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/iam_role#name_prefix IamRole#name_prefix}
*/
readonly namePrefix?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/iam_role#path IamRole#path}
*/
readonly path?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/iam_role#permissions_boundary IamRole#permissions_boundary}
*/
readonly permissionsBoundary?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/iam_role#tags IamRole#tags}
*/
readonly tags?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/iam_role#tags_all IamRole#tags_all}
*/
readonly tagsAll?: {
[key: string]: string;
};
/**
* inline_policy block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/iam_role#inline_policy IamRole#inline_policy}
*/
readonly inlinePolicy?: IamRoleInlinePolicy[] | cdktf.IResolvable;
}
export interface IamRoleInlinePolicy {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/iam_role#name IamRole#name}
*/
readonly name?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/iam_role#policy IamRole#policy}
*/
readonly policy?: string;
}
export declare function iamRoleInlinePolicyToTerraform(struct?: IamRoleInlinePolicy | cdktf.IResolvable): any;
export declare function iamRoleInlinePolicyToHclTerraform(struct?: IamRoleInlinePolicy | cdktf.IResolvable): any;
export declare class IamRoleInlinePolicyOutputReference 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(): IamRoleInlinePolicy | cdktf.IResolvable | undefined;
set internalValue(value: IamRoleInlinePolicy | cdktf.IResolvable | undefined);
private _name?;
get name(): string;
set name(value: string);
resetName(): void;
get nameInput(): string | undefined;
private _policy?;
get policy(): string;
set policy(value: string);
resetPolicy(): void;
get policyInput(): string | undefined;
}
export declare class IamRoleInlinePolicyList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
internalValue?: IamRoleInlinePolicy[] | 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): IamRoleInlinePolicyOutputReference;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/iam_role aws_iam_role}
*/
export declare class IamRole extends cdktf.TerraformResource {
static readonly tfResourceType = "aws_iam_role";
/**
* Generates CDKTF code for importing a IamRole 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 IamRole to import
* @param importFromId The id of the existing IamRole that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/iam_role#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the IamRole 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/aws/6.25.0/docs/resources/iam_role aws_iam_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 IamRoleConfig
*/
constructor(scope: Construct, id: string, config: IamRoleConfig);
get arn(): string;
private _assumeRolePolicy?;
get assumeRolePolicy(): string;
set assumeRolePolicy(value: string);
get assumeRolePolicyInput(): string | undefined;
get createDate(): string;
private _description?;
get description(): string;
set description(value: string);
resetDescription(): void;
get descriptionInput(): string | undefined;
private _forceDetachPolicies?;
get forceDetachPolicies(): boolean | cdktf.IResolvable;
set forceDetachPolicies(value: boolean | cdktf.IResolvable);
resetForceDetachPolicies(): void;
get forceDetachPoliciesInput(): boolean | cdktf.IResolvable | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _managedPolicyArns?;
get managedPolicyArns(): string[];
set managedPolicyArns(value: string[]);
resetManagedPolicyArns(): void;
get managedPolicyArnsInput(): string[] | undefined;
private _maxSessionDuration?;
get maxSessionDuration(): number;
set maxSessionDuration(value: number);
resetMaxSessionDuration(): void;
get maxSessionDurationInput(): number | undefined;
private _name?;
get name(): string;
set name(value: string);
resetName(): void;
get nameInput(): string | undefined;
private _namePrefix?;
get namePrefix(): string;
set namePrefix(value: string);
resetNamePrefix(): void;
get namePrefixInput(): string | undefined;
private _path?;
get path(): string;
set path(value: string);
resetPath(): void;
get pathInput(): string | undefined;
private _permissionsBoundary?;
get permissionsBoundary(): string;
set permissionsBoundary(value: string);
resetPermissionsBoundary(): void;
get permissionsBoundaryInput(): string | undefined;
private _tags?;
get tags(): {
[key: string]: string;
};
set tags(value: {
[key: string]: string;
});
resetTags(): void;
get tagsInput(): {
[key: string]: string;
} | undefined;
private _tagsAll?;
get tagsAll(): {
[key: string]: string;
};
set tagsAll(value: {
[key: string]: string;
});
resetTagsAll(): void;
get tagsAllInput(): {
[key: string]: string;
} | undefined;
get uniqueId(): string;
private _inlinePolicy;
get inlinePolicy(): IamRoleInlinePolicyList;
putInlinePolicy(value: IamRoleInlinePolicy[] | cdktf.IResolvable): void;
resetInlinePolicy(): void;
get inlinePolicyInput(): cdktf.IResolvable | IamRoleInlinePolicy[] | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}