AWS Native is in preview. AWS Classic is fully supported.
aws-native.location.ApiKey
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Definition of AWS::Location::APIKey Resource Type
Create ApiKey Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ApiKey(name: string, args: ApiKeyArgs, opts?: CustomResourceOptions);
@overload
def ApiKey(resource_name: str,
args: ApiKeyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ApiKey(resource_name: str,
opts: Optional[ResourceOptions] = None,
restrictions: Optional[ApiKeyRestrictionsArgs] = None,
description: Optional[str] = None,
expire_time: Optional[str] = None,
force_delete: Optional[bool] = None,
force_update: Optional[bool] = None,
key_name: Optional[str] = None,
no_expiry: Optional[bool] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewApiKey(ctx *Context, name string, args ApiKeyArgs, opts ...ResourceOption) (*ApiKey, error)
public ApiKey(string name, ApiKeyArgs args, CustomResourceOptions? opts = null)
public ApiKey(String name, ApiKeyArgs args)
public ApiKey(String name, ApiKeyArgs args, CustomResourceOptions options)
type: aws-native:location:ApiKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ApiKeyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ApiKeyArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ApiKeyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiKeyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApiKeyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const aws_nativeApiKeyResource = new aws_native.location.ApiKey("aws-nativeApiKeyResource", {
restrictions: {
allowActions: ["string"],
allowResources: ["string"],
allowReferers: ["string"],
},
description: "string",
expireTime: "string",
forceDelete: false,
forceUpdate: false,
keyName: "string",
noExpiry: false,
tags: [{
key: "string",
value: "string",
}],
});
Coming soon!
ApiKey Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ApiKey resource accepts the following input properties:
- Restrictions
Pulumi.
Aws Native. Location. Inputs. Api Key Restrictions - Description string
- Expire
Time string - Force
Delete bool - Force
Update bool - Key
Name string - No
Expiry bool - List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource.
- Restrictions
Api
Key Restrictions Args - Description string
- Expire
Time string - Force
Delete bool - Force
Update bool - Key
Name string - No
Expiry bool - Tag
Args - An array of key-value pairs to apply to this resource.
- restrictions
Api
Key Restrictions - description String
- expire
Time String - force
Delete Boolean - force
Update Boolean - key
Name String - no
Expiry Boolean - List<Tag>
- An array of key-value pairs to apply to this resource.
- restrictions
Api
Key Restrictions - description string
- expire
Time string - force
Delete boolean - force
Update boolean - key
Name string - no
Expiry boolean - Tag[]
- An array of key-value pairs to apply to this resource.
- restrictions
Api
Key Restrictions Args - description str
- expire_
time str - force_
delete bool - force_
update bool - key_
name str - no_
expiry bool - Sequence[Tag
Args] - An array of key-value pairs to apply to this resource.
- restrictions Property Map
- description String
- expire
Time String - force
Delete Boolean - force
Update Boolean - key
Name String - no
Expiry Boolean - List<Property Map>
- An array of key-value pairs to apply to this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the ApiKey resource produces the following output properties:
- Arn string
- Create
Time string - Id string
- The provider-assigned unique ID for this managed resource.
- Key
Arn string - Update
Time string
- Arn string
- Create
Time string - Id string
- The provider-assigned unique ID for this managed resource.
- Key
Arn string - Update
Time string
- arn String
- create
Time String - id String
- The provider-assigned unique ID for this managed resource.
- key
Arn String - update
Time String
- arn string
- create
Time string - id string
- The provider-assigned unique ID for this managed resource.
- key
Arn string - update
Time string
- arn str
- create_
time str - id str
- The provider-assigned unique ID for this managed resource.
- key_
arn str - update_
time str
- arn String
- create
Time String - id String
- The provider-assigned unique ID for this managed resource.
- key
Arn String - update
Time String
Supporting Types
ApiKeyRestrictions, ApiKeyRestrictionsArgs
- Allow
Actions List<string> - Allow
Resources List<string> - Allow
Referers List<string>
- Allow
Actions []string - Allow
Resources []string - Allow
Referers []string
- allow
Actions List<String> - allow
Resources List<String> - allow
Referers List<String>
- allow
Actions string[] - allow
Resources string[] - allow
Referers string[]
- allow_
actions Sequence[str] - allow_
resources Sequence[str] - allow_
referers Sequence[str]
- allow
Actions List<String> - allow
Resources List<String> - allow
Referers List<String>
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.