AWS Native

v0.43.0 published on Thursday, Dec 1, 2022 by Pulumi

ApiDestination

Resource Type definition for AWS::Events::ApiDestination.

Create ApiDestination Resource

new ApiDestination(name: string, args: ApiDestinationArgs, opts?: CustomResourceOptions);
@overload
def ApiDestination(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   connection_arn: Optional[str] = None,
                   description: Optional[str] = None,
                   http_method: Optional[ApiDestinationHttpMethod] = None,
                   invocation_endpoint: Optional[str] = None,
                   invocation_rate_limit_per_second: Optional[int] = None,
                   name: Optional[str] = None)
@overload
def ApiDestination(resource_name: str,
                   args: ApiDestinationArgs,
                   opts: Optional[ResourceOptions] = None)
func NewApiDestination(ctx *Context, name string, args ApiDestinationArgs, opts ...ResourceOption) (*ApiDestination, error)
public ApiDestination(string name, ApiDestinationArgs args, CustomResourceOptions? opts = null)
public ApiDestination(String name, ApiDestinationArgs args)
public ApiDestination(String name, ApiDestinationArgs args, CustomResourceOptions options)
type: aws-native:events:ApiDestination
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ApiDestinationArgs
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 ApiDestinationArgs
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 ApiDestinationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ApiDestinationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ApiDestinationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ApiDestination Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ApiDestination resource accepts the following input properties:

ConnectionArn string

The arn of the connection.

HttpMethod Pulumi.AwsNative.Events.ApiDestinationHttpMethod
InvocationEndpoint string

Url endpoint to invoke.

Description string
InvocationRateLimitPerSecond int
Name string

Name of the apiDestination.

ConnectionArn string

The arn of the connection.

HttpMethod ApiDestinationHttpMethod
InvocationEndpoint string

Url endpoint to invoke.

Description string
InvocationRateLimitPerSecond int
Name string

Name of the apiDestination.

connectionArn String

The arn of the connection.

httpMethod ApiDestinationHttpMethod
invocationEndpoint String

Url endpoint to invoke.

description String
invocationRateLimitPerSecond Integer
name String

Name of the apiDestination.

connectionArn string

The arn of the connection.

httpMethod ApiDestinationHttpMethod
invocationEndpoint string

Url endpoint to invoke.

description string
invocationRateLimitPerSecond number
name string

Name of the apiDestination.

connection_arn str

The arn of the connection.

http_method ApiDestinationHttpMethod
invocation_endpoint str

Url endpoint to invoke.

description str
invocation_rate_limit_per_second int
name str

Name of the apiDestination.

connectionArn String

The arn of the connection.

httpMethod "GET" | "HEAD" | "POST" | "OPTIONS" | "PUT" | "DELETE" | "PATCH"
invocationEndpoint String

Url endpoint to invoke.

description String
invocationRateLimitPerSecond Number
name String

Name of the apiDestination.

Outputs

All input properties are implicitly available as output properties. Additionally, the ApiDestination resource produces the following output properties:

Arn string

The arn of the api destination.

Id string

The provider-assigned unique ID for this managed resource.

Arn string

The arn of the api destination.

Id string

The provider-assigned unique ID for this managed resource.

arn String

The arn of the api destination.

id String

The provider-assigned unique ID for this managed resource.

arn string

The arn of the api destination.

id string

The provider-assigned unique ID for this managed resource.

arn str

The arn of the api destination.

id str

The provider-assigned unique ID for this managed resource.

arn String

The arn of the api destination.

id String

The provider-assigned unique ID for this managed resource.

Supporting Types

ApiDestinationHttpMethod

Get
GET
Head
HEAD
Post
POST
Options
OPTIONS
Put
PUT
Delete
DELETE
Patch
PATCH
ApiDestinationHttpMethodGet
GET
ApiDestinationHttpMethodHead
HEAD
ApiDestinationHttpMethodPost
POST
ApiDestinationHttpMethodOptions
OPTIONS
ApiDestinationHttpMethodPut
PUT
ApiDestinationHttpMethodDelete
DELETE
ApiDestinationHttpMethodPatch
PATCH
Get
GET
Head
HEAD
Post
POST
Options
OPTIONS
Put
PUT
Delete
DELETE
Patch
PATCH
Get
GET
Head
HEAD
Post
POST
Options
OPTIONS
Put
PUT
Delete
DELETE
Patch
PATCH
GET
GET
HEAD
HEAD
POST
POST
OPTIONS
OPTIONS
PUT
PUT
DELETE
DELETE
PATCH
PATCH
"GET"
GET
"HEAD"
HEAD
"POST"
POST
"OPTIONS"
OPTIONS
"PUT"
PUT
"DELETE"
DELETE
"PATCH"
PATCH

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0