Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy aws_iam_policy}.
from cdktn_provider_aws import iam_policy
iamPolicy.IamPolicy(
scope: Construct,
id: str,
connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
count: 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[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
policy: str,
delay_after_policy_creation_in_ms: typing.Union[int, float] = None,
description: str = None,
id: str = None,
name: str = None,
name_prefix: str = None,
path: 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 |
cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection |
No description. |
count |
typing.Union[int, float] | cdktn.TerraformCount |
No description. |
depends_on |
typing.List[cdktn.ITerraformDependable] |
No description. |
for_each |
cdktn.ITerraformIterator |
No description. |
lifecycle |
cdktn.TerraformResourceLifecycle |
No description. |
provider |
cdktn.TerraformProvider |
No description. |
provisioners |
typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] |
No description. |
policy |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#policy IamPolicy#policy}. |
delay_after_policy_creation_in_ms |
typing.Union[int, float] |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#delay_after_policy_creation_in_ms IamPolicy#delay_after_policy_creation_in_ms}. |
description |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#description IamPolicy#description}. |
id |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#id IamPolicy#id}. |
name |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#name IamPolicy#name}. |
name_prefix |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#name_prefix IamPolicy#name_prefix}. |
path |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#path IamPolicy#path}. |
tags |
typing.Mapping[str] |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#tags IamPolicy#tags}. |
tags_all |
typing.Mapping[str] |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#tags_all IamPolicy#tags_all}. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: str
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
- Type: typing.Union[int, float] | cdktn.TerraformCount
- Type: typing.List[cdktn.ITerraformDependable]
- Type: cdktn.ITerraformIterator
- Type: cdktn.TerraformResourceLifecycle
- Type: cdktn.TerraformProvider
- Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#policy IamPolicy#policy}.
- Type: typing.Union[int, float]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#delay_after_policy_creation_in_ms IamPolicy#delay_after_policy_creation_in_ms}.
- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#description IamPolicy#description}.
- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#id IamPolicy#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.
- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#name IamPolicy#name}.
- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#name_prefix IamPolicy#name_prefix}.
- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#path IamPolicy#path}.
- Type: typing.Mapping[str]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#tags IamPolicy#tags}.
- Type: typing.Mapping[str]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#tags_all IamPolicy#tags_all}.
| Name | Description |
|---|---|
to_string |
Returns a string representation of this construct. |
with |
Applies one or more mixins to 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". |
reset_delay_after_policy_creation_in_ms |
No description. |
reset_description |
No description. |
reset_id |
No description. |
reset_name |
No description. |
reset_name_prefix |
No description. |
reset_path |
No description. |
reset_tags |
No description. |
reset_tags_all |
No description. |
def to_string() -> strReturns a string representation of this construct.
def with(
mixins: *IMixin
) -> IConstructApplies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
- Type: *constructs.IMixin
The mixins to apply.
def add_override(
path: str,
value: typing.Any
) -> None- Type: str
- Type: typing.Any
def override_logical_id(
new_logical_id: str
) -> NoneOverrides the auto-generated logical ID with a specific ID.
- Type: str
The new logical ID to use for this stack element.
def reset_override_logical_id() -> NoneResets a previously passed logical Id to use the auto-generated logical id again.
def to_hcl_terraform() -> typing.Anydef to_metadata() -> typing.Anydef to_terraform() -> typing.AnyAdds this resource to the terraform JSON output.
def add_move_target(
move_target: str
) -> NoneAdds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
- Type: str
The string move target that will correspond to this resource.
def get_any_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Any]- Type: str
def get_boolean_attribute(
terraform_attribute: str
) -> IResolvable- Type: str
def get_boolean_map_attribute(
terraform_attribute: str
) -> typing.Mapping[bool]- Type: str
def get_list_attribute(
terraform_attribute: str
) -> typing.List[str]- Type: str
def get_number_attribute(
terraform_attribute: str
) -> typing.Union[int, float]- Type: str
def get_number_list_attribute(
terraform_attribute: str
) -> typing.List[typing.Union[int, float]]- Type: str
def get_number_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]- Type: str
def get_string_attribute(
terraform_attribute: str
) -> str- Type: str
def get_string_map_attribute(
terraform_attribute: str
) -> typing.Mapping[str]- Type: str
def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveByIddef import_from(
id: str,
provider: TerraformProvider = None
) -> None- Type: str
- Type: cdktn.TerraformProvider
def interpolation_for_attribute(
terraform_attribute: str
) -> IResolvable- Type: str
def move_from_id(
id: str
) -> NoneMove 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.
- Type: str
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
def move_to(
move_target: str,
index: str | typing.Union[int, float] = None
) -> NoneMoves this resource to the target resource given by moveTarget.
- Type: str
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: 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.
def move_to_id(
id: str
) -> NoneMoves this resource to the resource corresponding to "id".
- Type: str
Full id of resource to move to, e.g. "aws_s3_bucket.example".
def reset_delay_after_policy_creation_in_ms() -> Nonedef reset_description() -> Nonedef reset_id() -> Nonedef reset_name() -> Nonedef reset_name_prefix() -> Nonedef reset_path() -> Nonedef reset_tags() -> Nonedef reset_tags_all() -> None| 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 CDKTN code for importing a IamPolicy resource upon running "cdktn plan ". |
from cdktn_provider_aws import iam_policy
iamPolicy.IamPolicy.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.
- Type: typing.Any
Any object.
from cdktn_provider_aws import iam_policy
iamPolicy.IamPolicy.is_terraform_element(
x: typing.Any
)- Type: typing.Any
from cdktn_provider_aws import iam_policy
iamPolicy.IamPolicy.is_terraform_resource(
x: typing.Any
)- Type: typing.Any
from cdktn_provider_aws import iam_policy
iamPolicy.IamPolicy.generate_config_for_import(
scope: Construct,
import_to_id: str,
import_from_id: str,
provider: TerraformProvider = None
)Generates CDKTN code for importing a IamPolicy resource upon running "cdktn plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: str
The construct id used in the generated config for the IamPolicy to import.
- Type: str
The id of the existing IamPolicy that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#import import section} in the documentation of this resource for the id to use
- Type: cdktn.TerraformProvider
? Optional instance of the provider where the IamPolicy to import is found.
| Name | Type | Description |
|---|---|---|
node |
constructs.Node |
The tree node. |
cdktf_stack |
cdktn.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 |
cdktn.TerraformProviderGeneratorMetadata |
No description. |
connection |
cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection |
No description. |
count |
typing.Union[int, float] | cdktn.TerraformCount |
No description. |
depends_on |
typing.List[str] |
No description. |
for_each |
cdktn.ITerraformIterator |
No description. |
lifecycle |
cdktn.TerraformResourceLifecycle |
No description. |
provider |
cdktn.TerraformProvider |
No description. |
provisioners |
typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] |
No description. |
arn |
str |
No description. |
attachment_count |
typing.Union[int, float] |
No description. |
policy_id |
str |
No description. |
delay_after_policy_creation_in_ms_input |
typing.Union[int, float] |
No description. |
description_input |
str |
No description. |
id_input |
str |
No description. |
name_input |
str |
No description. |
name_prefix_input |
str |
No description. |
path_input |
str |
No description. |
policy_input |
str |
No description. |
tags_all_input |
typing.Mapping[str] |
No description. |
tags_input |
typing.Mapping[str] |
No description. |
delay_after_policy_creation_in_ms |
typing.Union[int, float] |
No description. |
description |
str |
No description. |
id |
str |
No description. |
name |
str |
No description. |
name_prefix |
str |
No description. |
path |
str |
No description. |
policy |
str |
No description. |
tags |
typing.Mapping[str] |
No description. |
tags_all |
typing.Mapping[str] |
No description. |
node: Node- Type: constructs.Node
The tree node.
cdktf_stack: TerraformStack- Type: cdktn.TerraformStack
fqn: str- Type: str
friendly_unique_id: str- Type: str
terraform_meta_arguments: typing.Mapping[typing.Any]- Type: typing.Mapping[typing.Any]
terraform_resource_type: str- Type: str
terraform_generator_metadata: TerraformProviderGeneratorMetadata- Type: cdktn.TerraformProviderGeneratorMetadata
connection: SSHProvisionerConnection | WinrmProvisionerConnection- Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
count: typing.Union[int, float] | TerraformCount- Type: typing.Union[int, float] | cdktn.TerraformCount
depends_on: typing.List[str]- Type: typing.List[str]
for_each: ITerraformIterator- Type: cdktn.ITerraformIterator
lifecycle: TerraformResourceLifecycle- Type: cdktn.TerraformResourceLifecycle
provider: TerraformProvider- Type: cdktn.TerraformProvider
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]- Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
arn: str- Type: str
attachment_count: typing.Union[int, float]- Type: typing.Union[int, float]
policy_id: str- Type: str
delay_after_policy_creation_in_ms_input: typing.Union[int, float]- Type: typing.Union[int, float]
description_input: str- Type: str
id_input: str- Type: str
name_input: str- Type: str
name_prefix_input: str- Type: str
path_input: str- Type: str
policy_input: str- Type: str
tags_all_input: typing.Mapping[str]- Type: typing.Mapping[str]
tags_input: typing.Mapping[str]- Type: typing.Mapping[str]
delay_after_policy_creation_in_ms: typing.Union[int, float]- Type: typing.Union[int, float]
description: str- Type: str
id: str- Type: str
name: str- Type: str
name_prefix: str- Type: str
path: str- Type: str
policy: str- Type: str
tags: typing.Mapping[str]- Type: typing.Mapping[str]
tags_all: typing.Mapping[str]- Type: typing.Mapping[str]
| Name | Type | Description |
|---|---|---|
tfResourceType |
str |
No description. |
tfResourceType: str- Type: str
from cdktn_provider_aws import iam_policy
iamPolicy.IamPolicyConfig(
connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
count: 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[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
policy: str,
delay_after_policy_creation_in_ms: typing.Union[int, float] = None,
description: str = None,
id: str = None,
name: str = None,
name_prefix: str = None,
path: str = None,
tags: typing.Mapping[str] = None,
tags_all: typing.Mapping[str] = None
)| Name | Type | Description |
|---|---|---|
connection |
cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection |
No description. |
count |
typing.Union[int, float] | cdktn.TerraformCount |
No description. |
depends_on |
typing.List[cdktn.ITerraformDependable] |
No description. |
for_each |
cdktn.ITerraformIterator |
No description. |
lifecycle |
cdktn.TerraformResourceLifecycle |
No description. |
provider |
cdktn.TerraformProvider |
No description. |
provisioners |
typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] |
No description. |
policy |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#policy IamPolicy#policy}. |
delay_after_policy_creation_in_ms |
typing.Union[int, float] |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#delay_after_policy_creation_in_ms IamPolicy#delay_after_policy_creation_in_ms}. |
description |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#description IamPolicy#description}. |
id |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#id IamPolicy#id}. |
name |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#name IamPolicy#name}. |
name_prefix |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#name_prefix IamPolicy#name_prefix}. |
path |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#path IamPolicy#path}. |
tags |
typing.Mapping[str] |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#tags IamPolicy#tags}. |
tags_all |
typing.Mapping[str] |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#tags_all IamPolicy#tags_all}. |
connection: SSHProvisionerConnection | WinrmProvisionerConnection- Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
count: typing.Union[int, float] | TerraformCount- Type: typing.Union[int, float] | cdktn.TerraformCount
depends_on: typing.List[ITerraformDependable]- Type: typing.List[cdktn.ITerraformDependable]
for_each: ITerraformIterator- Type: cdktn.ITerraformIterator
lifecycle: TerraformResourceLifecycle- Type: cdktn.TerraformResourceLifecycle
provider: TerraformProvider- Type: cdktn.TerraformProvider
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]- Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
policy: str- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#policy IamPolicy#policy}.
delay_after_policy_creation_in_ms: typing.Union[int, float]- Type: typing.Union[int, float]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#delay_after_policy_creation_in_ms IamPolicy#delay_after_policy_creation_in_ms}.
description: str- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#description IamPolicy#description}.
id: str- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#id IamPolicy#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.
name: str- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#name IamPolicy#name}.
name_prefix: str- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#name_prefix IamPolicy#name_prefix}.
path: str- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#path IamPolicy#path}.
tags: typing.Mapping[str]- Type: typing.Mapping[str]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#tags IamPolicy#tags}.
tags_all: typing.Mapping[str]- Type: typing.Mapping[str]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/iam_policy#tags_all IamPolicy#tags_all}.