@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:27:50.880Z") public class CfnAuthorizer extends CfnResource implements IInspectable
Specifies an authorizer.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.iot.*; CfnAuthorizer cfnAuthorizer = CfnAuthorizer.Builder.create(this, "MyCfnAuthorizer") .authorizerFunctionArn("authorizerFunctionArn") // the properties below are optional .authorizerName("authorizerName") .enableCachingForHttp(false) .signingDisabled(false) .status("status") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .tokenKeyName("tokenKeyName") .tokenSigningPublicKeys(Map.of( "tokenSigningPublicKeysKey", "tokenSigningPublicKeys")) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnAuthorizer.Builder
A fluent builder for
CfnAuthorizer . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnAuthorizer(Construct scope,
java.lang.String id,
CfnAuthorizerProps props)
Create a new `AWS::IoT::Authorizer`.
|
protected |
CfnAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnAuthorizer(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
The Amazon Resource Name (ARN) of the authorizer.
|
java.lang.String |
getAuthorizerFunctionArn()
The authorizer's Lambda function ARN.
|
java.lang.String |
getAuthorizerName()
The authorizer name.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getEnableCachingForHttp()
`AWS::IoT::Authorizer.EnableCachingForHttp`.
|
java.lang.Object |
getSigningDisabled()
Specifies whether AWS IoT validates the token signature in an authorization request.
|
java.lang.String |
getStatus()
The status of the authorizer.
|
TagManager |
getTags()
Metadata which can be used to manage the custom authorizer.
|
java.lang.String |
getTokenKeyName()
The key used to extract the token from the HTTP headers.
|
java.lang.Object |
getTokenSigningPublicKeys()
The public keys used to validate the token signature returned by your custom authentication service.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAuthorizerFunctionArn(java.lang.String value)
The authorizer's Lambda function ARN.
|
void |
setAuthorizerName(java.lang.String value)
The authorizer name.
|
void |
setEnableCachingForHttp(java.lang.Boolean value)
`AWS::IoT::Authorizer.EnableCachingForHttp`.
|
void |
setEnableCachingForHttp(IResolvable value)
`AWS::IoT::Authorizer.EnableCachingForHttp`.
|
void |
setSigningDisabled(java.lang.Boolean value)
Specifies whether AWS IoT validates the token signature in an authorization request.
|
void |
setSigningDisabled(IResolvable value)
Specifies whether AWS IoT validates the token signature in an authorization request.
|
void |
setStatus(java.lang.String value)
The status of the authorizer.
|
void |
setTokenKeyName(java.lang.String value)
The key used to extract the token from the HTTP headers.
|
void |
setTokenSigningPublicKeys(IResolvable value)
The public keys used to validate the token signature returned by your custom authentication service.
|
void |
setTokenSigningPublicKeys(java.util.Map<java.lang.String,java.lang.String> value)
The public keys used to validate the token signature returned by your custom authentication service.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnAuthorizer(Construct scope, java.lang.String id, CfnAuthorizerProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
public java.lang.String getAuthorizerFunctionArn()
public void setAuthorizerFunctionArn(java.lang.String value)
public java.lang.String getAuthorizerName()
public void setAuthorizerName(java.lang.String value)
public java.lang.Object getEnableCachingForHttp()
public void setEnableCachingForHttp(java.lang.Boolean value)
public void setEnableCachingForHttp(IResolvable value)
public java.lang.Object getSigningDisabled()
public void setSigningDisabled(java.lang.Boolean value)
public void setSigningDisabled(IResolvable value)
public java.lang.String getStatus()
Valid values: ACTIVE
| INACTIVE
public void setStatus(java.lang.String value)
Valid values: ACTIVE
| INACTIVE
public java.lang.String getTokenKeyName()
public void setTokenKeyName(java.lang.String value)
public java.lang.Object getTokenSigningPublicKeys()
public void setTokenSigningPublicKeys(IResolvable value)
public void setTokenSigningPublicKeys(java.util.Map<java.lang.String,java.lang.String> value)