Modifier and Type | Method and Description |
---|---|
CfnApiKey |
build() |
static CfnApiKey.Builder |
create(Construct scope,
java.lang.String id) |
CfnApiKey.Builder |
customerId(java.lang.String customerId)
An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
|
CfnApiKey.Builder |
description(java.lang.String description)
A description of the purpose of the API key.
|
CfnApiKey.Builder |
enabled(java.lang.Boolean enabled)
Indicates whether the API key can be used by clients.
|
CfnApiKey.Builder |
enabled(IResolvable enabled)
Indicates whether the API key can be used by clients.
|
CfnApiKey.Builder |
generateDistinctId(java.lang.Boolean generateDistinctId)
Specifies whether the key identifier is distinct from the created API key value.
|
CfnApiKey.Builder |
generateDistinctId(IResolvable generateDistinctId)
Specifies whether the key identifier is distinct from the created API key value.
|
CfnApiKey.Builder |
name(java.lang.String name)
A name for the API key.
|
CfnApiKey.Builder |
stageKeys(IResolvable stageKeys)
A list of stages to associate with this API key.
|
CfnApiKey.Builder |
stageKeys(java.util.List<? extends java.lang.Object> stageKeys)
A list of stages to associate with this API key.
|
CfnApiKey.Builder |
tags(java.util.List<? extends CfnTag> tags)
An array of arbitrary tags (key-value pairs) to associate with the API key.
|
CfnApiKey.Builder |
value(java.lang.String value)
The value of the API key.
|
public static CfnApiKey.Builder create(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.CfnApiKey.StageKeyProperty.Builder
.public CfnApiKey.Builder customerId(java.lang.String customerId)
customerId
- An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace. This parameter is required.this
public CfnApiKey.Builder description(java.lang.String description)
description
- A description of the purpose of the API key. This parameter is required.this
public CfnApiKey.Builder enabled(java.lang.Boolean enabled)
enabled
- Indicates whether the API key can be used by clients. This parameter is required.this
public CfnApiKey.Builder enabled(IResolvable enabled)
enabled
- Indicates whether the API key can be used by clients. This parameter is required.this
public CfnApiKey.Builder generateDistinctId(java.lang.Boolean generateDistinctId)
This parameter is deprecated and should not be used.
generateDistinctId
- Specifies whether the key identifier is distinct from the created API key value. This parameter is required.this
public CfnApiKey.Builder generateDistinctId(IResolvable generateDistinctId)
This parameter is deprecated and should not be used.
generateDistinctId
- Specifies whether the key identifier is distinct from the created API key value. This parameter is required.this
public CfnApiKey.Builder name(java.lang.String name)
If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name. For more information, see Name Type .
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
name
- A name for the API key. This parameter is required.this
public CfnApiKey.Builder stageKeys(IResolvable stageKeys)
stageKeys
- A list of stages to associate with this API key. This parameter is required.this
public CfnApiKey.Builder stageKeys(java.util.List<? extends java.lang.Object> stageKeys)
stageKeys
- A list of stages to associate with this API key. This parameter is required.this
public CfnApiKey.Builder tags(java.util.List<? extends CfnTag> tags)
tags
- An array of arbitrary tags (key-value pairs) to associate with the API key. This parameter is required.this
public CfnApiKey.Builder value(java.lang.String value)
Must be at least 20 characters long.
value
- The value of the API key. This parameter is required.this
public CfnApiKey build()