ApiKeyState class
Input properties used for looking up and filtering ApiKey resources.
Constructors
-
ApiKeyState({Input<
String?> ? apiKey, Input<String?> ? region, Input<String?> ? scope, Input<List< ? tokenDomains})String> ?> -
Creates a new ApiKeyState.
apiKeyThe generated API key. This value is sensitive.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.scopeSpecifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values areCLOUDFRONTorREGIONAL. Changing this forces a new resource to be created. NOTE: WAFv2 API Keys deployed forCLOUDFRONTmust be created within theus-east-1region.tokenDomainsThe domains that you want to be able to use the API key with, for exampleexample.com. You can specify up to 5 domains. Changing this forces a new resource to be created.const -
ApiKeyState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
apiKey
→ Input<
String?> ? -
The generated API key. This value is sensitive.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scope
→ Input<
String?> ? -
Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are
CLOUDFRONTorREGIONAL. Changing this forces a new resource to be created. NOTE: WAFv2 API Keys deployed forCLOUDFRONTmust be created within theus-east-1region.final -
tokenDomains
→ Input<
List< ?String> ?> -
The domains that you want to be able to use the API key with, for example
example.com. You can specify up to 5 domains. Changing this forces a new resource to be created.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited