types.md

AWS.Events @ default

Resource AWS.Events/ApiDestination@default

• Valid Scope(s): Unknown

Properties

• alias: string (Required): the resource alias
• name: string: the resource name
• properties: AWS.Events/ApiDestinationProperties (Required): properties of the resource

Resource AWS.Events/Archive@default

• Valid Scope(s): Unknown

Properties

• alias: string (Required): the resource alias
• name: string: the resource name
• properties: AWS.Events/ArchiveProperties (Required): properties of the resource

Resource AWS.Events/Connection@default

• Valid Scope(s): Unknown

Properties

• alias: string (Required): the resource alias
• name: string: the resource name
• properties: AWS.Events/ConnectionProperties (Required): properties of the resource

Resource AWS.Events/Endpoint@default

• Valid Scope(s): Unknown

Properties

• alias: string (Required): the resource alias
• name: string: the resource name
• properties: AWS.Events/EndpointProperties (Required): properties of the resource

Resource AWS.Events/EventBus@default

• Valid Scope(s): Unknown

Properties

• alias: string (Required): the resource alias
• name: string: the resource name
• properties: AWS.Events/EventBusProperties (Required): properties of the resource

Resource AWS.Events/Rule@default

• Valid Scope(s): Unknown

Properties

• alias: string (Required): the resource alias
• name: string: the resource name
• properties: AWS.Events/RuleProperties: properties of the resource

AWS.Events/ApiDestinationProperties

Properties

• Arn: string (ReadOnly): The arn of the api destination.
• ConnectionArn: string (Required): The arn of the connection.
• Description: string
• HttpMethod: string (Required)
• InvocationEndpoint: string (Required): Url endpoint to invoke.
• InvocationRateLimitPerSecond: int
• Name: string (Identifier): Name of the apiDestination.

AWS.Events/ArchiveProperties

Properties

• ArchiveName: string (Identifier)
• Arn: string (ReadOnly)
• Description: string
• EventPattern: Archive_EventPattern
• RetentionDays: int
• SourceArn: string (Required)

Archive_EventPattern

Properties

AWS.Events/ConnectionProperties

Properties

• Arn: string (ReadOnly): The arn of the connection resource.
• AuthorizationType: string (Required)
• AuthParameters: AuthParameters (Required, WriteOnly)
• Description: string: Description of the connection.
• Name: string (Identifier): Name of the connection.
• SecretArn: string (ReadOnly): The arn of the secrets manager secret created in the customer account.

AuthParameters

Properties

• ApiKeyAuthParameters: ApiKeyAuthParameters
• BasicAuthParameters: BasicAuthParameters
• InvocationHttpParameters: ConnectionHttpParameters
• OAuthParameters: OAuthParameters

ApiKeyAuthParameters

Properties

• ApiKeyName: string (Required)
• ApiKeyValue: string (Required)

BasicAuthParameters

Properties

• Password: string (Required)
• Username: string (Required)

ConnectionHttpParameters

Properties

• BodyParameters: Parameter[]
• HeaderParameters: Parameter[]
• QueryStringParameters: Parameter[]

Parameter

Properties

• IsValueSecret: bool
• Key: string (Required)
• Value: string (Required)

OAuthParameters

Properties

• AuthorizationEndpoint: string (Required)
• ClientParameters: ClientParameters (Required)
• HttpMethod: string (Required)
• OAuthHttpParameters: ConnectionHttpParameters

ClientParameters

Properties

• ClientID: string (Required)
• ClientSecret: string (Required)

AWS.Events/EndpointProperties

Properties

• Arn: string (ReadOnly)
• Description: string
• EndpointId: string (ReadOnly)
• EndpointUrl: string (ReadOnly)
• EventBuses: EndpointEventBus[] (Required)
• Name: string (Identifier)
• ReplicationConfig: ReplicationConfig
• RoleArn: string
• RoutingConfig: RoutingConfig (Required)
• State: string (ReadOnly)
• StateReason: string (ReadOnly)

EndpointEventBus

Properties

• EventBusArn: string (Required)

ReplicationConfig

Properties

• State: string (Required)

RoutingConfig

Properties

• FailoverConfig: FailoverConfig (Required)

FailoverConfig

Properties

• Primary: Primary (Required)
• Secondary: Secondary (Required)

Primary

Properties

• HealthCheck: string (Required)

Secondary

Properties

• Route: string (Required)

