aws-cdk-lib.aws_supportauthz.CfnSupportPermitProps

CfnSupportPermitProps Struct

Properties for defining a CfnSupportPermit.

CfnSupportPermitProps

used as props by

• CfnSupportPermit

Source

Generated code

Type last changed

v2.268.0 · 2 Sep 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_supportauthz as supportauthz } from 'aws-cdk-lib';

declare const allActions: any;
declare const allResourcesInRegion: any;
const cfnSupportPermitProps: supportauthz.CfnSupportPermitProps = {
  name: 'name',
  permit: {
    actions: {
      actions: ['actions'],
      allActions: allActions,
    },
    resources: {
      allResourcesInRegion: allResourcesInRegion,
      resources: ['resources'],
    },

    // the properties below are optional
    conditions: [{
      allowAfter: 'allowAfter',
      allowBefore: 'allowBefore',
    }],
  },
  signingKeyInfo: {
    kmsKey: 'kmsKey',
  },

  // the properties below are optional
  description: 'description',
  supportCaseDisplayId: 'supportCaseDisplayId',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

An optional description of the support permit.

namestringnamestrnameStringNamestringName*stringrequired#

The name of the support permit.

permitIResolvable | CfnSupportPermit.PermitPropertypermittyping.Union[IResolvable, PermitProperty]permitIResolvablePermitIResolvablePermitinterface{}required#

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

signingKeyInfoIResolvable | CfnSupportPermit.SigningKeyInfoPropertysigning_key_infotyping.Union[IResolvable, SigningKeyInfoProperty]signingKeyInfoIResolvableSigningKeyInfoIResolvableSigningKeyInfointerface{}required#

The signing key used by the permit.

Exactly one key type must be provided.

supportCaseDisplayIdstringsupport_case_display_idstrsupportCaseDisplayIdStringSupportCaseDisplayIdstringSupportCaseDisplayId*string#

The support case display identifier associated with the permit.

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

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

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