Package software.amazon.awscdk.services.supportauthz

Class CfnSupportPermit

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.supportauthz.CfnSupportPermit
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ISupportPermitRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:20.534Z") @Stability(Stable) public class CfnSupportPermit extends CfnResource implements IInspectable, ISupportPermitRef, ITaggableV2
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.supportauthz.*;
 Object allActions;
 Object allResourcesInRegion;
 CfnSupportPermit cfnSupportPermit = CfnSupportPermit.Builder.create(this, "MyCfnSupportPermit")
         .name("name")
         .permit(PermitProperty.builder()
                 .actions(ActionSetProperty.builder()
                         .actions(List.of("actions"))
                         .allActions(allActions)
                         .build())
                 .resources(ResourceSetProperty.builder()
                         .allResourcesInRegion(allResourcesInRegion)
                         .resources(List.of("resources"))
                         .build())
                 // the properties below are optional
                 .conditions(List.of(ConditionProperty.builder()
                         .allowAfter("allowAfter")
                         .allowBefore("allowBefore")
                         .build()))
                 .build())
         .signingKeyInfo(SigningKeyInfoProperty.builder()
                 .kmsKey("kmsKey")
                 .build())
         // the properties below are optional
         .description("description")
         .supportCaseDisplayId("supportCaseDisplayId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSupportPermit

      protected CfnSupportPermit(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSupportPermit

      protected CfnSupportPermit(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSupportPermit

      @Stability(Stable) public CfnSupportPermit(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSupportPermitProps props)
      Create a new AWS::SupportAuthZ::SupportPermit.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForSupportPermit

      @Stability(Stable) @NotNull public static String arnForSupportPermit(@NotNull ISupportPermitRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnSupportPermit

      @Stability(Stable) @NotNull public static Boolean isCfnSupportPermit(@NotNull Object x)
      Checks whether the given object is a CfnSupportPermit.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the support permit.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The time at which the support permit was created.

    • getAttrPermitId

      @Stability(Stable) @NotNull public String getAttrPermitId()
      The service-generated identifier of the support permit (the resource segment of the ARN).

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current status of the support permit.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getSupportPermitRef

      @Stability(Stable) @NotNull public SupportPermitReference getSupportPermitRef()
      A reference to a SupportPermit resource.
      Specified by:
      getSupportPermitRef in interface ISupportPermitRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the support permit.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the support permit.

    • getPermit

      @Stability(Stable) @NotNull public Object getPermit()
      The grant definition: which actions on which resources, optionally constrained by time conditions.

      Returns union: either IResolvable or CfnSupportPermit.PermitProperty

    • setPermit

      @Stability(Stable) public void setPermit(@NotNull IResolvable value)
      The grant definition: which actions on which resources, optionally constrained by time conditions.

    • setPermit

      @Stability(Stable) public void setPermit(@NotNull CfnSupportPermit.PermitProperty value)
      The grant definition: which actions on which resources, optionally constrained by time conditions.

    • getSigningKeyInfo

      @Stability(Stable) @NotNull public Object getSigningKeyInfo()
      The signing key used by the permit.

      Returns union: either IResolvable or CfnSupportPermit.SigningKeyInfoProperty

    • setSigningKeyInfo

      @Stability(Stable) public void setSigningKeyInfo(@NotNull IResolvable value)
      The signing key used by the permit.

    • setSigningKeyInfo

      @Stability(Stable) public void setSigningKeyInfo(@NotNull CfnSupportPermit.SigningKeyInfoProperty value)
      The signing key used by the permit.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      An optional description of the support permit.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      An optional description of the support permit.

    • getSupportCaseDisplayId

      @Stability(Stable) @Nullable public String getSupportCaseDisplayId()
      The support case display identifier associated with the permit.

    • setSupportCaseDisplayId

      @Stability(Stable) public void setSupportCaseDisplayId(@Nullable String value)
      The support case display identifier associated with the permit.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of key-value pairs to apply to this resource.