1. Packages
  2. AWS Native
  3. API Docs
  4. location
  5. ApiKey

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.location.ApiKey

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    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 ApiKeyRestrictionsArgs
    Description string
    ExpireTime string
    ForceDelete bool
    ForceUpdate bool
    KeyName string
    NoExpiry bool
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    restrictions ApiKeyRestrictions
    description String
    expireTime String
    forceDelete Boolean
    forceUpdate Boolean
    keyName String
    noExpiry Boolean
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    restrictions ApiKeyRestrictions
    description string
    expireTime string
    forceDelete boolean
    forceUpdate boolean
    keyName string
    noExpiry boolean
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    restrictions ApiKeyRestrictionsArgs
    description str
    expire_time str
    force_delete bool
    force_update bool
    key_name str
    no_expiry bool
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    restrictions Property Map
    description String
    expireTime String
    forceDelete Boolean
    forceUpdate Boolean
    keyName String
    noExpiry Boolean
    tags 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
    CreateTime string
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyArn string
    UpdateTime string
    Arn string
    CreateTime string
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyArn string
    UpdateTime string
    arn String
    createTime String
    id String
    The provider-assigned unique ID for this managed resource.
    keyArn String
    updateTime String
    arn string
    createTime string
    id string
    The provider-assigned unique ID for this managed resource.
    keyArn string
    updateTime 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
    createTime String
    id String
    The provider-assigned unique ID for this managed resource.
    keyArn String
    updateTime String

    Supporting Types

    ApiKeyRestrictions, ApiKeyRestrictionsArgs

    AllowActions List<string>
    AllowResources List<string>
    AllowReferers List<string>
    AllowActions []string
    AllowResources []string
    AllowReferers []string
    allowActions List<String>
    allowResources List<String>
    allowReferers List<String>
    allowActions string[]
    allowResources string[]
    allowReferers string[]
    allow_actions Sequence[str]
    allow_resources Sequence[str]
    allow_referers Sequence[str]
    allowActions List<String>
    allowResources List<String>
    allowReferers List<String>

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi