Class Request<TProperties>

The Request<TProperties> is a generic class that wraps the TProperties request with additional properties sent by the AWS CloudFormation service.

Inheritance

System.Object

Request<TProperties>

Namespace: LambdaSharp.CustomResource

Assembly: LambdaSharp.CustomResource.dll

Syntax

public class Request<TProperties>
    where TProperties : class

Type Parameters

Name	Description
TProperties	The request properties for the custom resource.

Properties

LogicalResourceId

The template developer-chosen name (logical ID) of the custom resource in the AWS CloudFormation template. This is provided to facilitate communication between the custom resource provider and the template developer.

Declaration

public string LogicalResourceId { get; set; }

Property Value

Type	Description
System.String

OldResourceProperties

Used only for Update requests. Contains the resource properties that were declared previous to the update request.

Declaration

public TProperties OldResourceProperties { get; set; }

Property Value

Type	Description
TProperties

PhysicalResourceId

A required custom resource provider-defined physical ID that is unique for that provider.

Declaration

public string PhysicalResourceId { get; set; }

Property Value

Type	Description
System.String

RequestType

The request type is set by the AWS CloudFormation stack operation (create-stack, update-stack, or delete-stack) that was initiated by the template developer for the stack that contains the custom resource.

Declaration

public RequestType RequestType { get; set; }

Property Value

Type	Description
RequestType

ResourceProperties

This field contains the contents of the Properties object sent by the template developer. Its contents are defined by the custom resource provider.

Declaration

public TProperties ResourceProperties { get; set; }

Property Value

Type	Description
TProperties

ResourceType

The template developer-chosen resource type of the custom resource in the AWS CloudFormation template. Custom resource type names can be up to 60 characters long and can include alphanumeric and the following characters: _@-.

Declaration

public string ResourceType { get; set; }

Property Value

Type	Description
System.String

StackId

The Amazon Resource Name (ARN) that identifies the stack that contains the custom resource.

Combining the StackId with the RequestId forms a value that you can use to uniquely identify a request on a particular custom resource.

Declaration

public string StackId { get; set; }

Property Value

Type	Description
System.String

Methods

HasPhysicalResourceId()

Check if the custom resource has a physical ID.

Declaration

public bool HasPhysicalResourceId()

Returns

Type	Description
System.Boolean