Marketplace
BrowsePublish
Marketplace
You are viewing an outdated version of provider-aws.Go to Latest
upbound/provider-aws@v1.3.1
Target
cloudwatchevents.aws.upbound.io
Target
upbound/provider-aws@v1.3.1cloudwatchevents.aws.upbound.io

Target is the Schema for the Targets API. Provides an EventBridge Target resource.

Type

CRD

Group

cloudwatchevents.aws.upbound.io

Version

v1beta1

apiVersion: cloudwatchevents.aws.upbound.io/v1beta1

kind: Target

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

TargetSpec defines the desired state of Target

forProvider
requiredobject
requiredobject

No description provided.

arn
string
array

Parameters used when you are using the rule to invoke an Amazon Batch Job. Documented below. A maximum of 1 are allowed.

array

Parameters used when you are providing a dead letter config. Documented below. A maximum of 1 are allowed.

arn
string
array

Parameters used when you are using the rule to invoke Amazon ECS Task. Documented below. A maximum of 1 are allowed.

array

The capacity provider strategy to use for the task. If a capacity_provider_strategy specified, the launch_type parameter must be omitted. If no capacity_provider_strategy or launch_type is specified, the default capacity provider strategy for the cluster is used. Can be one or more. See below.

base
number
weight
number
group
string
array

Use this if the ECS task uses the awsvpc network mode. This specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. Required if launch_type is FARGATE because the awsvpc mode is required for Fargate tasks.

array

The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used.

subnets
array
array

The subnets associated with the task or service.

array

An array of placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

field
string
type
string
array

An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime). See Below.

type
string
tags
object
taskCount
number
object

Reference to a TaskDefinition in ecs to populate taskDefinitionArn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a TaskDefinition in ecs to populate taskDefinitionArn.

policy
object
object

Policies for selection.

resolve
string
object

Reference to a Bus to populate eventBusName.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Bus to populate eventBusName.

policy
object
object

Policies for selection.

resolve
string
array

Parameters used when you are using the rule to invoke an API Gateway REST endpoint. Documented below. A maximum of 1 is allowed.

array

The list of values that correspond sequentially to any path variables in your endpoint ARN (for example arn:aws:execute-api:us-east-1:123456:myapi//POST/pets/).

input
string
inputPath
string
array

Parameters used when you are providing a custom input to a target based on certain event data. Conflicts with input and input_path.

array

Parameters used when you are using the rule to invoke an Amazon Kinesis Stream. Documented below. A maximum of 1 are allowed.

array

Parameters used when you are using the rule to invoke an Amazon Redshift Statement. Documented below. A maximum of 1 are allowed.

region
requiredstring
array

Parameters used when you are providing retry policies. Documented below. A maximum of 1 are allowed.

roleArn
string
object

Reference to a Role in iam to populate roleArn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Role in iam to populate roleArn.

policy
object
object

Policies for selection.

resolve
string
rule
string
ruleRef
object
object

Reference to a Rule in cloudwatchevents to populate rule.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Rule in cloudwatchevents to populate rule.

policy
object
object

Policies for selection.

resolve
string
array

Parameters used when you are using the rule to invoke Amazon EC2 Run Command. Documented below. A maximum of 5 are allowed.

key
string
values
array
array

If Key is tag:tag-key, Values is a list of tag values. If Key is InstanceIds, Values is a list of Amazon EC2 instance IDs.

array

Parameters used when you are using the rule to invoke an Amazon SageMaker Pipeline. Documented below. A maximum of 1 are allowed.

array

List of Parameter names and values for SageMaker Model Building Pipeline execution.

name
string
value
string
array

Parameters used when you are using the rule to invoke an Amazon SQS Queue. Documented below. A maximum of 1 are allowed.

targetId
string
object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

arn
string
array

Parameters used when you are using the rule to invoke an Amazon Batch Job. Documented below. A maximum of 1 are allowed.

array

Parameters used when you are providing a dead letter config. Documented below. A maximum of 1 are allowed.

arn
string
array

Parameters used when you are using the rule to invoke Amazon ECS Task. Documented below. A maximum of 1 are allowed.

array

The capacity provider strategy to use for the task. If a capacity_provider_strategy specified, the launch_type parameter must be omitted. If no capacity_provider_strategy or launch_type is specified, the default capacity provider strategy for the cluster is used. Can be one or more. See below.

base
number
weight
number
group
string
array

Use this if the ECS task uses the awsvpc network mode. This specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. Required if launch_type is FARGATE because the awsvpc mode is required for Fargate tasks.

array

The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used.

subnets
array
array

The subnets associated with the task or service.

array

An array of placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

field
string
type
string
array

An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime). See Below.

type
string
tags
object
taskCount
number
object

Reference to a TaskDefinition in ecs to populate taskDefinitionArn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a TaskDefinition in ecs to populate taskDefinitionArn.

