AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Payment Cryptography Control Plane CreateKey API operation.

Syntax

New-PAYCCKey
-Exportable <Boolean>
-KeyModesOfUse_Decrypt <Boolean>
-KeyModesOfUse_DeriveKey <Boolean>
-Enabled <Boolean>
-KeyModesOfUse_Encrypt <Boolean>
-KeyModesOfUse_Generate <Boolean>
-KeyAttributes_KeyAlgorithm <KeyAlgorithm>
-KeyCheckValueAlgorithm <KeyCheckValueAlgorithm>
-KeyAttributes_KeyClass <KeyClass>
-KeyAttributes_KeyUsage <KeyUsage>
-KeyModesOfUse_NoRestriction <Boolean>
-KeyModesOfUse_Sign <Boolean>
-Tag <Tag[]>
-KeyModesOfUse_Unwrap <Boolean>
-KeyModesOfUse_Verify <Boolean>
-KeyModesOfUse_Wrap <Boolean>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonPaymentCryptographyConfig>

Description

Creates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region. You use keys for cryptographic functions such as encryption and decryption. In addition to the key material used in cryptographic operations, an Amazon Web Services Payment Cryptography key includes metadata such as the key ARN, key usage, key origin, creation date, description, and key state. When you create a key, you specify both immutable and mutable data about the key. The immutable data contains key attributes that define the scope and cryptographic operations that you can perform using the key, for example key class (example: SYMMETRIC_KEY), key algorithm (example: TDES_2KEY), key usage (example: TR31_P0_PIN_ENCRYPTION_KEY) and key modes of use (example: Encrypt). For information about valid combinations of key attributes, see Understanding key attributes in the Amazon Web Services Payment Cryptography User Guide. The mutable data contained within a key includes usage timestamp and key deletion timestamp and can be modified after creation. Amazon Web Services Payment Cryptography binds key attributes to keys using key blocks when you store or export them. Amazon Web Services Payment Cryptography stores the key contents wrapped and never stores or transmits them in the clear. Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations:

Parameters

-ClientConfig <AmazonPaymentCryptographyConfig>
Amazon.PowerShell.Cmdlets.PAYCC.AmazonPaymentCryptographyClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Enabled <Boolean>
Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key is not enabled, then it is created but not activated. The default value is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Exportable <Boolean>
Specifies whether the key is exportable from the service.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KeyAttributes_KeyAlgorithm <KeyAlgorithm>
The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-KeyAttributes_KeyClass <KeyClass>
The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-KeyAttributes_KeyUsage <KeyUsage>
The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-KeyCheckValueAlgorithm <KeyCheckValueAlgorithm>
The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KeyModesOfUse_Decrypt <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyAttributes_KeyModesOfUse_Decrypt
-KeyModesOfUse_DeriveKey <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyAttributes_KeyModesOfUse_DeriveKey
-KeyModesOfUse_Encrypt <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyAttributes_KeyModesOfUse_Encrypt
-KeyModesOfUse_Generate <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyAttributes_KeyModesOfUse_Generate
-KeyModesOfUse_NoRestriction <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyAttributes_KeyModesOfUse_NoRestrictions
-KeyModesOfUse_Sign <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyAttributes_KeyModesOfUse_Sign
-KeyModesOfUse_Unwrap <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyAttributes_KeyModesOfUse_Unwrap
-KeyModesOfUse_Verify <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyAttributes_KeyModesOfUse_Verify
-KeyModesOfUse_Wrap <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyAttributes_KeyModesOfUse_Wrap
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Exportable parameter. The -PassThru parameter is deprecated, use -Select '^Exportable' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Key'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PaymentCryptography.Model.CreateKeyResponse). Specifying the name of a property of type Amazon.PaymentCryptography.Model.CreateKeyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.PaymentCryptography.Model.Key or Amazon.PaymentCryptography.Model.CreateKeyResponse
This cmdlet returns an Amazon.PaymentCryptography.Model.Key object. The service call response (type Amazon.PaymentCryptography.Model.CreateKeyResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z