Skip to content

Latest commit

 

History

History
2177 lines (1389 loc) · 85.8 KB

iamRole.python.md

File metadata and controls

2177 lines (1389 loc) · 85.8 KB
Raw

iamRole Submodule

Constructs

IamRole

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role aws_iam_role}.

Initializers 

from cdktf_cdktf_provider_aws import iam_role

iamRole.IamRole(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  assume_role_policy: str,
  description: str = None,
  force_detach_policies: typing.Union[bool, IResolvable] = None,
  id: str = None,
  inline_policy: typing.Union[IResolvable, typing.List[IamRoleInlinePolicy]] = None,
  managed_policy_arns: typing.List[str] = None,
  max_session_duration: typing.Union[int, float] = None,
  name: str = None,
  name_prefix: str = None,
  path: str = None,
  permissions_boundary: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
assume_role_policy str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#assume_role_policy IamRole#assume_role_policy}.
description str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#description IamRole#description}.
force_detach_policies typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#force_detach_policies IamRole#force_detach_policies}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#id IamRole#id}.
inline_policy typing.Union[cdktf.IResolvable, typing.List[IamRoleInlinePolicy]] inline_policy block.
managed_policy_arns typing.List[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#managed_policy_arns IamRole#managed_policy_arns}.
max_session_duration typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#max_session_duration IamRole#max_session_duration}.
name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#name IamRole#name}.
name_prefix str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#name_prefix IamRole#name_prefix}.
path str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#path IamRole#path}.
permissions_boundary str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#permissions_boundary IamRole#permissions_boundary}.
tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#tags IamRole#tags}.
tags_all typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#tags_all IamRole#tags_all}.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
assume_role_policyRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#assume_role_policy IamRole#assume_role_policy}.

descriptionOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#description IamRole#description}.

force_detach_policiesOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#force_detach_policies IamRole#force_detach_policies}.

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.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.

inline_policyOptional

inline_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#inline_policy IamRole#inline_policy}

managed_policy_arnsOptional
  • Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#managed_policy_arns IamRole#managed_policy_arns}.

max_session_durationOptional
  • Type: typing.Union[int, float]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#max_session_duration IamRole#max_session_duration}.

nameOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#name IamRole#name}.

name_prefixOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#name_prefix IamRole#name_prefix}.

pathOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#path IamRole#path}.

permissions_boundaryOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#permissions_boundary IamRole#permissions_boundary}.

tagsOptional
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#tags IamRole#tags}.

tags_allOptional
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#tags_all IamRole#tags_all}.

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_inline_policy No description.
reset_description No description.
reset_force_detach_policies No description.
reset_id No description.
reset_inline_policy No description.
reset_managed_policy_arns No description.
reset_max_session_duration No description.
reset_name No description.
reset_name_prefix No description.
reset_path No description.
reset_permissions_boundary No description.
reset_tags No description.
reset_tags_all No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

move_to_id 
def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

put_inline_policy 
def put_inline_policy(
  value: typing.Union[IResolvable, typing.List[IamRoleInlinePolicy]]
) -> None
valueRequired
reset_description 
def reset_description() -> None
reset_force_detach_policies 
def reset_force_detach_policies() -> None
reset_id 
def reset_id() -> None
reset_inline_policy 
def reset_inline_policy() -> None
reset_managed_policy_arns 
def reset_managed_policy_arns() -> None
reset_max_session_duration 
def reset_max_session_duration() -> None
reset_name 
def reset_name() -> None
reset_name_prefix 
def reset_name_prefix() -> None
reset_path 
def reset_path() -> None
reset_permissions_boundary 
def reset_permissions_boundary() -> None
reset_tags 
def reset_tags() -> None
reset_tags_all 
def reset_tags_all() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a IamRole resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_aws import iam_role

iamRole.IamRole.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_aws import iam_role

iamRole.IamRole.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_aws import iam_role

iamRole.IamRole.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_aws import iam_role

iamRole.IamRole.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a IamRole resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

The construct id used in the generated config for the IamRole to import.

import_from_idRequired
  • Type: str

The id of the existing IamRole that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the IamRole to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
arn str No description.
create_date str No description.
inline_policy IamRoleInlinePolicyList No description.
unique_id str No description.
assume_role_policy_input str No description.
description_input str No description.
force_detach_policies_input typing.Union[bool, cdktf.IResolvable] No description.
id_input str No description.
inline_policy_input typing.Union[cdktf.IResolvable, typing.List[IamRoleInlinePolicy]] No description.
managed_policy_arns_input typing.List[str] No description.
max_session_duration_input typing.Union[int, float] No description.
name_input str No description.
name_prefix_input str No description.
path_input str No description.
permissions_boundary_input str No description.
tags_all_input typing.Mapping[str] No description.
tags_input typing.Mapping[str] No description.
assume_role_policy str No description.
description str No description.
force_detach_policies typing.Union[bool, cdktf.IResolvable] No description.
id str No description.
managed_policy_arns typing.List[str] No description.
max_session_duration typing.Union[int, float] No description.
name str No description.
name_prefix str No description.
path str No description.
permissions_boundary str No description.
tags typing.Mapping[str] No description.
tags_all typing.Mapping[str] No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
arnRequired 
arn: str
  • Type: str
create_dateRequired 
create_date: str
  • Type: str
inline_policyRequired 
inline_policy: IamRoleInlinePolicyList
unique_idRequired 
unique_id: str
  • Type: str
assume_role_policy_inputOptional 
assume_role_policy_input: str
  • Type: str
description_inputOptional 
description_input: str
  • Type: str
force_detach_policies_inputOptional 
force_detach_policies_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
id_inputOptional 
id_input: str
  • Type: str
inline_policy_inputOptional 
inline_policy_input: typing.Union[IResolvable, typing.List[IamRoleInlinePolicy]]
managed_policy_arns_inputOptional 
managed_policy_arns_input: typing.List[str]
  • Type: typing.List[str]
max_session_duration_inputOptional 
max_session_duration_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
name_inputOptional 
name_input: str
  • Type: str
name_prefix_inputOptional 
name_prefix_input: str
  • Type: str
path_inputOptional 
path_input: str
  • Type: str
permissions_boundary_inputOptional 
permissions_boundary_input: str
  • Type: str
tags_all_inputOptional 
tags_all_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
tags_inputOptional 
tags_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
assume_role_policyRequired 
assume_role_policy: str
  • Type: str
descriptionRequired 
description: str
  • Type: str
force_detach_policiesRequired 
force_detach_policies: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
idRequired 
id: str
  • Type: str
managed_policy_arnsRequired 
managed_policy_arns: typing.List[str]
  • Type: typing.List[str]
max_session_durationRequired 
max_session_duration: typing.Union[int, float]
  • Type: typing.Union[int, float]
nameRequired 
name: str
  • Type: str
name_prefixRequired 
name_prefix: str
  • Type: str
pathRequired 
path: str
  • Type: str
permissions_boundaryRequired 
permissions_boundary: str
  • Type: str
tagsRequired 
tags: typing.Mapping[str]
  • Type: typing.Mapping[str]
tags_allRequired 
tags_all: typing.Mapping[str]
  • Type: typing.Mapping[str]

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

IamRoleConfig

Initializer 

from cdktf_cdktf_provider_aws import iam_role

iamRole.IamRoleConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  assume_role_policy: str,
  description: str = None,
  force_detach_policies: typing.Union[bool, IResolvable] = None,
  id: str = None,
  inline_policy: typing.Union[IResolvable, typing.List[IamRoleInlinePolicy]] = None,
  managed_policy_arns: typing.List[str] = None,
  max_session_duration: typing.Union[int, float] = None,
  name: str = None,
  name_prefix: str = None,
  path: str = None,
  permissions_boundary: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
assume_role_policy str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#assume_role_policy IamRole#assume_role_policy}.
description str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#description IamRole#description}.
force_detach_policies typing.Union[bool, cdktf.IResolvable] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#force_detach_policies IamRole#force_detach_policies}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#id IamRole#id}.
inline_policy typing.Union[cdktf.IResolvable, typing.List[IamRoleInlinePolicy]] inline_policy block.
managed_policy_arns typing.List[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#managed_policy_arns IamRole#managed_policy_arns}.
max_session_duration typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#max_session_duration IamRole#max_session_duration}.
name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#name IamRole#name}.
name_prefix str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#name_prefix IamRole#name_prefix}.
path str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#path IamRole#path}.
permissions_boundary str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#permissions_boundary IamRole#permissions_boundary}.
tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#tags IamRole#tags}.
tags_all typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#tags_all IamRole#tags_all}.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
assume_role_policyRequired 
assume_role_policy: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#assume_role_policy IamRole#assume_role_policy}.

descriptionOptional 
description: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#description IamRole#description}.

force_detach_policiesOptional 
force_detach_policies: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#force_detach_policies IamRole#force_detach_policies}.

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.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.

inline_policyOptional 
inline_policy: typing.Union[IResolvable, typing.List[IamRoleInlinePolicy]]

inline_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#inline_policy IamRole#inline_policy}

managed_policy_arnsOptional 
managed_policy_arns: typing.List[str]
  • Type: typing.List[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#managed_policy_arns IamRole#managed_policy_arns}.

max_session_durationOptional 
max_session_duration: typing.Union[int, float]
  • Type: typing.Union[int, float]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#max_session_duration IamRole#max_session_duration}.

nameOptional 
name: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#name IamRole#name}.

name_prefixOptional 
name_prefix: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#name_prefix IamRole#name_prefix}.

pathOptional 
path: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#path IamRole#path}.

permissions_boundaryOptional 
permissions_boundary: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#permissions_boundary IamRole#permissions_boundary}.

tagsOptional 
tags: typing.Mapping[str]
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#tags IamRole#tags}.

tags_allOptional 
tags_all: typing.Mapping[str]
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#tags_all IamRole#tags_all}.

IamRoleInlinePolicy

Initializer 

from cdktf_cdktf_provider_aws import iam_role

iamRole.IamRoleInlinePolicy(
  name: str = None,
  policy: str = None
)

Properties

Name Type Description
name str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#name IamRole#name}.
policy str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#policy IamRole#policy}.
nameOptional 
name: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#name IamRole#name}.

policyOptional 
policy: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/resources/iam_role#policy IamRole#policy}.

Classes

IamRoleInlinePolicyList

Initializers 

from cdktf_cdktf_provider_aws import iam_role

iamRole.IamRoleInlinePolicyList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> IamRoleInlinePolicyOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
internal_value typing.Union[cdktf.IResolvable, typing.List[IamRoleInlinePolicy]] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, typing.List[IamRoleInlinePolicy]]

IamRoleInlinePolicyOutputReference

Initializers 

from cdktf_cdktf_provider_aws import iam_role

iamRole.IamRoleInlinePolicyOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

complex_object_indexRequired
  • Type: typing.Union[int, float]

the index of this item in the list.

complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_name No description.
reset_policy No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_name 
def reset_name() -> None
reset_policy 
def reset_policy() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
name_input str No description.
policy_input str No description.
name str No description.
policy str No description.
internal_value typing.Union[cdktf.IResolvable, IamRoleInlinePolicy] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
name_inputOptional 
name_input: str
  • Type: str
policy_inputOptional 
policy_input: str
  • Type: str
nameRequired 
name: str
  • Type: str
policyRequired 
policy: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, IamRoleInlinePolicy]