AWS.Events/EventBusProperties

Properties

• Arn: string (ReadOnly): The Amazon Resource Name (ARN) for the event bus.
• EventSourceName: string (WriteOnly): If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
• Name: string (Required, Identifier): The name of the event bus.
• Policy: EventBus_Policy | string: A JSON string that describes the permission policy statement for the event bus.
• Tags: Tag[]: Any tags assigned to the event bus.

Tag

Properties

• Key: string (Required)
• Value: string (Required)

AWS.Events/RuleProperties

Properties

• Arn: string (ReadOnly, Identifier): The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
• Description: string: The description of the rule.
• EventBusName: string: The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
• EventPattern: Rule_EventPattern | string: The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
• Name: string: The name of the rule.
• RoleArn: string: The Amazon Resource Name (ARN) of the role that is used for target invocation.
• ScheduleExpression: string: The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.
• State: string: The state of the rule.
• Targets: Target[]: Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are invoked when a rule is triggered.

Target

Properties

• AppSyncParameters: AppSyncParameters
• Arn: string (Required, Identifier)
• BatchParameters: BatchParameters
• DeadLetterConfig: DeadLetterConfig
• EcsParameters: EcsParameters
• HttpParameters: HttpParameters
• Id: string (Required)
• Input: string
• InputPath: string
• InputTransformer: InputTransformer
• KinesisParameters: KinesisParameters
• RedshiftDataParameters: RedshiftDataParameters
• RetryPolicy: RetryPolicy
• RoleArn: string
• RunCommandParameters: RunCommandParameters
• SageMakerPipelineParameters: SageMakerPipelineParameters
• SqsParameters: SqsParameters

AppSyncParameters

Properties

• GraphQLOperation: string (Required)

BatchParameters

Properties

• ArrayProperties: BatchArrayProperties
• JobDefinition: string (Required)
• JobName: string (Required)
• RetryStrategy: BatchRetryStrategy

BatchArrayProperties

Properties

• Size: int

BatchRetryStrategy

Properties

• Attempts: int

DeadLetterConfig

Properties

• Arn: string (Identifier)

EcsParameters

Properties

• CapacityProviderStrategy: CapacityProviderStrategyItem[]
• EnableECSManagedTags: bool
• EnableExecuteCommand: bool
• Group: string
• LaunchType: string
• NetworkConfiguration: NetworkConfiguration
• PlacementConstraints: PlacementConstraint[]
• PlacementStrategies: PlacementStrategy[]
• PlatformVersion: string
• PropagateTags: string
• ReferenceId: string
• TagList: Tag[]
• TaskCount: int
• TaskDefinitionArn: string (Required)

CapacityProviderStrategyItem

Properties

• Base: int
• CapacityProvider: string (Required)
• Weight: int

NetworkConfiguration

Properties

• AwsVpcConfiguration: AwsVpcConfiguration

AwsVpcConfiguration

Properties

• AssignPublicIp: string
• SecurityGroups: string[]
• Subnets: string[] (Required)

PlacementConstraint

Properties

• Expression: string
• Type: string

PlacementStrategy

Properties

• Field: string
• Type: string

Tag

Properties

• Key: string
• Value: string

HttpParameters

Properties

• HeaderParameters: Rule_HeaderParameters
• PathParameterValues: string[]
• QueryStringParameters: Rule_QueryStringParameters

Rule_HeaderParameters

Properties

Rule_QueryStringParameters

Properties

InputTransformer

Properties

• InputPathsMap: Rule_InputPathsMap
• InputTemplate: string (Required)

Rule_InputPathsMap

Properties

KinesisParameters

Properties

• PartitionKeyPath: string (Required)

RedshiftDataParameters

Properties

• Database: string (Required)
• DbUser: string
• SecretManagerArn: string
• Sql: string
• Sqls: string[]
• StatementName: string
• WithEvent: bool

RetryPolicy

Properties

• MaximumEventAgeInSeconds: int
• MaximumRetryAttempts: int

RunCommandParameters

Properties

• RunCommandTargets: RunCommandTarget[] (Required)

RunCommandTarget

Properties

• Key: string (Required)
• Values: string[] (Required)

SageMakerPipelineParameters

Properties

• PipelineParameterList: SageMakerPipelineParameter[]

SageMakerPipelineParameter

Properties

• Name: string (Required)
• Value: string (Required)

SqsParameters

Properties

• MessageGroupId: string (Required)