policy
object
object

Policies for selection.

resolve
string
object

Reference to a Bus to populate eventBusName.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Bus to populate eventBusName.

policy
object
object

Policies for selection.

resolve
string
array

Parameters used when you are using the rule to invoke an API Gateway REST endpoint. Documented below. A maximum of 1 is allowed.

array

The list of values that correspond sequentially to any path variables in your endpoint ARN (for example arn:aws:execute-api:us-east-1:123456:myapi//POST/pets/).

input
string
inputPath
string
array

Parameters used when you are providing a custom input to a target based on certain event data. Conflicts with input and input_path.

array

Parameters used when you are using the rule to invoke an Amazon Kinesis Stream. Documented below. A maximum of 1 are allowed.

array

Parameters used when you are using the rule to invoke an Amazon Redshift Statement. Documented below. A maximum of 1 are allowed.

array

Parameters used when you are providing retry policies. Documented below. A maximum of 1 are allowed.

roleArn
string
object

Reference to a Role in iam to populate roleArn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Role in iam to populate roleArn.

policy
object
object

Policies for selection.

resolve
string
rule
string
ruleRef
object
object

Reference to a Rule in cloudwatchevents to populate rule.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Rule in cloudwatchevents to populate rule.

policy
object
object

Policies for selection.

resolve
string
array

Parameters used when you are using the rule to invoke Amazon EC2 Run Command. Documented below. A maximum of 5 are allowed.

key
string
values
array
array

If Key is tag:tag-key, Values is a list of tag values. If Key is InstanceIds, Values is a list of Amazon EC2 instance IDs.

array

Parameters used when you are using the rule to invoke an Amazon SageMaker Pipeline. Documented below. A maximum of 1 are allowed.

array

List of Parameter names and values for SageMaker Model Building Pipeline execution.

name
string
value
string
array

Parameters used when you are using the rule to invoke an Amazon SQS Queue. Documented below. A maximum of 1 are allowed.

targetId
string
array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

TargetStatus defines the observed state of Target.

object

No description provided.

arn
string
array

Parameters used when you are using the rule to invoke an Amazon Batch Job. Documented below. A maximum of 1 are allowed.

array

Parameters used when you are providing a dead letter config. Documented below. A maximum of 1 are allowed.

arn
string
array

Parameters used when you are using the rule to invoke Amazon ECS Task. Documented below. A maximum of 1 are allowed.

array

The capacity provider strategy to use for the task. If a capacity_provider_strategy specified, the launch_type parameter must be omitted. If no capacity_provider_strategy or launch_type is specified, the default capacity provider strategy for the cluster is used. Can be one or more. See below.

base
number
weight
number
group
string
array

Use this if the ECS task uses the awsvpc network mode. This specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. Required if launch_type is FARGATE because the awsvpc mode is required for Fargate tasks.

array

The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used.

subnets
array
array

The subnets associated with the task or service.

array

An array of placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

field
string
type
string
array

An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime). See Below.

type
string
tags
object
taskCount
number
array

Parameters used when you are using the rule to invoke an API Gateway REST endpoint. Documented below. A maximum of 1 is allowed.

array

The list of values that correspond sequentially to any path variables in your endpoint ARN (for example arn:aws:execute-api:us-east-1:123456:myapi//POST/pets/).

id
string
input
string
inputPath
string
array

Parameters used when you are providing a custom input to a target based on certain event data. Conflicts with input and input_path.

array

Parameters used when you are using the rule to invoke an Amazon Kinesis Stream. Documented below. A maximum of 1 are allowed.

array

Parameters used when you are using the rule to invoke an Amazon Redshift Statement. Documented below. A maximum of 1 are allowed.

array

Parameters used when you are providing retry policies. Documented below. A maximum of 1 are allowed.

roleArn
string
rule
string
array

Parameters used when you are using the rule to invoke Amazon EC2 Run Command. Documented below. A maximum of 5 are allowed.

key
string
values
array
array

If Key is tag:tag-key, Values is a list of tag values. If Key is InstanceIds, Values is a list of Amazon EC2 instance IDs.

array

Parameters used when you are using the rule to invoke an Amazon SageMaker Pipeline. Documented below. A maximum of 1 are allowed.

array

List of Parameter names and values for SageMaker Model Building Pipeline execution.

name
string
value
string
array

Parameters used when you are using the rule to invoke an Amazon SQS Queue. Documented below. A maximum of 1 are allowed.

targetId
string
array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Marketplace

Discover the building blocks for your internal cloud platform.

© 2022 Upbound, Inc.

SolutionsProvidersConfigurations
LearnDocumentationTry for Free
MorePrivacy PolicyTerms & Conditions
Marketplace

© 2022 Upbound, Inc.

Marketplace

Discover the building blocksfor your internal cloud platform.