create_key_group¶
Operation¶
create_key_group
async
¶
create_key_group(request: CreateKeyGroupInput | CreateKeyGroupInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateKeyGroupOutput
create_key_group(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateKeyGroupInputDict]) -> 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 |
|---|---|---|---|
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 |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
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.
Dictionaries¶
CreateKeyGroupInputDict
¶
Bases: TypedDict
Dictionary form of CreateKeyGroupInput.
Attributes¶
key_group_config
instance-attribute
¶
key_group_config: Required[KeyGroupConfig | KeyGroupConfigDict]
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.
response_metadata
class-attribute
instance-attribute
¶
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.