Access key

New-CloudAccessKey

Synopsis

Create an access key.

Syntax

New-CloudAccessKey -AccessKeyName <String> -AuthenticationMethod <String> -CloudAccessKeyId <String> -CloudSecretAccessKey <String> -ContractId <String> -GroupID <Int32> -SecurityNetwork <String> [-AdditionalCDN <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

New-CloudAccessKey -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Creates a new access key. An access key's name needs to be unique within a user account. Once you create an access key, it's available on both the staging and production Akamai networks.

Parameters

`‑AccessKeyName` Conditionally required	StringParameter sets: `attributes`Pipeline input: False The new name for the access key. The `accessKeyName` value must be unique for each key within an account.
`‑AccountSwitchKey`	StringPipeline input: False An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.
`‑AdditionalCDN`	StringParameter sets: `attributes`Pipeline input: False Additional type of the deployment network that the access key will be deployed to. Include CHINA_CDN to make the access key available in Akamai's China CDN. Include RUSSIA_CDN to make the access key available in Akamai's Russia CDN. If you're using a Standard TLS certificate for security, RUSSIA_CDN is included by default, so you don't need to include it here. If you're using an Enhanced TLS certificate, you'll need to include both to access these CDNs.
`‑AuthenticationMethod` Conditionally required	StringAccepted values: `AWS4_HMAC_SHA256`, `GOOG4_HMAC_SHA256`Parameter sets: `attributes`Pipeline input: False The type of cloud provider signing process used to authenticate API requests. Use `AOS4_HMAC_SHA256` for Akamai Object Storage, `AWS4_HMAC_SHA256` for Amazon Web Services, `GOOG4_HMAC_SHA256` for Google Cloud Services in interoperability mode, `AVM_CLOUDINARY` for Video Manager by Cloudinary, or `VP_QUEUE_IT` for Visitor Prioritization by Queue-it.
`‑Body` Conditionally required	ObjectParameter sets: `body`Pipeline input: ByValue A request body, either as a `PSCustomObject` or a string. This parameter supports pipelining.
`‑CloudAccessKeyId` Conditionally required	StringParameter sets: `attributes`Pipeline input: False The ID that's combined with the `-CloudSecretAccessKey` to sign API requests. This is the access key ID (AWS) or access ID (GCS) you get from your cloud provider.
`‑CloudSecretAccessKey` Conditionally required	StringParameter sets: `attributes`Pipeline input: False A value that's combined with the `-CloudAccessKeyID` to sign API requests. This is the secret access key (AWS) or secret (GCS) you get from your cloud provider.
`‑ContractId` Conditionally required	StringParameter sets: `attributes`Pipeline input: False The unique identifier for the contract assigned to the access key.
`‑EdgeRCFile`	StringPipeline input: False Your EdgeGrid resource file to authenticate your command. Defaults to `~/.edgerc`.
`‑GroupID` Conditionally required	IntParameter sets: `attributes`Pipeline input: False The unique identifier assigned to the access control group assigned to the access key.
`‑Section`	StringPipeline input: False The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to `default`.
`‑SecurityNetwork` Conditionally required	StringAccepted values: `ENHANCED_TLS`, `STANDARD_TLS`Parameter sets: `attributes`Pipeline input: False The API deploys the access key to this secure network. STANDARD_TLS deploys the access key to Akamai's standard secure network. This is non-PCI compliant. ENHANCED_TLS deploys the access key to Akamai's more secure network which is PCI compliant.

Related Links

Updated about 1 month ago

Did this page help you?