/AWS1/CL_BDOCREAPIKEYCREDPVD01¶
CreateApiKeyCredentialProviderResponse
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
io_apikeysecretarn TYPE REF TO /AWS1/CL_BDOSECRET /AWS1/CL_BDOSECRET¶
The Amazon Resource Name (ARN) of the secret containing the API key.
iv_name TYPE /AWS1/BDOCREDPROVIDERNAME /AWS1/BDOCREDPROVIDERNAME¶
The name of the created API key credential provider.
iv_credentialproviderarn TYPE /AWS1/BDOAPIKEYCREDPVDRARNTYPE /AWS1/BDOAPIKEYCREDPVDRARNTYPE¶
The Amazon Resource Name (ARN) of the created API key credential provider.
Optional arguments:¶
iv_apikeysecretjsonkey TYPE /AWS1/BDOSECRETJSONKEYTYPE /AWS1/BDOSECRETJSONKEYTYPE¶
The JSON key used to extract the API key value from the AWS Secrets Manager secret.
iv_apikeysecretsource TYPE /AWS1/BDOSECRETSOURCETYPE /AWS1/BDOSECRETSOURCETYPE¶
The source type of the API key secret. Either
MANAGEDif the secret is managed by the service, orEXTERNALif managed by the user in AWS Secrets Manager.
Queryable Attributes¶
apiKeySecretArn¶
The Amazon Resource Name (ARN) of the secret containing the API key.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APIKEYSECRETARN() |
Getter for APIKEYSECRETARN |
apiKeySecretJsonKey¶
The JSON key used to extract the API key value from the AWS Secrets Manager secret.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APIKEYSECRETJSONKEY() |
Getter for APIKEYSECRETJSONKEY, with configurable default |
ASK_APIKEYSECRETJSONKEY() |
Getter for APIKEYSECRETJSONKEY w/ exceptions if field has no |
HAS_APIKEYSECRETJSONKEY() |
Determine if APIKEYSECRETJSONKEY has a value |
apiKeySecretSource¶
The source type of the API key secret. Either
MANAGEDif the secret is managed by the service, orEXTERNALif managed by the user in AWS Secrets Manager.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APIKEYSECRETSOURCE() |
Getter for APIKEYSECRETSOURCE, with configurable default |
ASK_APIKEYSECRETSOURCE() |
Getter for APIKEYSECRETSOURCE w/ exceptions if field has no |
HAS_APIKEYSECRETSOURCE() |
Determine if APIKEYSECRETSOURCE has a value |
name¶
The name of the created API key credential provider.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
credentialProviderArn¶
The Amazon Resource Name (ARN) of the created API key credential provider.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREDENTIALPROVIDERARN() |
Getter for CREDENTIALPROVIDERARN, with configurable default |
ASK_CREDENTIALPROVIDERARN() |
Getter for CREDENTIALPROVIDERARN w/ exceptions if field has |
HAS_CREDENTIALPROVIDERARN() |
Determine if CREDENTIALPROVIDERARN has a value |