KeyContextQuery

class aws_cdk.cloud_assembly_schema.KeyContextQuery(*, account, region, assume_role_additional_options=None, lookup_role_arn=None, lookup_role_external_id=None, alias_name)

Bases: ContextLookupRoleOptions

Query input for looking up a KMS Key.

Parameters:

  • account (str) – Query account.

  • region (str) – Query region.

  • assume_role_additional_options (Optional[Mapping[str, Any]]) – Additional options to pass to STS when assuming the lookup role. - RoleArn should not be used. Use the dedicated lookupRoleArn property instead. - ExternalId should not be used. Use the dedicated lookupRoleExternalId instead. Default: - No additional options.

  • lookup_role_arn (Optional[str]) – The ARN of the role that should be used to look up the missing values. Default: - None

  • lookup_role_external_id (Optional[str]) – The ExternalId that needs to be supplied while assuming this role. Default: - No ExternalId will be supplied

  • alias_name (str) – Alias name used to search the Key.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.cloud_assembly_schema as cloud_assembly_schema

# assume_role_additional_options: Any

key_context_query = cloud_assembly_schema.KeyContextQuery(
    account="account",
    alias_name="aliasName",
    region="region",

    # the properties below are optional
    assume_role_additional_options={
        "assume_role_additional_options_key": assume_role_additional_options
    },
    lookup_role_arn="lookupRoleArn",
    lookup_role_external_id="lookupRoleExternalId"
)

Attributes

account

Query account.

alias_name

Alias name used to search the Key.

assume_role_additional_options

Additional options to pass to STS when assuming the lookup role.

  • RoleArn should not be used. Use the dedicated lookupRoleArn property instead.

  • ExternalId should not be used. Use the dedicated lookupRoleExternalId instead.

Default:

  • No additional options.

See:

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/STS.html#assumeRole-property

lookup_role_arn

The ARN of the role that should be used to look up the missing values.

Default:

  • None

lookup_role_external_id

The ExternalId that needs to be supplied while assuming this role.

Default:

  • No ExternalId will be supplied

region

Query region.