Package software.amazon.awscdk.services.supportauthz

Interface CfnSupportPermitProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSupportPermitProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:20.537Z")
@Stability(Stable)
public interface CfnSupportPermitProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSupportPermit.

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;
 CfnSupportPermitProps cfnSupportPermitProps = CfnSupportPermitProps.builder()
         .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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSupportPermitProps.Builder	A builder for CfnSupportPermitProps
static final class	CfnSupportPermitProps.Jsii$Proxy	An implementation for CfnSupportPermitProps

Method Summary

Modifier and Type	Method	Description
static CfnSupportPermitProps.Builder	builder()
default String	getDescription()	An optional description of the support permit.
String	getName()	The name of the support permit.
Object	getPermit()	The grant definition: which actions on which resources, optionally constrained by time conditions.
Object	getSigningKeyInfo()	The signing key used by the permit.
default String	getSupportCaseDisplayId()	The support case display identifier associated with the permit.
default List<CfnTag>	getTags()	A list of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the support permit.

See Also:

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

getPermit

@Stability(Stable)
@NotNull
Object getPermit()

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

Returns union: either IResolvable or CfnSupportPermit.PermitProperty

See Also:

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

getSigningKeyInfo

@Stability(Stable)
@NotNull
Object getSigningKeyInfo()

The signing key used by the permit.

Exactly one key type must be provided.

Returns union: either IResolvable or CfnSupportPermit.SigningKeyInfoProperty

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

An optional description of the support permit.

See Also:

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

getSupportCaseDisplayId

@Stability(Stable)
@Nullable
default String getSupportCaseDisplayId()

The support case display identifier associated with the permit.

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnSupportPermitProps.Builder builder()

Returns:

a CfnSupportPermitProps.Builder of CfnSupportPermitProps