software.amazon.awscdk.services.apigateway

Class CfnAuthorizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.apigateway.CfnAuthorizer

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:54:56.819Z")
 @Stability(value=Stable)
public class CfnAuthorizer
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGateway::Authorizer`.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnAuthorizer.Builder A fluent builder for CfnAuthorizer.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAuthorizer(software.constructs.Construct scope, String id, CfnAuthorizerProps props) Create a new `AWS::ApiGateway::Authorizer`.
protected	CfnAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAuthorizerCredentials() `AWS::ApiGateway::Authorizer.AuthorizerCredentials`.
Number	getAuthorizerResultTtlInSeconds() `AWS::ApiGateway::Authorizer.AuthorizerResultTtlInSeconds`.
String	getAuthorizerUri() `AWS::ApiGateway::Authorizer.AuthorizerUri`.
String	getAuthType() `AWS::ApiGateway::Authorizer.AuthType`.
protected Map<String,Object>	getCfnProperties()
String	getIdentitySource() `AWS::ApiGateway::Authorizer.IdentitySource`.
String	getIdentityValidationExpression() `AWS::ApiGateway::Authorizer.IdentityValidationExpression`.
String	getName() `AWS::ApiGateway::Authorizer.Name`.
List<String>	getProviderArns() `AWS::ApiGateway::Authorizer.ProviderARNs`.
String	getRestApiId() `AWS::ApiGateway::Authorizer.RestApiId`.
String	getType() `AWS::ApiGateway::Authorizer.Type`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAuthorizerCredentials(String value) `AWS::ApiGateway::Authorizer.AuthorizerCredentials`.
void	setAuthorizerResultTtlInSeconds(Number value) `AWS::ApiGateway::Authorizer.AuthorizerResultTtlInSeconds`.
void	setAuthorizerUri(String value) `AWS::ApiGateway::Authorizer.AuthorizerUri`.
void	setAuthType(String value) `AWS::ApiGateway::Authorizer.AuthType`.
void	setIdentitySource(String value) `AWS::ApiGateway::Authorizer.IdentitySource`.
void	setIdentityValidationExpression(String value) `AWS::ApiGateway::Authorizer.IdentityValidationExpression`.
void	setName(String value) `AWS::ApiGateway::Authorizer.Name`.
void	setProviderArns(List<String> value) `AWS::ApiGateway::Authorizer.ProviderARNs`.
void	setRestApiId(String value) `AWS::ApiGateway::Authorizer.RestApiId`.
void	setType(String value) `AWS::ApiGateway::Authorizer.Type`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAuthorizer

protected CfnAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)

CfnAuthorizer

protected CfnAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAuthorizer

@Stability(value=Stable)
public CfnAuthorizer(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              CfnAuthorizerProps props)

Create a new `AWS::ApiGateway::Authorizer`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getRestApiId

@Stability(value=Stable)
 @NotNull
public String getRestApiId()

`AWS::ApiGateway::Authorizer.RestApiId`.

setRestApiId

@Stability(value=Stable)
public void setRestApiId(@NotNull
                                                  String value)

`AWS::ApiGateway::Authorizer.RestApiId`.

getType

@Stability(value=Stable)
 @NotNull
public String getType()

`AWS::ApiGateway::Authorizer.Type`.

setType

@Stability(value=Stable)
public void setType(@NotNull
                                             String value)

`AWS::ApiGateway::Authorizer.Type`.

getAuthorizerCredentials

@Stability(value=Stable)
 @Nullable
public String getAuthorizerCredentials()

`AWS::ApiGateway::Authorizer.AuthorizerCredentials`.

setAuthorizerCredentials

@Stability(value=Stable)
public void setAuthorizerCredentials(@Nullable
                                                              String value)

`AWS::ApiGateway::Authorizer.AuthorizerCredentials`.

getAuthorizerResultTtlInSeconds

@Stability(value=Stable)
 @Nullable
public Number getAuthorizerResultTtlInSeconds()

`AWS::ApiGateway::Authorizer.AuthorizerResultTtlInSeconds`.

setAuthorizerResultTtlInSeconds

@Stability(value=Stable)
public void setAuthorizerResultTtlInSeconds(@Nullable
                                                                     Number value)

`AWS::ApiGateway::Authorizer.AuthorizerResultTtlInSeconds`.

getAuthorizerUri

@Stability(value=Stable)
 @Nullable
public String getAuthorizerUri()

`AWS::ApiGateway::Authorizer.AuthorizerUri`.

setAuthorizerUri

@Stability(value=Stable)
public void setAuthorizerUri(@Nullable
                                                      String value)

`AWS::ApiGateway::Authorizer.AuthorizerUri`.

getAuthType

@Stability(value=Stable)
 @Nullable
public String getAuthType()

`AWS::ApiGateway::Authorizer.AuthType`.

setAuthType

@Stability(value=Stable)
public void setAuthType(@Nullable
                                                 String value)

`AWS::ApiGateway::Authorizer.AuthType`.

getIdentitySource

@Stability(value=Stable)
 @Nullable
public String getIdentitySource()

`AWS::ApiGateway::Authorizer.IdentitySource`.

setIdentitySource

@Stability(value=Stable)
public void setIdentitySource(@Nullable
                                                       String value)

`AWS::ApiGateway::Authorizer.IdentitySource`.

getIdentityValidationExpression

@Stability(value=Stable)
 @Nullable
public String getIdentityValidationExpression()

`AWS::ApiGateway::Authorizer.IdentityValidationExpression`.

setIdentityValidationExpression

@Stability(value=Stable)
public void setIdentityValidationExpression(@Nullable
                                                                     String value)

`AWS::ApiGateway::Authorizer.IdentityValidationExpression`.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

`AWS::ApiGateway::Authorizer.Name`.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

`AWS::ApiGateway::Authorizer.Name`.

getProviderArns

@Stability(value=Stable)
 @Nullable
public List<String> getProviderArns()

`AWS::ApiGateway::Authorizer.ProviderARNs`.

setProviderArns

@Stability(value=Stable)
public void setProviderArns(@Nullable
                                                     List<String> value)

`AWS::ApiGateway::Authorizer.ProviderARNs`.