CfnSupportPermitProps

class aws_cdk.aws_supportauthz.CfnSupportPermitProps(*, name, permit, signing_key_info, description=None, support_case_display_id=None, tags=None)

Bases: object

Properties for defining a CfnSupportPermit.

Parameters:
  • name (str) – The name of the support permit.

  • permit (Union[IResolvable, PermitProperty, Dict[str, Any]]) – The grant definition: which actions on which resources, optionally constrained by time conditions.

  • signing_key_info (Union[IResolvable, SigningKeyInfoProperty, Dict[str, Any]]) – The signing key used by the permit. Exactly one key type must be provided.

  • description (Optional[str]) – An optional description of the support permit.

  • support_case_display_id (Optional[str]) – The support case display identifier associated with the permit. When provided, the permit is linked to the specified AWS Support case.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of key-value pairs to apply to this resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportauthz-supportpermit.html

ExampleMetadata:

fixture=_generated

Example:

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

# all_actions: Any
# all_resources_in_region: Any

cfn_support_permit_props = supportauthz.CfnSupportPermitProps(
    name="name",
    permit=supportauthz.CfnSupportPermit.PermitProperty(
        actions=supportauthz.CfnSupportPermit.ActionSetProperty(
            actions=["actions"],
            all_actions=all_actions
        ),
        resources=supportauthz.CfnSupportPermit.ResourceSetProperty(
            all_resources_in_region=all_resources_in_region,
            resources=["resources"]
        ),

        # the properties below are optional
        conditions=[supportauthz.CfnSupportPermit.ConditionProperty(
            allow_after="allowAfter",
            allow_before="allowBefore"
        )]
    ),
    signing_key_info=supportauthz.CfnSupportPermit.SigningKeyInfoProperty(
        kms_key="kmsKey"
    ),

    # the properties below are optional
    description="description",
    support_case_display_id="supportCaseDisplayId",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

An optional description of the support permit.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportauthz-supportpermit.html#cfn-supportauthz-supportpermit-description

name

The name of the support permit.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportauthz-supportpermit.html#cfn-supportauthz-supportpermit-name

permit

which actions on which resources, optionally constrained by time conditions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportauthz-supportpermit.html#cfn-supportauthz-supportpermit-permit

Type:

The grant definition

signing_key_info

The signing key used by the permit.

Exactly one key type must be provided.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportauthz-supportpermit.html#cfn-supportauthz-supportpermit-signingkeyinfo

support_case_display_id

The support case display identifier associated with the permit.

When provided, the permit is linked to the specified AWS Support case.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportauthz-supportpermit.html#cfn-supportauthz-supportpermit-supportcasedisplayid

tags

A list of key-value pairs to apply to this resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportauthz-supportpermit.html#cfn-supportauthz-supportpermit-tags