Class ApiGatewayEnrichment

(experimental) An API Gateway enrichment for a pipe.

Inheritance
System.Object
ApiGatewayEnrichment
Implements
Namespace: Amazon.CDK.AWS.Pipes.Enrichments.Alpha
Assembly: Amazon.CDK.AWS.Pipes.Enrichments.Alpha.dll
Syntax (csharp)
public class ApiGatewayEnrichment : DeputyBase, IEnrichment
Syntax (vb)
Public Class ApiGatewayEnrichment
    Inherits DeputyBase
    Implements IEnrichment
Remarks

Stability: Experimental

ExampleMetadata: infused

Examples
Queue sourceQueue;
Queue targetQueue;

RestApi restApi;


var enrichment = new ApiGatewayEnrichment(restApi);

var pipe = new Pipe(this, "Pipe", new PipeProps {
    Source = new SomeSource(sourceQueue),
    Enrichment = enrichment,
    Target = new SomeTarget(targetQueue)
});

Synopsis

Constructors

ApiGatewayEnrichment(IRestApi, IApiGatewayEnrichmentProps)
ApiGatewayEnrichment(ByRefValue)

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

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

Properties

EnrichmentArn

(experimental) The ARN of the enrichment resource.

Methods

Bind(IPipe)

(experimental) Bind this enrichment to a pipe.
GrantInvoke(IRole)

(experimental) Grant the pipes role to invoke the enrichment.

Constructors

ApiGatewayEnrichment(IRestApi, IApiGatewayEnrichmentProps)

public ApiGatewayEnrichment(IRestApi restApi, IApiGatewayEnrichmentProps props = null)
Parameters
restApi IRestApi
props IApiGatewayEnrichmentProps
Remarks

Stability: Experimental

ApiGatewayEnrichment(ByRefValue)

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

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

The Javascript-owned object reference

ApiGatewayEnrichment(DeputyBase.DeputyProps)

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

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

The deputy props

Properties

EnrichmentArn

(experimental) The ARN of the enrichment resource.

public virtual string EnrichmentArn { get; }
Property Value

System.String

Remarks

Length Constraints: Minimum length of 0. Maximum length of 1600.

Stability: Experimental

Methods

Bind(IPipe)

(experimental) Bind this enrichment to a pipe.

public virtual IEnrichmentParametersConfig Bind(IPipe pipe)
Parameters
pipe IPipe
Returns

IEnrichmentParametersConfig

Remarks

Stability: Experimental

GrantInvoke(IRole)

(experimental) Grant the pipes role to invoke the enrichment.

public virtual void GrantInvoke(IRole pipeRole)
Parameters
pipeRole IRole
Remarks

Stability: Experimental

Implements