AWS CDK Reference

Appearance

v2.277.0

KeyPairCredentialsProperty Struct ​

The combination of username, private key and passphrase that are used as credentials.

Source
Generated code
Type last changed
v2.235.0 · 15 Jan 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const keyPairCredentialsProperty: quicksight.CfnDataSource.KeyPairCredentialsProperty = {
  keyPairUsername: 'keyPairUsername',
  privateKey: 'privateKey',

  // the properties below are optional
  privateKeyPassphrase: 'privateKeyPassphrase',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

key_pair_credentials_property = quicksight.CfnDataSource.KeyPairCredentialsProperty(
    key_pair_username="keyPairUsername",
    private_key="privateKey",

    # the properties below are optional
    private_key_passphrase="privateKeyPassphrase"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;

KeyPairCredentialsProperty keyPairCredentialsProperty = KeyPairCredentialsProperty.builder()
        .keyPairUsername("keyPairUsername")
        .privateKey("privateKey")

        // the properties below are optional
        .privateKeyPassphrase("privateKeyPassphrase")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var keyPairCredentialsProperty = new KeyPairCredentialsProperty {
    KeyPairUsername = "keyPairUsername",
    PrivateKey = "privateKey",

    // the properties below are optional
    PrivateKeyPassphrase = "privateKeyPassphrase"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

keyPairCredentialsProperty := &KeyPairCredentialsProperty{
	KeyPairUsername: jsii.String("keyPairUsername"),
	PrivateKey: jsii.String("privateKey"),

	// the properties below are optional
	PrivateKeyPassphrase: jsii.String("privateKeyPassphrase"),
}

Properties ​

keyPairUsernamestringkey_pair_usernamestrkeyPairUsernameStringKeyPairUsernamestringKeyPairUsername*stringrequired#
Username.
privateKeystringprivate_keystrprivateKeyStringPrivateKeystringPrivateKey*stringrequired#
PrivateKey.
privateKeyPassphraseoptionalstringprivate_key_passphraseoptionalstrprivateKeyPassphraseoptionalStringPrivateKeyPassphraseoptionalstringPrivateKeyPassphraseoptional*string#
PrivateKeyPassphrase.