opentelekomcloud.ApigwCustomAuthorizerV2
Explore with Pulumi AI
Up-to-date reference of API arguments for API Gateway Custom Authorizer service you can get at documentation portal
Manages an APIGW custom authorizer resource within OpenTelekomCloud.
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
configuration:
gatewayId:
type: dynamic
authorizerName:
type: dynamic
functionUrn:
type: dynamic
resources:
test:
type: opentelekomcloud:ApigwCustomAuthorizerV2
properties:
gatewayId: ${gatewayId}
functionUrn: ${functionUrn}
type: FRONTEND
cacheAge: 60
identities:
- name: user_name
location: QUERY
Create ApigwCustomAuthorizerV2 Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ApigwCustomAuthorizerV2(name: string, args: ApigwCustomAuthorizerV2Args, opts?: CustomResourceOptions);
@overload
def ApigwCustomAuthorizerV2(resource_name: str,
args: ApigwCustomAuthorizerV2Args,
opts: Optional[ResourceOptions] = None)
@overload
def ApigwCustomAuthorizerV2(resource_name: str,
opts: Optional[ResourceOptions] = None,
function_urn: Optional[str] = None,
gateway_id: Optional[str] = None,
apigw_custom_authorizer_v2_id: Optional[str] = None,
identities: Optional[Sequence[ApigwCustomAuthorizerV2IdentityArgs]] = None,
is_body_send: Optional[bool] = None,
name: Optional[str] = None,
ttl: Optional[float] = None,
type: Optional[str] = None,
user_data: Optional[str] = None)
func NewApigwCustomAuthorizerV2(ctx *Context, name string, args ApigwCustomAuthorizerV2Args, opts ...ResourceOption) (*ApigwCustomAuthorizerV2, error)
public ApigwCustomAuthorizerV2(string name, ApigwCustomAuthorizerV2Args args, CustomResourceOptions? opts = null)
public ApigwCustomAuthorizerV2(String name, ApigwCustomAuthorizerV2Args args)
public ApigwCustomAuthorizerV2(String name, ApigwCustomAuthorizerV2Args args, CustomResourceOptions options)
type: opentelekomcloud:ApigwCustomAuthorizerV2
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ApigwCustomAuthorizerV2Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ApigwCustomAuthorizerV2Args
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ApigwCustomAuthorizerV2Args
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApigwCustomAuthorizerV2Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApigwCustomAuthorizerV2Args
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var apigwCustomAuthorizerV2Resource = new Opentelekomcloud.ApigwCustomAuthorizerV2("apigwCustomAuthorizerV2Resource", new()
{
FunctionUrn = "string",
GatewayId = "string",
ApigwCustomAuthorizerV2Id = "string",
Identities = new[]
{
new Opentelekomcloud.Inputs.ApigwCustomAuthorizerV2IdentityArgs
{
Location = "string",
Name = "string",
Validation = "string",
},
},
IsBodySend = false,
Name = "string",
Ttl = 0,
Type = "string",
UserData = "string",
});
example, err := opentelekomcloud.NewApigwCustomAuthorizerV2(ctx, "apigwCustomAuthorizerV2Resource", &opentelekomcloud.ApigwCustomAuthorizerV2Args{
FunctionUrn: pulumi.String("string"),
GatewayId: pulumi.String("string"),
ApigwCustomAuthorizerV2Id: pulumi.String("string"),
Identities: opentelekomcloud.ApigwCustomAuthorizerV2IdentityArray{
&opentelekomcloud.ApigwCustomAuthorizerV2IdentityArgs{
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Validation: pulumi.String("string"),
},
},
IsBodySend: pulumi.Bool(false),
Name: pulumi.String("string"),
Ttl: pulumi.Float64(0),
Type: pulumi.String("string"),
UserData: pulumi.String("string"),
})
var apigwCustomAuthorizerV2Resource = new ApigwCustomAuthorizerV2("apigwCustomAuthorizerV2Resource", ApigwCustomAuthorizerV2Args.builder()
.functionUrn("string")
.gatewayId("string")
.apigwCustomAuthorizerV2Id("string")
.identities(ApigwCustomAuthorizerV2IdentityArgs.builder()
.location("string")
.name("string")
.validation("string")
.build())
.isBodySend(false)
.name("string")
.ttl(0)
.type("string")
.userData("string")
.build());
apigw_custom_authorizer_v2_resource = opentelekomcloud.ApigwCustomAuthorizerV2("apigwCustomAuthorizerV2Resource",
function_urn="string",
gateway_id="string",
apigw_custom_authorizer_v2_id="string",
identities=[{
"location": "string",
"name": "string",
"validation": "string",
}],
is_body_send=False,
name="string",
ttl=0,
type="string",
user_data="string")
const apigwCustomAuthorizerV2Resource = new opentelekomcloud.ApigwCustomAuthorizerV2("apigwCustomAuthorizerV2Resource", {
functionUrn: "string",
gatewayId: "string",
apigwCustomAuthorizerV2Id: "string",
identities: [{
location: "string",
name: "string",
validation: "string",
}],
isBodySend: false,
name: "string",
ttl: 0,
type: "string",
userData: "string",
});
type: opentelekomcloud:ApigwCustomAuthorizerV2
properties:
apigwCustomAuthorizerV2Id: string
functionUrn: string
gatewayId: string
identities:
- location: string
name: string
validation: string
isBodySend: false
name: string
ttl: 0
type: string
userData: string
ApigwCustomAuthorizerV2 Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ApigwCustomAuthorizerV2 resource accepts the following input properties:
- Function
Urn string - Specifies the uniform function URN of the function graph resource.
- Gateway
Id string - Specifies an ID of the APIGW dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
- string
- ID of the custom authorizer.
- Identities
List<Apigw
Custom Authorizer V2Identity> Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
The
identity
block supports:- Is
Body boolSend - Specifies whether to send the body.
- Name string
- Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
- Ttl double
- Specifies the maximum cache age.
- Type string
- Specifies the custom authorize type.
The valid values are
FRONTEND
andBACKEND
. Defaults toFRONTEND
. Changing this will create a new custom authorizer resource. - User
Data string Specifies the user data, which can contain a maximum of
2,048
characters. The user data is used by APIGW to invoke the specified authentication function when accessing the backend service.NOTE: The user data will be displayed in plain text on the console.
- Function
Urn string - Specifies the uniform function URN of the function graph resource.
- Gateway
Id string - Specifies an ID of the APIGW dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
- string
- ID of the custom authorizer.
- Identities
[]Apigw
Custom Authorizer V2Identity Args Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
The
identity
block supports:- Is
Body boolSend - Specifies whether to send the body.
- Name string
- Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
- Ttl float64
- Specifies the maximum cache age.
- Type string
- Specifies the custom authorize type.
The valid values are
FRONTEND
andBACKEND
. Defaults toFRONTEND
. Changing this will create a new custom authorizer resource. - User
Data string Specifies the user data, which can contain a maximum of
2,048
characters. The user data is used by APIGW to invoke the specified authentication function when accessing the backend service.NOTE: The user data will be displayed in plain text on the console.
- function
Urn String - Specifies the uniform function URN of the function graph resource.
- gateway
Id String - Specifies an ID of the APIGW dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
- String
- ID of the custom authorizer.
- identities
List<Apigw
Custom Authorizer V2Identity> Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
The
identity
block supports:- is
Body BooleanSend - Specifies whether to send the body.
- name String
- Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
- ttl Double
- Specifies the maximum cache age.
- type String
- Specifies the custom authorize type.
The valid values are
FRONTEND
andBACKEND
. Defaults toFRONTEND
. Changing this will create a new custom authorizer resource. - user
Data String Specifies the user data, which can contain a maximum of
2,048
characters. The user data is used by APIGW to invoke the specified authentication function when accessing the backend service.NOTE: The user data will be displayed in plain text on the console.
- function
Urn string - Specifies the uniform function URN of the function graph resource.
- gateway
Id string - Specifies an ID of the APIGW dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
- string
- ID of the custom authorizer.
- identities
Apigw
Custom Authorizer V2Identity[] Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
The
identity
block supports:- is
Body booleanSend - Specifies whether to send the body.
- name string
- Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
- ttl number
- Specifies the maximum cache age.
- type string
- Specifies the custom authorize type.
The valid values are
FRONTEND
andBACKEND
. Defaults toFRONTEND
. Changing this will create a new custom authorizer resource. - user
Data string Specifies the user data, which can contain a maximum of
2,048
characters. The user data is used by APIGW to invoke the specified authentication function when accessing the backend service.NOTE: The user data will be displayed in plain text on the console.
- function_
urn str - Specifies the uniform function URN of the function graph resource.
- gateway_
id str - Specifies an ID of the APIGW dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
- str
- ID of the custom authorizer.
- identities
Sequence[Apigw
Custom Authorizer V2Identity Args] Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
The
identity
block supports:- is_
body_ boolsend - Specifies whether to send the body.
- name str
- Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
- ttl float
- Specifies the maximum cache age.
- type str
- Specifies the custom authorize type.
The valid values are
FRONTEND
andBACKEND
. Defaults toFRONTEND
. Changing this will create a new custom authorizer resource. - user_
data str Specifies the user data, which can contain a maximum of
2,048
characters. The user data is used by APIGW to invoke the specified authentication function when accessing the backend service.NOTE: The user data will be displayed in plain text on the console.
- function
Urn String - Specifies the uniform function URN of the function graph resource.
- gateway
Id String - Specifies an ID of the APIGW dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
- String
- ID of the custom authorizer.
- identities List<Property Map>
Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
The
identity
block supports:- is
Body BooleanSend - Specifies whether to send the body.
- name String
- Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
- ttl Number
- Specifies the maximum cache age.
- type String
- Specifies the custom authorize type.
The valid values are
FRONTEND
andBACKEND
. Defaults toFRONTEND
. Changing this will create a new custom authorizer resource. - user
Data String Specifies the user data, which can contain a maximum of
2,048
characters. The user data is used by APIGW to invoke the specified authentication function when accessing the backend service.NOTE: The user data will be displayed in plain text on the console.
Outputs
All input properties are implicitly available as output properties. Additionally, the ApigwCustomAuthorizerV2 resource produces the following output properties:
- created_
at str - The creation time of the custom authorizer.
- id str
- The provider-assigned unique ID for this managed resource.
- region str
- The region in which to create the custom authorizer resource.
Look up Existing ApigwCustomAuthorizerV2 Resource
Get an existing ApigwCustomAuthorizerV2 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ApigwCustomAuthorizerV2State, opts?: CustomResourceOptions): ApigwCustomAuthorizerV2
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
apigw_custom_authorizer_v2_id: Optional[str] = None,
created_at: Optional[str] = None,
function_urn: Optional[str] = None,
gateway_id: Optional[str] = None,
identities: Optional[Sequence[ApigwCustomAuthorizerV2IdentityArgs]] = None,
is_body_send: Optional[bool] = None,
name: Optional[str] = None,
region: Optional[str] = None,
ttl: Optional[float] = None,
type: Optional[str] = None,
user_data: Optional[str] = None) -> ApigwCustomAuthorizerV2
func GetApigwCustomAuthorizerV2(ctx *Context, name string, id IDInput, state *ApigwCustomAuthorizerV2State, opts ...ResourceOption) (*ApigwCustomAuthorizerV2, error)
public static ApigwCustomAuthorizerV2 Get(string name, Input<string> id, ApigwCustomAuthorizerV2State? state, CustomResourceOptions? opts = null)
public static ApigwCustomAuthorizerV2 get(String name, Output<String> id, ApigwCustomAuthorizerV2State state, CustomResourceOptions options)
resources: _: type: opentelekomcloud:ApigwCustomAuthorizerV2 get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- string
- ID of the custom authorizer.
- Created
At string - The creation time of the custom authorizer.
- Function
Urn string - Specifies the uniform function URN of the function graph resource.
- Gateway
Id string - Specifies an ID of the APIGW dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
- Identities
List<Apigw
Custom Authorizer V2Identity> Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
The
identity
block supports:- Is
Body boolSend - Specifies whether to send the body.
- Name string
- Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
- Region string
- The region in which to create the custom authorizer resource.
- Ttl double
- Specifies the maximum cache age.
- Type string
- Specifies the custom authorize type.
The valid values are
FRONTEND
andBACKEND
. Defaults toFRONTEND
. Changing this will create a new custom authorizer resource. - User
Data string Specifies the user data, which can contain a maximum of
2,048
characters. The user data is used by APIGW to invoke the specified authentication function when accessing the backend service.NOTE: The user data will be displayed in plain text on the console.
- string
- ID of the custom authorizer.
- Created
At string - The creation time of the custom authorizer.
- Function
Urn string - Specifies the uniform function URN of the function graph resource.
- Gateway
Id string - Specifies an ID of the APIGW dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
- Identities
[]Apigw
Custom Authorizer V2Identity Args Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
The
identity
block supports:- Is
Body boolSend - Specifies whether to send the body.
- Name string
- Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
- Region string
- The region in which to create the custom authorizer resource.
- Ttl float64
- Specifies the maximum cache age.
- Type string
- Specifies the custom authorize type.
The valid values are
FRONTEND
andBACKEND
. Defaults toFRONTEND
. Changing this will create a new custom authorizer resource. - User
Data string Specifies the user data, which can contain a maximum of
2,048
characters. The user data is used by APIGW to invoke the specified authentication function when accessing the backend service.NOTE: The user data will be displayed in plain text on the console.
- String
- ID of the custom authorizer.
- created
At String - The creation time of the custom authorizer.
- function
Urn String - Specifies the uniform function URN of the function graph resource.
- gateway
Id String - Specifies an ID of the APIGW dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
- identities
List<Apigw
Custom Authorizer V2Identity> Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
The
identity
block supports:- is
Body BooleanSend - Specifies whether to send the body.
- name String
- Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
- region String
- The region in which to create the custom authorizer resource.
- ttl Double
- Specifies the maximum cache age.
- type String
- Specifies the custom authorize type.
The valid values are
FRONTEND
andBACKEND
. Defaults toFRONTEND
. Changing this will create a new custom authorizer resource. - user
Data String Specifies the user data, which can contain a maximum of
2,048
characters. The user data is used by APIGW to invoke the specified authentication function when accessing the backend service.NOTE: The user data will be displayed in plain text on the console.
- string
- ID of the custom authorizer.
- created
At string - The creation time of the custom authorizer.
- function
Urn string - Specifies the uniform function URN of the function graph resource.
- gateway
Id string - Specifies an ID of the APIGW dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
- identities
Apigw
Custom Authorizer V2Identity[] Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
The
identity
block supports:- is
Body booleanSend - Specifies whether to send the body.
- name string
- Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
- region string
- The region in which to create the custom authorizer resource.
- ttl number
- Specifies the maximum cache age.
- type string
- Specifies the custom authorize type.
The valid values are
FRONTEND
andBACKEND
. Defaults toFRONTEND
. Changing this will create a new custom authorizer resource. - user
Data string Specifies the user data, which can contain a maximum of
2,048
characters. The user data is used by APIGW to invoke the specified authentication function when accessing the backend service.NOTE: The user data will be displayed in plain text on the console.
- str
- ID of the custom authorizer.
- created_
at str - The creation time of the custom authorizer.
- function_
urn str - Specifies the uniform function URN of the function graph resource.
- gateway_
id str - Specifies an ID of the APIGW dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
- identities
Sequence[Apigw
Custom Authorizer V2Identity Args] Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
The
identity
block supports:- is_
body_ boolsend - Specifies whether to send the body.
- name str
- Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
- region str
- The region in which to create the custom authorizer resource.
- ttl float
- Specifies the maximum cache age.
- type str
- Specifies the custom authorize type.
The valid values are
FRONTEND
andBACKEND
. Defaults toFRONTEND
. Changing this will create a new custom authorizer resource. - user_
data str Specifies the user data, which can contain a maximum of
2,048
characters. The user data is used by APIGW to invoke the specified authentication function when accessing the backend service.NOTE: The user data will be displayed in plain text on the console.
- String
- ID of the custom authorizer.
- created
At String - The creation time of the custom authorizer.
- function
Urn String - Specifies the uniform function URN of the function graph resource.
- gateway
Id String - Specifies an ID of the APIGW dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
- identities List<Property Map>
Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
The
identity
block supports:- is
Body BooleanSend - Specifies whether to send the body.
- name String
- Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
- region String
- The region in which to create the custom authorizer resource.
- ttl Number
- Specifies the maximum cache age.
- type String
- Specifies the custom authorize type.
The valid values are
FRONTEND
andBACKEND
. Defaults toFRONTEND
. Changing this will create a new custom authorizer resource. - user
Data String Specifies the user data, which can contain a maximum of
2,048
characters. The user data is used by APIGW to invoke the specified authentication function when accessing the backend service.NOTE: The user data will be displayed in plain text on the console.
Supporting Types
ApigwCustomAuthorizerV2Identity, ApigwCustomAuthorizerV2IdentityArgs
- Location string
- Specifies the parameter location, which support
HEADER
andQUERY
. - Name string
- Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
- Validation string
- Specifies the parameter verification expression.
If omitted, the custom authorizer will not perform verification.
The valid value is range form
1
to2,048
.
- Location string
- Specifies the parameter location, which support
HEADER
andQUERY
. - Name string
- Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
- Validation string
- Specifies the parameter verification expression.
If omitted, the custom authorizer will not perform verification.
The valid value is range form
1
to2,048
.
- location String
- Specifies the parameter location, which support
HEADER
andQUERY
. - name String
- Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
- validation String
- Specifies the parameter verification expression.
If omitted, the custom authorizer will not perform verification.
The valid value is range form
1
to2,048
.
- location string
- Specifies the parameter location, which support
HEADER
andQUERY
. - name string
- Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
- validation string
- Specifies the parameter verification expression.
If omitted, the custom authorizer will not perform verification.
The valid value is range form
1
to2,048
.
- location str
- Specifies the parameter location, which support
HEADER
andQUERY
. - name str
- Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
- validation str
- Specifies the parameter verification expression.
If omitted, the custom authorizer will not perform verification.
The valid value is range form
1
to2,048
.
- location String
- Specifies the parameter location, which support
HEADER
andQUERY
. - name String
- Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
- validation String
- Specifies the parameter verification expression.
If omitted, the custom authorizer will not perform verification.
The valid value is range form
1
to2,048
.
Import
Custom Authorizers of the APIGW can be imported using their name
and related dedicated gateway IDs, separated by a
slash, e.g.
$ pulumi import opentelekomcloud:index/apigwCustomAuthorizerV2:ApigwCustomAuthorizerV2 test <gateway_id>/<name>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
- License
- Notes
- This Pulumi package is based on the
opentelekomcloud
Terraform Provider.