Package software.amazon.awscdk.services.cloudfront

Class CfnKeyGroup

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.cloudfront.CfnKeyGroup

All Implemented Interfaces:

IInspectable, IKeyGroupRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:06.524Z")
@Stability(Stable)
public class CfnKeyGroup
extends CfnResource
implements IInspectable, IKeyGroupRef

A key group.

A key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies .

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.cloudfront.*;
 CfnKeyGroup cfnKeyGroup = CfnKeyGroup.Builder.create(this, "MyCfnKeyGroup")
         .keyGroupConfig(KeyGroupConfigProperty.builder()
                 .items(List.of("items"))
                 .name("name")
                 // the properties below are optional
                 .comment("comment")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-keygroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnKeyGroup.Builder	A fluent builder for CfnKeyGroup.
static interface	CfnKeyGroup.KeyGroupConfigProperty	A key group configuration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.cloudfront.IKeyGroupRef

IKeyGroupRef.Jsii$Default, IKeyGroupRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnKeyGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnKeyGroup(software.amazon.jsii.JsiiObjectRef objRef)
	CfnKeyGroup(software.constructs.Construct scope, String id, CfnKeyGroupProps props)	Create a new AWS::CloudFront::KeyGroup.

Method Summary

Modifier and Type	Method	Description
String	getAttrId()	The identifier for the key group.
String	getAttrLastModifiedTime()	The date and time when the key group was last modified.
protected Map<String,Object>	getCfnProperties()
Object	getKeyGroupConfig()	The key group configuration.
KeyGroupReference	getKeyGroupRef()	A reference to a KeyGroup resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnKeyGroup(Object x)	Checks whether the given object is a CfnKeyGroup.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setKeyGroupConfig(IResolvable value)	The key group configuration.
void	setKeyGroupConfig(CfnKeyGroup.KeyGroupConfigProperty value)	The key group configuration.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

CfnKeyGroup

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

CfnKeyGroup

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

CfnKeyGroup

@Stability(Stable)
public CfnKeyGroup(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnKeyGroupProps props)

Create a new AWS::CloudFront::KeyGroup.

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

isCfnKeyGroup

@Stability(Stable)
@NotNull
public static Boolean isCfnKeyGroup(@NotNull
 Object x)

Checks whether the given object is a CfnKeyGroup.

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.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The identifier for the key group.

getAttrLastModifiedTime

@Stability(Stable)
@NotNull
public String getAttrLastModifiedTime()

The date and time when the key group was last modified.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getKeyGroupRef

@Stability(Stable)
@NotNull
public KeyGroupReference getKeyGroupRef()

A reference to a KeyGroup resource.

Specified by:

getKeyGroupRef in interface IKeyGroupRef

getKeyGroupConfig

@Stability(Stable)
@NotNull
public Object getKeyGroupConfig()

The key group configuration.

Returns union: either IResolvable or CfnKeyGroup.KeyGroupConfigProperty

setKeyGroupConfig

@Stability(Stable)
public void setKeyGroupConfig(@NotNull
 IResolvable value)

The key group configuration.

setKeyGroupConfig

@Stability(Stable)
public void setKeyGroupConfig(@NotNull
 CfnKeyGroup.KeyGroupConfigProperty value)

The key group configuration.