Class CfnAPIKey

The API key resource in your AWS account, which lets you grant actions for Amazon Location resources to the API key bearer.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnAPIKey
Inherited Members
Namespace: Amazon.CDK.AWS.Location
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAPIKey : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnAPIKey
    Inherits CfnResource
    Implements IInspectable, ITaggableV2
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html

CloudformationResource: AWS::Location::APIKey

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Location;

var cfnAPIKey = new CfnAPIKey(this, "MyCfnAPIKey", new CfnAPIKeyProps {
    KeyName = "keyName",
    Restrictions = new ApiKeyRestrictionsProperty {
        AllowActions = new [] { "allowActions" },
        AllowResources = new [] { "allowResources" },

        // the properties below are optional
        AllowReferers = new [] { "allowReferers" }
    },

    // the properties below are optional
    Description = "description",
    ExpireTime = "expireTime",
    ForceDelete = false,
    ForceUpdate = false,
    NoExpiry = false,
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

CfnAPIKey(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnAPIKey(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnAPIKey(Construct, String, ICfnAPIKeyProps)

Properties

AttrArn

The Amazon Resource Name (ARN) for the resource.
AttrCreateTime

The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
AttrKeyArn

The Amazon Resource Name (ARN) for the API key resource.
AttrUpdateTime

The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
CdkTagManager

Tag Manager which manages the tags for this resource.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
Description

Updates the description for the API key resource.
ExpireTime

The optional timestamp for when the API key resource will expire in ISO 8601 format .
ForceDelete

ForceDelete bypasses an API key's expiry conditions and deletes the key.
ForceUpdate

The boolean flag to be included for updating ExpireTime or Restrictions details.
KeyName

A custom name for the API key resource.
NoExpiry

Whether the API key should expire.
Restrictions

The API key restrictions for the API key resource.
Tags

Applies one or more tags to the map resource.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnAPIKey(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnAPIKey(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnAPIKey(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnAPIKey(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnAPIKey(Construct, String, ICfnAPIKeyProps)

public CfnAPIKey(Construct scope, string id, ICfnAPIKeyProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnAPIKeyProps

Resource properties.

Properties

AttrArn

The Amazon Resource Name (ARN) for the resource.

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

Used when you need to specify a resource across all AWS .

CloudformationAttribute: Arn

AttrCreateTime

The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

public virtual string AttrCreateTime { get; }
Property Value

System.String

Remarks

CloudformationAttribute: CreateTime

AttrKeyArn

The Amazon Resource Name (ARN) for the API key resource.

public virtual string AttrKeyArn { get; }
Property Value

System.String

Remarks

Used when you need to specify a resource across all AWS .

CloudformationAttribute: KeyArn

AttrUpdateTime

The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

public virtual string AttrUpdateTime { get; }
Property Value

System.String

Remarks

CloudformationAttribute: UpdateTime

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Description

Updates the description for the API key resource.

public virtual string Description { get; set; }
Property Value

System.String

ExpireTime

The optional timestamp for when the API key resource will expire in ISO 8601 format .

public virtual string ExpireTime { get; set; }
Property Value

System.String

ForceDelete

ForceDelete bypasses an API key's expiry conditions and deletes the key.

public virtual object ForceDelete { get; set; }
Property Value

System.Object

ForceUpdate

The boolean flag to be included for updating ExpireTime or Restrictions details.

public virtual object ForceUpdate { get; set; }
Property Value

System.Object

KeyName

A custom name for the API key resource.

public virtual string KeyName { get; set; }
Property Value

System.String

NoExpiry

Whether the API key should expire.

public virtual object NoExpiry { get; set; }
Property Value

System.Object

Restrictions

The API key restrictions for the API key resource.

public virtual object Restrictions { get; set; }
Property Value

System.Object

Tags

Applies one or more tags to the map resource.

public virtual ICfnTag[] Tags { get; set; }
Property Value

ICfnTag[]

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements