文件 AWS 開發套件範例 GitHub 儲存庫中有更多可用的 [AWS SDK 範例](https://github.com/awsdocs/aws-doc-sdk-examples)。
本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# 使用 AWS SDKs CloudWatch Events 程式碼範例
下列程式碼範例示範如何使用 Amazon CloudWatch Events 搭配 AWS 軟體開發套件 (SDK)。
*Actions* 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。
**其他資源**
+ **[ CloudWatch Events 使用者指南](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/WhatIsCloudWatchEvents.html)** – CloudWatch Events 的相關詳細資訊。
+ **[CloudWatch Events API 參考](https://docs.aws.amazon.com/eventbridge/latest/APIReference/Welcome.html)** – 所有可用 CloudWatch Events 動作的詳細資訊。
+ **[AWS 開發人員中心](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23cloudwatch)** – 您可以依類別或全文搜尋篩選的程式碼範例。
+ **[AWS SDK 範例](https://github.com/awsdocs/aws-doc-sdk-examples)** – GitHub 儲存庫使用慣用語言的完整程式碼。包含設定和執行程式碼的指示。
**Contents**
+ [基本概念](cloudwatch-events_code_examples_basics.md)
+ [動作](cloudwatch-events_code_examples_actions.md)
+ [`PutEvents`](cloudwatch-events_example_cloudwatch-events_PutEvents_section.md)
+ [`PutRule`](cloudwatch-events_example_cloudwatch-events_PutRule_section.md)
+ [`PutTargets`](cloudwatch-events_example_cloudwatch-events_PutTargets_section.md)
# 使用 AWS SDKs CloudWatch Events 基本範例
下列程式碼範例示範如何搭配 AWS SDK 使用 Amazon CloudWatch Events 的基本功能。
**Contents**
+ [動作](cloudwatch-events_code_examples_actions.md)
+ [`PutEvents`](cloudwatch-events_example_cloudwatch-events_PutEvents_section.md)
+ [`PutRule`](cloudwatch-events_example_cloudwatch-events_PutRule_section.md)
+ [`PutTargets`](cloudwatch-events_example_cloudwatch-events_PutTargets_section.md)
# 使用 AWS SDKs的 CloudWatch Events 動作
下列程式碼範例示範如何使用 AWS SDKs 執行個別 CloudWatch Events 動作。每個範例均包含 GitHub 的連結，您可以在連結中找到設定和執行程式碼的相關說明。
下列範例僅包含最常使用的動作。如需完整清單，請參閱 [Amazon CloudWatch Events API 參考](https://docs.aws.amazon.com/eventbridge/latest/APIReference/Welcome.html)。
**Topics**
+ [`PutEvents`](cloudwatch-events_example_cloudwatch-events_PutEvents_section.md)
+ [`PutRule`](cloudwatch-events_example_cloudwatch-events_PutRule_section.md)
+ [`PutTargets`](cloudwatch-events_example_cloudwatch-events_PutTargets_section.md)
# `PutEvents` 搭配 AWS SDK 使用
下列程式碼範例示範如何使用 `PutEvents`。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/cloudwatch#code-examples)中設定和執行。
```
import software.amazon.awssdk.services.cloudwatch.model.CloudWatchException;
import software.amazon.awssdk.services.cloudwatchevents.CloudWatchEventsClient;
import software.amazon.awssdk.services.cloudwatchevents.model.PutEventsRequest;
import software.amazon.awssdk.services.cloudwatchevents.model.PutEventsRequestEntry;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class PutEvents {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
resourceArn - An Amazon Resource Name (ARN) related to the events.
""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String resourceArn = args[0];
CloudWatchEventsClient cwe = CloudWatchEventsClient.builder()
.build();
putCWEvents(cwe, resourceArn);
cwe.close();
}
public static void putCWEvents(CloudWatchEventsClient cwe, String resourceArn) {
try {
final String EVENT_DETAILS = "{ \"key1\": \"value1\", \"key2\": \"value2\" }";
PutEventsRequestEntry requestEntry = PutEventsRequestEntry.builder()
.detail(EVENT_DETAILS)
.detailType("sampleSubmitted")
.resources(resourceArn)
.source("aws-sdk-java-cloudwatch-example")
.build();
PutEventsRequest request = PutEventsRequest.builder()
.entries(requestEntry)
.build();
cwe.putEvents(request);
System.out.println("Successfully put CloudWatch event");
} catch (CloudWatchException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ 如需 API 的詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [PutEvents](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/PutEvents)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cloudwatch-events#code-examples)中設定和執行。
匯入 SDK 和用戶端模組，然後呼叫 API。
```
import { PutEventsCommand } from "@aws-sdk/client-cloudwatch-events";
import { client } from "../libs/client.js";
const run = async () => {
const command = new PutEventsCommand({
// The list of events to send to Amazon CloudWatch Events.
Entries: [
{
// The name of the application or service that is sending the event.
Source: "my.app",
// The name of the event that is being sent.
DetailType: "My Custom Event",
// The data that is sent with the event.
Detail: JSON.stringify({ timeOfEvent: new Date().toISOString() }),
},
],
});
try {
return await client.send(command);
} catch (err) {
console.error(err);
}
};
export default run();
```
在單獨的模組中建立用戶端並將其匯出。
```
import { CloudWatchEventsClient } from "@aws-sdk/client-cloudwatch-events";
export const client = new CloudWatchEventsClient({});
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/cloudwatch-examples-sending-events.html#cloudwatch-examples-sending-events-putevents)》。
+ 如需 API 的詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [PutEvents](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudwatch-events/command/PutEventsCommand)。
**適用於 JavaScript (v2) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascript/example_code/cloudwatch-events#code-examples)中設定和執行。
```
// Load the AWS SDK for Node.js
var AWS = require("aws-sdk");
// Set the region
AWS.config.update({ region: "REGION" });
// Create CloudWatchEvents service object
var cwevents = new AWS.CloudWatchEvents({ apiVersion: "2015-10-07" });
var params = {
Entries: [
{
Detail: '{ "key1": "value1", "key2": "value2" }',
DetailType: "appRequestSubmitted",
Resources: ["RESOURCE_ARN"],
Source: "com.company.app",
},
],
};
cwevents.putEvents(params, function (err, data) {
if (err) {
console.log("Error", err);
} else {
console.log("Success", data.Entries);
}
});
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/cloudwatch-examples-sending-events.html#cloudwatch-examples-sending-events-putevents)》。
+ 如需 API 的詳細資訊，請參閱 *適用於 JavaScript 的 AWS SDK API 參考*中的 [PutEvents](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/monitoring-2010-08-01/PutEvents)。
------
# `PutRule` 搭配 AWS SDK 使用
下列程式碼範例示範如何使用 `PutRule`。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/cloudwatch#code-examples)中設定和執行。
```
import software.amazon.awssdk.services.cloudwatch.model.CloudWatchException;
import software.amazon.awssdk.services.cloudwatchevents.CloudWatchEventsClient;
import software.amazon.awssdk.services.cloudwatchevents.model.PutRuleRequest;
import software.amazon.awssdk.services.cloudwatchevents.model.PutRuleResponse;
import software.amazon.awssdk.services.cloudwatchevents.model.RuleState;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class PutRule {
public static void main(String[] args) {
final String usage = """
Usage:
roleArn>\s
Where:
ruleName - A rule name (for example, myrule).
roleArn - A role ARN value (for example, arn:aws:iam::xxxxxx047983:user/MyUser).
""";
if (args.length != 2) {
System.out.println(usage);
System.exit(1);
}
String ruleName = args[0];
String roleArn = args[1];
CloudWatchEventsClient cwe = CloudWatchEventsClient.builder()
.build();
putCWRule(cwe, ruleName, roleArn);
cwe.close();
}
public static void putCWRule(CloudWatchEventsClient cwe, String ruleName, String roleArn) {
try {
PutRuleRequest request = PutRuleRequest.builder()
.name(ruleName)
.roleArn(roleArn)
.scheduleExpression("rate(5 minutes)")
.state(RuleState.ENABLED)
.build();
PutRuleResponse response = cwe.putRule(request);
System.out.printf(
"Successfully created CloudWatch events rule %s with arn %s",
roleArn, response.ruleArn());
} catch (CloudWatchException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ 如需 API 的詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [PutRule](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/PutRule)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cloudwatch-events#code-examples)中設定和執行。
匯入 SDK 和用戶端模組，然後呼叫 API。
```
import { PutRuleCommand } from "@aws-sdk/client-cloudwatch-events";
import { client } from "../libs/client.js";
const run = async () => {
// Request parameters for PutRule.
// https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutRule.html#API_PutRule_RequestParameters
const command = new PutRuleCommand({
Name: process.env.CLOUDWATCH_EVENTS_RULE,
// The event pattern for the rule.
// Example: {"source": ["my.app"]}
EventPattern: process.env.CLOUDWATCH_EVENTS_RULE_PATTERN,
// The state of the rule. Valid values: ENABLED, DISABLED
State: "ENABLED",
});
try {
return await client.send(command);
} catch (err) {
console.error(err);
}
};
export default run();
```
在單獨的模組中建立用戶端並將其匯出。
```
import { CloudWatchEventsClient } from "@aws-sdk/client-cloudwatch-events";
export const client = new CloudWatchEventsClient({});
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/cloudwatch-examples-sending-events.html#cloudwatch-examples-sending-events-rules)》。
+ 如需 API 的詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [PutRule](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudwatch-events/command/PutRuleCommand)。
**適用於 JavaScript (v2) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascript/example_code/cloudwatch-events#code-examples)中設定和執行。
```
// Load the AWS SDK for Node.js
var AWS = require("aws-sdk");
// Set the region
AWS.config.update({ region: "REGION" });
// Create CloudWatchEvents service object
var cwevents = new AWS.CloudWatchEvents({ apiVersion: "2015-10-07" });
var params = {
Name: "DEMO_EVENT",
RoleArn: "IAM_ROLE_ARN",
ScheduleExpression: "rate(5 minutes)",
State: "ENABLED",
};
cwevents.putRule(params, function (err, data) {
if (err) {
console.log("Error", err);
} else {
console.log("Success", data.RuleArn);
}
});
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/cloudwatch-examples-sending-events.html#cloudwatch-examples-sending-events-rules)》。
+ 如需 API 的詳細資訊，請參閱 *適用於 JavaScript 的 AWS SDK API 參考*中的 [PutRule](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/monitoring-2010-08-01/PutRule)。
------
# `PutTargets` 搭配 AWS SDK 使用
下列程式碼範例示範如何使用 `PutTargets`。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/cloudwatch#code-examples)中設定和執行。
```
import software.amazon.awssdk.services.cloudwatch.model.CloudWatchException;
import software.amazon.awssdk.services.cloudwatchevents.CloudWatchEventsClient;
import software.amazon.awssdk.services.cloudwatchevents.model.PutTargetsRequest;
import software.amazon.awssdk.services.cloudwatchevents.model.Target;
/**
* To run this Java V2 code example, ensure that you have setup your development
* environment, including your credentials.
*
* For information, see this documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class PutTargets {
public static void main(String[] args) {
final String usage = """
Usage:
\s
Where:
ruleName - A rule name (for example, myrule).
functionArn - An AWS Lambda function ARN (for example, arn:aws:lambda:us-west-2:xxxxxx047983:function:lamda1).
targetId - A target id value.
""";
if (args.length != 3) {
System.out.println(usage);
System.exit(1);
}
String ruleName = args[0];
String functionArn = args[1];
String targetId = args[2];
CloudWatchEventsClient cwe = CloudWatchEventsClient.builder()
.build();
putCWTargets(cwe, ruleName, functionArn, targetId);
cwe.close();
}
public static void putCWTargets(CloudWatchEventsClient cwe, String ruleName, String functionArn, String targetId) {
try {
Target target = Target.builder()
.arn(functionArn)
.id(targetId)
.build();
PutTargetsRequest request = PutTargetsRequest.builder()
.targets(target)
.rule(ruleName)
.build();
cwe.putTargets(request);
System.out.printf(
"Successfully created CloudWatch events target for rule %s",
ruleName);
} catch (CloudWatchException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ 如需 API 的詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [PutTargets](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/PutTargets)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cloudwatch-events#code-examples)中設定和執行。
匯入 SDK 和用戶端模組，然後呼叫 API。
```
import { PutTargetsCommand } from "@aws-sdk/client-cloudwatch-events";
import { client } from "../libs/client.js";
const run = async () => {
const command = new PutTargetsCommand({
// The name of the Amazon CloudWatch Events rule.
Rule: process.env.CLOUDWATCH_EVENTS_RULE,
// The targets to add to the rule.
Targets: [
{
Arn: process.env.CLOUDWATCH_EVENTS_TARGET_ARN,
// The ID of the target. Choose a unique ID for each target.
Id: process.env.CLOUDWATCH_EVENTS_TARGET_ID,
},
],
});
try {
return await client.send(command);
} catch (err) {
console.error(err);
}
};
export default run();
```
在單獨的模組中建立用戶端並將其匯出。
```
import { CloudWatchEventsClient } from "@aws-sdk/client-cloudwatch-events";
export const client = new CloudWatchEventsClient({});
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/cloudwatch-examples-sending-events.html#cloudwatch-examples-sending-events-targets)》。
+ 如需 API 的詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [PutTargets](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudwatch-events/command/PutTargetsCommand)。
**適用於 JavaScript (v2) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascript/example_code/cloudwatch-events#code-examples)中設定和執行。
```
// Load the AWS SDK for Node.js
var AWS = require("aws-sdk");
// Set the region
AWS.config.update({ region: "REGION" });
// Create CloudWatchEvents service object
var cwevents = new AWS.CloudWatchEvents({ apiVersion: "2015-10-07" });
var params = {
Rule: "DEMO_EVENT",
Targets: [
{
Arn: "LAMBDA_FUNCTION_ARN",
Id: "myCloudWatchEventsTarget",
},
],
};
cwevents.putTargets(params, function (err, data) {
if (err) {
console.log("Error", err);
} else {
console.log("Success", data);
}
});
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/cloudwatch-examples-sending-events.html#cloudwatch-examples-sending-events-targets)》。
+ 如需 API 的詳細資訊，請參閱 *適用於 JavaScript 的 AWS SDK API 參考*中的 [PutTargets](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/monitoring-2010-08-01/PutTargets)。
------