IGatewayTarget Interface
Interface for GatewayTarget resources.
Represents a target that hosts tools for the gateway. Targets can be Lambda functions, OpenAPI schemas, or Smithy models.
Properties
credentialProviderConfigurationsICredentialProviderConfig[]credential_provider_configurationstyping.List[ICredentialProviderConfig]credentialProviderConfigurationsList<ICredentialProviderConfig>CredentialProviderConfigurationsICredentialProviderConfig[]CredentialProviderConfigurations*[]ICredentialProviderConfig#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
gatewayTargetNamestringgateway_target_namestrgatewayTargetNameStringGatewayTargetNamestringGatewayTargetName*stringrequired#gatewayTargetRefGatewayTargetReferencegateway_target_refGatewayTargetReferencegatewayTargetRefGatewayTargetReferenceGatewayTargetRefGatewayTargetReferenceGatewayTargetRefGatewayTargetReferencerequired#statusReasonsstring[]status_reasonstyping.List[str]statusReasonsList<String>StatusReasonsstring[]StatusReasons*[]*string#targetProtocolTypeGatewayTargetProtocolTypetarget_protocol_typeGatewayTargetProtocolTypetargetProtocolTypeGatewayTargetProtocolTypeTargetProtocolTypeGatewayTargetProtocolTypeTargetProtocolTypeGatewayTargetProtocolTyperequired#Methods
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#grantManage(grantee: IGrantable): Grantdef grant_manage(self, grantee: IGrantable) -> Grantpublic Grant grantManage(IGrantable grantee)public Grant GrantManage(IGrantable grantee)func GrantManage(Grantee IGrantable) Grant#grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.
1 parameter · returns
Parameters
mixinsmixinsmixinsmixinsMixins— The mixins to apply.
Returns: This construct for chaining