Skip to content

CloudFront  >  Operations  >  create_key_group

create_key_group

Operation

create_key_group async 

create_key_group(input: CreateKeyGroupInput, plugins: list[Plugin] | None = None) -> CreateKeyGroupOutput

Creates a key group that you can use with CloudFront signed URLs and signed cookies.

To create a key group, you must specify at least one public key for the key group. After you create a key group, you can reference it from one or more cache behaviors. When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

Parameters:

Name Type Description Default
input CreateKeyGroupInput

An instance of CreateKeyGroupInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
CreateKeyGroupOutput

An instance of CreateKeyGroupOutput.

Input

CreateKeyGroupInput dataclass

Bases: _SerdeShape

Dataclass for CreateKeyGroupInput structure.

Attributes

key_group_config class-attribute instance-attribute 
key_group_config: KeyGroupConfig | None = ...

A key group configuration.

Output

CreateKeyGroupOutput dataclass

Bases: _SerdeShape

Dataclass for CreateKeyGroupOutput structure.

Attributes

e_tag class-attribute instance-attribute 
e_tag: str | None = ...

The identifier for this version of the key group.

key_group class-attribute instance-attribute 
key_group: KeyGroup | None = ...

The key group that was just created.

location class-attribute instance-attribute 
location: str | None = ...

The URL of the key group.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.