CfnSupportPermitPropsMixin

class aws_cdk.cfn_property_mixins.aws_supportauthz.CfnSupportPermitPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::SupportAuthZ::SupportPermit.

Represents a support permit that grants AWS support time-bounded access to one or more resources for a set of actions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-supportauthz-supportpermit.html
CloudformationResource:: AWS::SupportAuthZ::SupportPermit
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

# all_actions: Any
# all_resources_in_region: Any
# merge_strategy: cdk.IMergeStrategy

cfn_support_permit_props_mixin = supportauthz.CfnSupportPermitPropsMixin(supportauthz.CfnSupportPermitMixinProps(
    description="description",
    name="name",
    permit=supportauthz.CfnSupportPermitPropsMixin.PermitProperty(
        actions=supportauthz.CfnSupportPermitPropsMixin.ActionSetProperty(
            actions=["actions"],
            all_actions=all_actions
        ),
        conditions=[supportauthz.CfnSupportPermitPropsMixin.ConditionProperty(
            allow_after="allowAfter",
            allow_before="allowBefore"
        )],
        resources=supportauthz.CfnSupportPermitPropsMixin.ResourceSetProperty(
            all_resources_in_region=all_resources_in_region,
            resources=["resources"]
        )
    ),
    signing_key_info=supportauthz.CfnSupportPermitPropsMixin.SigningKeyInfoProperty(
        kms_key="kmsKey"
    ),
    support_case_display_id="supportCaseDisplayId",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::SupportAuthZ::SupportPermit.

Parameters:

props (Union[CfnSupportPermitMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'name', 'permit', 'signingKeyInfo', 'supportCaseDisplayId', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

ActionSetProperty

class CfnSupportPermitPropsMixin.ActionSetProperty(*, actions=None, all_actions=None)

Bases: object

The set of actions a support permit grants.

Exactly one of AllActions or Actions must be provided.

Parameters:

actions (Optional[Sequence[str]]) – An explicit list of actions to grant.
all_actions (Any) – Grants all actions.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

# all_actions: Any

action_set_property = supportauthz.CfnSupportPermitPropsMixin.ActionSetProperty(
    actions=["actions"],
    all_actions=all_actions
)

Attributes

actions

An explicit list of actions to grant.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-supportauthz-supportpermit-actionset.html#cfn-supportauthz-supportpermit-actionset-actions

all_actions

Grants all actions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-supportauthz-supportpermit-actionset.html#cfn-supportauthz-supportpermit-actionset-allactions

ConditionProperty

class CfnSupportPermitPropsMixin.ConditionProperty(*, allow_after=None, allow_before=None)

Bases: object

A time-bound condition controlling when the permit is active.

Exactly one of AllowAfter or AllowBefore must be provided.

Parameters:

allow_after (Optional[str]) – The permit is active only after this time.
allow_before (Optional[str]) – The permit is active only before this time.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

condition_property = supportauthz.CfnSupportPermitPropsMixin.ConditionProperty(
    allow_after="allowAfter",
    allow_before="allowBefore"
)

Attributes

allow_after

The permit is active only after this time.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-supportauthz-supportpermit-condition.html#cfn-supportauthz-supportpermit-condition-allowafter

allow_before

The permit is active only before this time.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-supportauthz-supportpermit-condition.html#cfn-supportauthz-supportpermit-condition-allowbefore

PermitProperty

class CfnSupportPermitPropsMixin.PermitProperty(*, actions=None, conditions=None, resources=None)

Bases: object

The grant definition: which actions on which resources, optionally constrained by time conditions.

Parameters:

actions (Union[IResolvable, ActionSetProperty, Dict[str, Any], None]) – The set of actions a support permit grants. Exactly one of AllActions or Actions must be provided.
conditions (Union[IResolvable, Sequence[Union[IResolvable, ConditionProperty, Dict[str, Any]]], None]) – Optional time-bound conditions (at most two).
resources (Union[IResolvable, ResourceSetProperty, Dict[str, Any], None]) – The set of resources a support permit applies to. Exactly one of AllResourcesInRegion or Resources must be provided.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

# all_actions: Any
# all_resources_in_region: Any

permit_property = supportauthz.CfnSupportPermitPropsMixin.PermitProperty(
    actions=supportauthz.CfnSupportPermitPropsMixin.ActionSetProperty(
        actions=["actions"],
        all_actions=all_actions
    ),
    conditions=[supportauthz.CfnSupportPermitPropsMixin.ConditionProperty(
        allow_after="allowAfter",
        allow_before="allowBefore"
    )],
    resources=supportauthz.CfnSupportPermitPropsMixin.ResourceSetProperty(
        all_resources_in_region=all_resources_in_region,
        resources=["resources"]
    )
)

Attributes

actions

The set of actions a support permit grants.

Exactly one of AllActions or Actions must be provided.

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

conditions

Optional time-bound conditions (at most two).

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

resources

The set of resources a support permit applies to.

Exactly one of AllResourcesInRegion or Resources must be provided.

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

ResourceSetProperty

class CfnSupportPermitPropsMixin.ResourceSetProperty(*, all_resources_in_region=None, resources=None)

Bases: object

The set of resources a support permit applies to.

Exactly one of AllResourcesInRegion or Resources must be provided.

Parameters:

all_resources_in_region (Any) – Applies to all resources in the region.
resources (Optional[Sequence[str]]) – An explicit list of resource ARNs.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

# all_resources_in_region: Any

resource_set_property = supportauthz.CfnSupportPermitPropsMixin.ResourceSetProperty(
    all_resources_in_region=all_resources_in_region,
    resources=["resources"]
)

Attributes

all_resources_in_region

Applies to all resources in the region.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-supportauthz-supportpermit-resourceset.html#cfn-supportauthz-supportpermit-resourceset-allresourcesinregion

resources

An explicit list of resource ARNs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-supportauthz-supportpermit-resourceset.html#cfn-supportauthz-supportpermit-resourceset-resources

SigningKeyInfoProperty

class CfnSupportPermitPropsMixin.SigningKeyInfoProperty(*, kms_key=None)

Bases: object

The signing key used by the permit.

Exactly one key type must be provided.

Parameters:: kms_key (Optional[str]) – The ARN of the KMS key used to sign permit grants.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-supportauthz-supportpermit-signingkeyinfo.html
ExampleMetadata:: fixture=_generated

Example:

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

signing_key_info_property = supportauthz.CfnSupportPermitPropsMixin.SigningKeyInfoProperty(
    kms_key="kmsKey"
)

Attributes

kms_key

The ARN of the KMS key used to sign permit grants.

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