There are more AWS SDK examples available in the [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub repo.
# Code examples for EventBridge using AWS SDKs
buses = response.eventBuses();
for (EventBus bus : buses) {
System.out.println("The name of the event bus is: " + bus.name());
System.out.println("The ARN of the event bus is: " + bus.arn());
}
} catch (EventBridgeException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ For API details, see [ListEventBuses](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListEventBuses) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/eventbridge#code-examples).
```
import aws.sdk.kotlin.services.eventbridge.EventBridgeClient
import aws.sdk.kotlin.services.eventbridge.model.ListEventBusesRequest
import aws.sdk.kotlin.services.eventbridge.model.ListEventBusesResponse
suspend fun main() {
listBusesHello()
}
suspend fun listBusesHello() {
val request =
ListEventBusesRequest {
limit = 10
}
EventBridgeClient.fromEnvironment { region = "us-west-2" }.use { eventBrClient ->
val response: ListEventBusesResponse = eventBrClient.listEventBuses(request)
response.eventBuses?.forEach { bus ->
println("The name of the event bus is ${bus.name}")
println("The ARN of the event bus is ${bus.arn}")
}
}
}
```
+ For API details, see [ListEventBuses](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
# Learn the basics of EventBridge with an AWS SDK
("Microsoft", LogLevel.Information)
.AddFilter("Microsoft", LogLevel.Trace))
.ConfigureServices((_, services) =>
services.AddAWSService()
.AddAWSService()
.AddAWSService()
.AddAWSService()
.AddTransient()
)
.Build();
_configuration = new ConfigurationBuilder()
.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile("settings.json") // Load settings from .json file.
.AddJsonFile("settings.local.json",
true) // Optionally, load local settings.
.Build();
logger = LoggerFactory.Create(builder => { builder.AddConsole(); })
.CreateLogger();
ServicesSetup(host);
string topicArn = "";
string roleArn = "";
Console.WriteLine(new string('-', 80));
Console.WriteLine("Welcome to the Amazon EventBridge example scenario.");
Console.WriteLine(new string('-', 80));
try
{
roleArn = await CreateRole();
await CreateBucketWithEventBridgeEvents();
await AddEventRule(roleArn);
await ListEventRules();
topicArn = await CreateSnsTopic();
var email = await SubscribeToSnsTopic(topicArn);
await AddSnsTarget(topicArn);
await ListTargets();
await ListRulesForTarget(topicArn);
await UploadS3File(_s3Client);
await ChangeRuleState(false);
await GetRuleState();
await UpdateSnsEventRule(topicArn);
await ChangeRuleState(true);
await UploadS3File(_s3Client);
await UpdateToCustomRule(topicArn);
await TriggerCustomRule(email);
await CleanupResources(topicArn);
}
catch (Exception ex)
{
logger.LogError(ex, "There was a problem executing the scenario.");
await CleanupResources(topicArn);
}
Console.WriteLine(new string('-', 80));
Console.WriteLine("The Amazon EventBridge example scenario is complete.");
Console.WriteLine(new string('-', 80));
}
///
/// Populate the services for use within the console application.
///
/// ();
_snsClient = host.Services.GetRequiredService();
_s3Client = host.Services.GetRequiredService();
_iamClient = host.Services.GetRequiredService();
}
///
/// Create a role to be used by EventBridge.
///
/// The role Amazon Resource Name (ARN).
public static async Task CreateRole()
{
Console.WriteLine(new string('-', 80));
Console.WriteLine("Creating a role to use with EventBridge and attaching managed policy AmazonEventBridgeFullAccess.");
Console.WriteLine(new string('-', 80));
var roleName = _configuration["roleName"];
var assumeRolePolicy = "{" +
"\"Version\": \"2012-10-17\"," +
"\"Statement\": [{" +
"\"Effect\": \"Allow\"," +
"\"Principal\": {" +
$"\"Service\": \"events.amazonaws.com\"" +
"}," +
"\"Action\": \"sts:AssumeRole\"" +
"}]" +
"}";
var roleResult = await _iamClient!.CreateRoleAsync(
new CreateRoleRequest()
{
AssumeRolePolicyDocument = assumeRolePolicy,
Path = "/",
RoleName = roleName
});
await _iamClient.AttachRolePolicyAsync(
new AttachRolePolicyRequest()
{
PolicyArn = "arn:aws:iam::aws:policy/AmazonEventBridgeFullAccess",
RoleName = roleName
});
// Allow time for the role to be ready.
Thread.Sleep(10000);
return roleResult.Role.Arn;
}
///
/// Create an Amazon Simple Storage Service (Amazon S3) bucket with EventBridge events enabled.
///
/// Async task.
private static async Task CreateBucketWithEventBridgeEvents()
{
Console.WriteLine(new string('-', 80));
Console.WriteLine("Creating an S3 bucket with EventBridge events enabled.");
var testBucketName = _configuration["testBucketName"];
var bucketExists = await Amazon.S3.Util.AmazonS3Util.DoesS3BucketExistV2Async(_s3Client,
testBucketName);
if (!bucketExists)
{
await _s3Client.PutBucketAsync(new PutBucketRequest()
{
BucketName = testBucketName,
UseClientRegion = true
});
}
await _s3Client.PutBucketNotificationAsync(new PutBucketNotificationRequest()
{
BucketName = testBucketName,
EventBridgeConfiguration = new EventBridgeConfiguration()
});
Console.WriteLine($"\tAdded bucket {testBucketName} with EventBridge events enabled.");
Console.WriteLine(new string('-', 80));
}
///
/// Create and upload a file to an S3 bucket to trigger an event.
///
/// Async task.
private static async Task UploadS3File(IAmazonS3 s3Client)
{
Console.WriteLine(new string('-', 80));
Console.WriteLine("Uploading a file to the test bucket. This will trigger a subscription email.");
var testBucketName = _configuration["testBucketName"];
var fileName = $"example_upload_{DateTime.UtcNow.Ticks}.txt";
// Create the file if it does not already exist.
if (!File.Exists(fileName))
{
await using StreamWriter sw = File.CreateText(fileName);
await sw.WriteLineAsync(
"This is a sample file for testing uploads.");
}
await s3Client.PutObjectAsync(new PutObjectRequest()
{
FilePath = fileName,
BucketName = testBucketName
});
Console.WriteLine($"\tPress Enter to continue.");
Console.ReadLine();
Console.WriteLine(new string('-', 80));
}
///
/// Create an Amazon Simple Notification Service (Amazon SNS) topic to use as an EventBridge target.
///
/// Async task.
private static async Task CreateSnsTopic()
{
Console.WriteLine(new string('-', 80));
Console.WriteLine(
"Creating an Amazon Simple Notification Service (Amazon SNS) topic for email subscriptions.");
var topicName = _configuration["topicName"];
string topicPolicy = "{" +
"\"Version\": \"2012-10-17\"," +
"\"Statement\": [{" +
"\"Sid\": \"EventBridgePublishTopic\"," +
"\"Effect\": \"Allow\"," +
"\"Principal\": {" +
$"\"Service\": \"events.amazonaws.com\"" +
"}," +
"\"Resource\": \"*\"," +
"\"Action\": \"sns:Publish\"" +
"}]" +
"}";
var topicAttributes = new Dictionary()
{
{ "Policy", topicPolicy }
};
var topicResponse = await _snsClient!.CreateTopicAsync(new CreateTopicRequest()
{
Name = topicName,
Attributes = topicAttributes
});
Console.WriteLine($"\tAdded topic {topicName} for email subscriptions.");
Console.WriteLine(new string('-', 80));
return topicResponse.TopicArn;
}
///
/// Subscribe a user email to an SNS topic.
///
/// The user's email.
private static async Task SubscribeToSnsTopic(string topicArn)
{
Console.WriteLine(new string('-', 80));
string email = "";
while (string.IsNullOrEmpty(email))
{
Console.WriteLine("Enter your email to subscribe to the Amazon SNS topic:");
email = Console.ReadLine()!;
}
var subscriptions = new List();
var paginatedSubscriptions = _snsClient!.Paginators.ListSubscriptionsByTopic(
new ListSubscriptionsByTopicRequest()
{
TopicArn = topicArn
});
// Get the entire list using the paginator.
await foreach (var subscription in paginatedSubscriptions.Subscriptions)
{
subscriptions.Add(subscription.Endpoint);
}
if (subscriptions.Contains(email))
{
Console.WriteLine($"\tYour email is already subscribed.");
Console.WriteLine(new string('-', 80));
return email;
}
await _snsClient.SubscribeAsync(new SubscribeRequest()
{
TopicArn = topicArn,
Protocol = "email",
Endpoint = email
});
Console.WriteLine($"Use the link in the email you received to confirm your subscription, then press Enter to continue.");
Console.ReadLine();
Console.WriteLine(new string('-', 80));
return email;
}
///
/// Add a rule which triggers when a file is uploaded to an S3 bucket.
///
/// Async task.
private static async Task AddEventRule(string roleArn)
{
Console.WriteLine(new string('-', 80));
Console.WriteLine("Creating an EventBridge event that sends an email when an Amazon S3 object is created.");
var eventRuleName = _configuration["eventRuleName"];
var testBucketName = _configuration["testBucketName"];
await _eventBridgeWrapper.PutS3UploadRule(roleArn, eventRuleName, testBucketName);
Console.WriteLine($"\tAdded event rule {eventRuleName} for bucket {testBucketName}.");
Console.WriteLine(new string('-', 80));
}
///
/// Add an SNS target to the rule.
///
/// Async task.
private static async Task AddSnsTarget(string topicArn)
{
Console.WriteLine(new string('-', 80));
Console.WriteLine("Adding a target to the rule to that sends an email when the rule is triggered.");
var eventRuleName = _configuration["eventRuleName"];
var testBucketName = _configuration["testBucketName"];
var topicName = _configuration["topicName"];
await _eventBridgeWrapper.AddSnsTargetToRule(eventRuleName, topicArn);
Console.WriteLine($"\tAdded event rule {eventRuleName} with Amazon SNS target {topicName} for bucket {testBucketName}.");
Console.WriteLine(new string('-', 80));
}
///
/// List the event rules on the default event bus.
///
/// Async task.
private static async Task ListEventRules()
{
Console.WriteLine(new string('-', 80));
Console.WriteLine("Current event rules:");
var rules = await _eventBridgeWrapper.ListAllRulesForEventBus();
rules.ForEach(r => Console.WriteLine($"\tRule: {r.Name} Description: {r.Description} State: {r.State}"));
Console.WriteLine(new string('-', 80));
}
///
/// Update the event target to use a transform.
///
/// Async task.
private static async Task UpdateSnsEventRule(string topicArn)
{
Console.WriteLine(new string('-', 80));
Console.WriteLine("Let's update the event target with a transform.");
var eventRuleName = _configuration["eventRuleName"];
var testBucketName = _configuration["testBucketName"];
await _eventBridgeWrapper.UpdateS3UploadRuleTargetWithTransform(eventRuleName, topicArn);
Console.WriteLine($"\tUpdated event rule {eventRuleName} with Amazon SNS target {topicArn} for bucket {testBucketName}.");
Console.WriteLine(new string('-', 80));
}
///
/// Update the rule to use a custom event pattern.
///
/// Async task.
private static async Task UpdateToCustomRule(string topicArn)
{
Console.WriteLine(new string('-', 80));
Console.WriteLine("Updating the event pattern to be triggered by a custom event instead.");
var eventRuleName = _configuration["eventRuleName"];
await _eventBridgeWrapper.UpdateCustomEventPattern(eventRuleName);
Console.WriteLine($"\tUpdated event rule {eventRuleName} to custom pattern.");
await _eventBridgeWrapper.UpdateCustomRuleTargetWithTransform(eventRuleName,
topicArn);
Console.WriteLine($"\tUpdated event target {topicArn}.");
Console.WriteLine(new string('-', 80));
}
///
/// Send rule events for a custom rule using the user's email address.
///
/// Async task.
private static async Task TriggerCustomRule(string email)
{
Console.WriteLine(new string('-', 80));
Console.WriteLine("Sending an event to trigger the rule. This will trigger a subscription email.");
await _eventBridgeWrapper.PutCustomEmailEvent(email);
Console.WriteLine($"\tEvents have been sent. Press Enter to continue.");
Console.ReadLine();
Console.WriteLine(new string('-', 80));
}
///
/// List all of the targets for a rule.
///
/// Async task.
private static async Task ListTargets()
{
Console.WriteLine(new string('-', 80));
Console.WriteLine("List all of the targets for a particular rule.");
var eventRuleName = _configuration["eventRuleName"];
var targets = await _eventBridgeWrapper.ListAllTargetsOnRule(eventRuleName);
targets.ForEach(t => Console.WriteLine($"\tTarget: {t.Arn} Id: {t.Id} Input: {t.Input}"));
Console.WriteLine(new string('-', 80));
}
///
/// List all of the rules for a particular target.
///
/// Async task.
private static async Task ListRulesForTarget(string topicArn)
{
Console.WriteLine(new string('-', 80));
Console.WriteLine("List all of the rules for a particular target.");
var rules = await _eventBridgeWrapper.ListAllRuleNamesByTarget(topicArn);
rules.ForEach(r => Console.WriteLine($"\tRule: {r}"));
Console.WriteLine(new string('-', 80));
}
///
/// Enable or disable a particular rule.
///
/// Async task.
private static async Task ChangeRuleState(bool isEnabled)
{
Console.WriteLine(new string('-', 80));
var eventRuleName = _configuration["eventRuleName"];
if (!isEnabled)
{
Console.WriteLine($"Disabling the rule: {eventRuleName}");
await _eventBridgeWrapper.DisableRuleByName(eventRuleName);
}
else
{
Console.WriteLine($"Enabling the rule: {eventRuleName}");
await _eventBridgeWrapper.EnableRuleByName(eventRuleName);
}
Console.WriteLine(new string('-', 80));
}
///
/// Get the current state of the rule.
///
/// Async task.
private static async Task GetRuleState()
{
Console.WriteLine(new string('-', 80));
var eventRuleName = _configuration["eventRuleName"];
var state = await _eventBridgeWrapper.GetRuleStateByRuleName(eventRuleName);
Console.WriteLine($"Rule {eventRuleName} is in current state {state}.");
Console.WriteLine(new string('-', 80));
}
///
/// Clean up the resources from the scenario.
///
/// Async task.
private static async Task CleanupResources(string topicArn)
{
Console.WriteLine(new string('-', 80));
Console.WriteLine($"Clean up resources.");
var eventRuleName = _configuration["eventRuleName"];
if (GetYesNoResponse($"\tDelete all targets and event rule {eventRuleName}? (y/n)"))
{
Console.WriteLine($"\tRemoving all targets from the event rule.");
await _eventBridgeWrapper.RemoveAllTargetsFromRule(eventRuleName);
Console.WriteLine($"\tDeleting event rule.");
await _eventBridgeWrapper.DeleteRuleByName(eventRuleName);
}
var topicName = _configuration["topicName"];
if (GetYesNoResponse($"\tDelete Amazon SNS subscription topic {topicName}? (y/n)"))
{
Console.WriteLine($"\tDeleting topic.");
await _snsClient!.DeleteTopicAsync(new DeleteTopicRequest()
{
TopicArn = topicArn
});
}
var bucketName = _configuration["testBucketName"];
if (GetYesNoResponse($"\tDelete Amazon S3 bucket {bucketName}? (y/n)"))
{
Console.WriteLine($"\tDeleting bucket.");
// Delete all objects in the bucket.
var deleteList = await _s3Client.ListObjectsV2Async(new ListObjectsV2Request()
{
BucketName = bucketName
});
await _s3Client.DeleteObjectsAsync(new DeleteObjectsRequest()
{
BucketName = bucketName,
Objects = deleteList.S3Objects
.Select(o => new KeyVersion { Key = o.Key }).ToList()
});
// Now delete the bucket.
await _s3Client.DeleteBucketAsync(new DeleteBucketRequest()
{
BucketName = bucketName
});
}
var roleName = _configuration["roleName"];
if (GetYesNoResponse($"\tDelete role {roleName}? (y/n)"))
{
Console.WriteLine($"\tDetaching policy and deleting role.");
await _iamClient!.DetachRolePolicyAsync(new DetachRolePolicyRequest()
{
RoleName = roleName,
PolicyArn = "arn:aws:iam::aws:policy/AmazonEventBridgeFullAccess",
});
await _iamClient!.DeleteRoleAsync(new DeleteRoleRequest()
{
RoleName = roleName
});
}
Console.WriteLine(new string('-', 80));
}
///
/// Helper method to get a yes or no response from the user.
///
/// True if the user responds with a yes.
private static bool GetYesNoResponse(string question)
{
Console.WriteLine(question);
var ynResponse = Console.ReadLine();
var response = ynResponse != null &&
ynResponse.Equals("y",
StringComparison.InvariantCultureIgnoreCase);
return response;
}
}
```
Create a class that wraps EventBridge operations.
```
///
/// Wrapper for Amazon EventBridge operations.
///
public class EventBridgeWrapper
{
private readonly IAmazonEventBridge _amazonEventBridge;
private readonly ILogger _logger;
///
/// Constructor for the EventBridge wrapper.
///
/// logger)
{
_amazonEventBridge = amazonEventBridge;
_logger = logger;
}
///
/// Get the state for a rule by the rule name.
///
/// The state of the rule.
public async Task GetRuleStateByRuleName(string ruleName, string? eventBusName = null)
{
var ruleResponse = await _amazonEventBridge.DescribeRuleAsync(
new DescribeRuleRequest()
{
Name = ruleName,
EventBusName = eventBusName
});
return ruleResponse.State;
}
///
/// Enable a particular rule on an event bus.
///
/// True if successful.
public async Task EnableRuleByName(string ruleName)
{
var ruleResponse = await _amazonEventBridge.EnableRuleAsync(
new EnableRuleRequest()
{
Name = ruleName
});
return ruleResponse.HttpStatusCode == HttpStatusCode.OK;
}
///
/// Disable a particular rule on an event bus.
/// The name of the rule.
/// True if successful.
public async Task DisableRuleByName(string ruleName)
{
var ruleResponse = await _amazonEventBridge.DisableRuleAsync(
new DisableRuleRequest()
{
Name = ruleName
});
return ruleResponse.HttpStatusCode == HttpStatusCode.OK;
}
///
/// List the rules on an event bus.
///
/// The list of rules.
public async Task> ListAllRulesForEventBus(string? eventBusArn = null)
{
var results = new List();
var request = new ListRulesRequest()
{
EventBusName = eventBusArn
};
// Get all of the pages of rules.
ListRulesResponse response;
do
{
response = await _amazonEventBridge.ListRulesAsync(request);
results.AddRange(response.Rules);
request.NextToken = response.NextToken;
} while (response.NextToken is not null);
return results;
}
///
/// List all of the targets matching a rule by name.
///
/// The list of targets.
public async Task> ListAllTargetsOnRule(string ruleName)
{
var results = new List();
var request = new ListTargetsByRuleRequest()
{
Rule = ruleName
};
ListTargetsByRuleResponse response;
do
{
response = await _amazonEventBridge.ListTargetsByRuleAsync(request);
results.AddRange(response.Targets);
request.NextToken = response.NextToken;
} while (response.NextToken is not null);
return results;
}
///
/// List names of all rules matching a target.
///
/// The list of rule names.
public async Task> ListAllRuleNamesByTarget(string targetArn)
{
var results = new List();
var request = new ListRuleNamesByTargetRequest()
{
TargetArn = targetArn
};
ListRuleNamesByTargetResponse response;
do
{
response = await _amazonEventBridge.ListRuleNamesByTargetAsync(request);
results.AddRange(response.RuleNames);
request.NextToken = response.NextToken;
} while (response.NextToken is not null);
return results;
}
///
/// Create a new event rule that triggers when an Amazon S3 object is created in a bucket.
///
/// The ARN of the new rule.
public async Task PutS3UploadRule(string roleArn, string ruleName, string bucketName)
{
string eventPattern = "{" +
"\"source\": [\"aws.s3\"]," +
"\"detail-type\": [\"Object Created\"]," +
"\"detail\": {" +
"\"bucket\": {" +
"\"name\": [\"" + bucketName + "\"]" +
"}" +
"}" +
"}";
var response = await _amazonEventBridge.PutRuleAsync(
new PutRuleRequest()
{
Name = ruleName,
Description = "Example S3 upload rule for EventBridge",
RoleArn = roleArn,
EventPattern = eventPattern
});
return response.RuleArn;
}
///
/// Update an Amazon S3 object created rule with a transform on the target.
///
/// The ID of the target.
public async Task UpdateS3UploadRuleTargetWithTransform(string ruleName, string targetArn, string? eventBusArn = null)
{
var targetID = Guid.NewGuid().ToString();
var targets = new List
{
new Target()
{
Id = targetID,
Arn = targetArn,
InputTransformer = new InputTransformer()
{
InputPathsMap = new Dictionary()
{
{"bucket", "$.detail.bucket.name"},
{"time", "$.time"}
},
InputTemplate = "\"Notification: an object was uploaded to bucket at .\""
}
}
};
var response = await _amazonEventBridge.PutTargetsAsync(
new PutTargetsRequest()
{
EventBusName = eventBusArn,
Rule = ruleName,
Targets = targets,
});
if (response.FailedEntryCount > 0)
{
response.FailedEntries.ForEach(e =>
{
_logger.LogError(
$"Failed to add target {e.TargetId}: {e.ErrorMessage}, code {e.ErrorCode}");
});
}
return targetID;
}
///
/// Update a custom rule with a transform on the target.
///
/// The ID of the target.
public async Task UpdateCustomRuleTargetWithTransform(string ruleName, string targetArn, string? eventBusArn = null)
{
var targetID = Guid.NewGuid().ToString();
var targets = new List
{
new Target()
{
Id = targetID,
Arn = targetArn,
InputTransformer = new InputTransformer()
{
InputTemplate = "\"Notification: sample event was received.\""
}
}
};
var response = await _amazonEventBridge.PutTargetsAsync(
new PutTargetsRequest()
{
EventBusName = eventBusArn,
Rule = ruleName,
Targets = targets,
});
if (response.FailedEntryCount > 0)
{
response.FailedEntries.ForEach(e =>
{
_logger.LogError(
$"Failed to add target {e.TargetId}: {e.ErrorMessage}, code {e.ErrorCode}");
});
}
return targetID;
}
///
/// Add an event to the event bus that includes an email, message, and time.
///
/// True if successful.
public async Task PutCustomEmailEvent(string email)
{
var eventDetail = new
{
UserEmail = email,
Message = "This event was generated by example code.",
UtcTime = DateTime.UtcNow.ToString("g")
};
var response = await _amazonEventBridge.PutEventsAsync(
new PutEventsRequest()
{
Entries = new List()
{
new PutEventsRequestEntry()
{
Source = "ExampleSource",
Detail = JsonSerializer.Serialize(eventDetail),
DetailType = "ExampleType"
}
}
});
return response.FailedEntryCount == 0;
}
///
/// Update a rule to use a custom defined event pattern.
///
/// The ARN of the updated rule.
public async Task UpdateCustomEventPattern(string ruleName)
{
string customEventsPattern = "{" +
"\"source\": [\"ExampleSource\"]," +
"\"detail-type\": [\"ExampleType\"]" +
"}";
var response = await _amazonEventBridge.PutRuleAsync(
new PutRuleRequest()
{
Name = ruleName,
Description = "Custom test rule",
EventPattern = customEventsPattern
});
return response.RuleArn;
}
///
/// Add an Amazon SNS target topic to a rule.
///
/// The ID of the target.
public async Task AddSnsTargetToRule(string ruleName, string targetArn, string? eventBusArn = null)
{
var targetID = Guid.NewGuid().ToString();
// Create the list of targets and add a new target.
var targets = new List
{
new Target()
{
Arn = targetArn,
Id = targetID
}
};
// Add the targets to the rule.
var response = await _amazonEventBridge.PutTargetsAsync(
new PutTargetsRequest()
{
EventBusName = eventBusArn,
Rule = ruleName,
Targets = targets,
});
if (response.FailedEntryCount > 0)
{
response.FailedEntries.ForEach(e =>
{
_logger.LogError(
$"Failed to add target {e.TargetId}: {e.ErrorMessage}, code {e.ErrorCode}");
});
}
return targetID;
}
///
/// Delete an event rule by name.
///
/// True if successful.
public async Task RemoveAllTargetsFromRule(string ruleName)
{
var targetIds = new List();
var request = new ListTargetsByRuleRequest()
{
Rule = ruleName
};
ListTargetsByRuleResponse targetsResponse;
do
{
targetsResponse = await _amazonEventBridge.ListTargetsByRuleAsync(request);
targetIds.AddRange(targetsResponse.Targets.Select(t => t.Id));
request.NextToken = targetsResponse.NextToken;
} while (targetsResponse.NextToken is not null);
var removeResponse = await _amazonEventBridge.RemoveTargetsAsync(
new RemoveTargetsRequest()
{
Rule = ruleName,
Ids = targetIds
});
if (removeResponse.FailedEntryCount > 0)
{
removeResponse.FailedEntries.ForEach(e =>
{
_logger.LogError(
$"Failed to remove target {e.TargetId}: {e.ErrorMessage}, code {e.ErrorCode}");
});
}
return removeResponse.HttpStatusCode == HttpStatusCode.OK;
}
///
/// Delete an event rule by name.
///
/// True if successful.
public async Task DeleteRuleByName(string ruleName)
{
var response = await _amazonEventBridge.DeleteRuleAsync(
new DeleteRuleRequest()
{
Name = ruleName
});
return response.HttpStatusCode == HttpStatusCode.OK;
}
}
```
+ For API details, see the following topics in *AWS SDK for .NET API Reference*.
+ [DeleteRule](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/DeleteRule)
+ [DescribeRule](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/DescribeRule)
+ [DisableRule](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/DisableRule)
+ [EnableRule](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/EnableRule)
+ [ListRuleNamesByTarget](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/ListRuleNamesByTarget)
+ [ListRules](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/ListRules)
+ [ListTargetsByRule](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/ListTargetsByRule)
+ [PutEvents](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/PutEvents)
+ [PutRule](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/PutRule)
+ [PutTargets](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/PutTargets)
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/eventbridge#code-examples).
```
/**
* 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
*
* This Java code example performs the following tasks:
*
* This Java V2 example performs the following tasks with Amazon EventBridge:
*
* 1. Creates an AWS Identity and Access Management (IAM) role to use with
* Amazon EventBridge.
* 2. Amazon Simple Storage Service (Amazon S3) bucket with EventBridge events
* enabled.
* 3. Creates a rule that triggers when an object is uploaded to Amazon S3.
* 4. Lists rules on the event bus.
* 5. Creates a new Amazon Simple Notification Service (Amazon SNS) topic and
* lets the user subscribe to it.
* 6. Adds a target to the rule that sends an email to the specified topic.
* 7. Creates an EventBridge event that sends an email when an Amazon S3 object
* is created.
* 8. Lists Targets.
* 9. Lists the rules for the same target.
* 10. Triggers the rule by uploading a file to the Amazon S3 bucket.
* 11. Disables a specific rule.
* 12. Checks and print the state of the rule.
* 13. Adds a transform to the rule to change the text of the email.
* 14. Enables a specific rule.
* 15. Triggers the updated rule by uploading a file to the Amazon S3 bucket.
* 16. Updates the rule to be a custom rule pattern.
* 17. Sending an event to trigger the rule.
* 18. Cleans up resources.
*
*/
public class EventbridgeMVP {
public static final String DASHES = new String(new char[80]).replace("\0", "-");
public static void main(String[] args) throws InterruptedException, IOException {
final String usage = """
Usage:
Where:
roleName - The name of the role to create.
bucketName - The Amazon Simple Storage Service (Amazon S3) bucket name to create.
topicName - The name of the Amazon Simple Notification Service (Amazon SNS) topic to create.
eventRuleName - The Amazon EventBridge rule name to create.
""";
if (args.length != 5) {
System.out.println(usage);
System.exit(1);
}
String polJSON = "{" +
"\"Version\": \"2012-10-17\"," +
"\"Statement\": [{" +
"\"Effect\": \"Allow\"," +
"\"Principal\": {" +
"\"Service\": \"events.amazonaws.com\"" +
"}," +
"\"Action\": \"sts:AssumeRole\"" +
"}]" +
"}";
Scanner sc = new Scanner(System.in);
String roleName = args[0];
String bucketName = args[1];
String topicName = args[2];
String eventRuleName = args[3];
Region region = Region.US_EAST_1;
EventBridgeClient eventBrClient = EventBridgeClient.builder()
.region(region)
.build();
S3Client s3Client = S3Client.builder()
.region(region)
.build();
Region regionGl = Region.AWS_GLOBAL;
IamClient iam = IamClient.builder()
.region(regionGl)
.build();
SnsClient snsClient = SnsClient.builder()
.region(region)
.build();
System.out.println(DASHES);
System.out.println("Welcome to the Amazon EventBridge example scenario.");
System.out.println(DASHES);
System.out.println(DASHES);
System.out
.println("1. Create an AWS Identity and Access Management (IAM) role to use with Amazon EventBridge.");
String roleArn = createIAMRole(iam, roleName, polJSON);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("2. Create an S3 bucket with EventBridge events enabled.");
if (checkBucket(s3Client, bucketName)) {
System.out.println("Bucket " + bucketName + " already exists. Ending this scenario.");
System.exit(1);
}
createBucket(s3Client, bucketName);
Thread.sleep(3000);
setBucketNotification(s3Client, bucketName);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("3. Create a rule that triggers when an object is uploaded to Amazon S3.");
Thread.sleep(10000);
addEventRule(eventBrClient, roleArn, bucketName, eventRuleName);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("4. List rules on the event bus.");
listRules(eventBrClient);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("5. Create a new SNS topic for testing and let the user subscribe to the topic.");
String topicArn = createSnsTopic(snsClient, topicName);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("6. Add a target to the rule that sends an email to the specified topic.");
System.out.println("Enter your email to subscribe to the Amazon SNS topic:");
String email = sc.nextLine();
subEmail(snsClient, topicArn, email);
System.out.println(
"Use the link in the email you received to confirm your subscription. Then, press Enter to continue.");
sc.nextLine();
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("7. Create an EventBridge event that sends an email when an Amazon S3 object is created.");
addSnsEventRule(eventBrClient, eventRuleName, topicArn, topicName, eventRuleName, bucketName);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println(" 8. List Targets.");
listTargets(eventBrClient, eventRuleName);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println(" 9. List the rules for the same target.");
listTargetRules(eventBrClient, topicArn);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println(" 10. Trigger the rule by uploading a file to the S3 bucket.");
System.out.println("Press Enter to continue.");
sc.nextLine();
uploadTextFiletoS3(s3Client, bucketName);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("11. Disable a specific rule.");
changeRuleState(eventBrClient, eventRuleName, false);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("12. Check and print the state of the rule.");
checkRule(eventBrClient, eventRuleName);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("13. Add a transform to the rule to change the text of the email.");
updateSnsEventRule(eventBrClient, topicArn, eventRuleName);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("14. Enable a specific rule.");
changeRuleState(eventBrClient, eventRuleName, true);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println(" 15. Trigger the updated rule by uploading a file to the S3 bucket.");
System.out.println("Press Enter to continue.");
sc.nextLine();
uploadTextFiletoS3(s3Client, bucketName);
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println(" 16. Update the rule to be a custom rule pattern.");
updateToCustomRule(eventBrClient, eventRuleName);
System.out.println("Updated event rule " + eventRuleName + " to use a custom pattern.");
updateCustomRuleTargetWithTransform(eventBrClient, topicArn, eventRuleName);
System.out.println("Updated event target " + topicArn + ".");
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("17. Sending an event to trigger the rule. This will trigger a subscription email.");
triggerCustomRule(eventBrClient, email);
System.out.println("Events have been sent. Press Enter to continue.");
sc.nextLine();
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("18. Clean up resources.");
System.out.println("Do you want to clean up resources (y/n)");
String ans = sc.nextLine();
if (ans.compareTo("y") == 0) {
cleanupResources(eventBrClient, snsClient, s3Client, iam, topicArn, eventRuleName, bucketName, roleName);
} else {
System.out.println("The resources will not be cleaned up. ");
}
System.out.println(DASHES);
System.out.println(DASHES);
System.out.println("The Amazon EventBridge example scenario has successfully completed.");
System.out.println(DASHES);
}
public static void cleanupResources(EventBridgeClient eventBrClient, SnsClient snsClient, S3Client s3Client,
IamClient iam, String topicArn, String eventRuleName, String bucketName, String roleName) {
System.out.println("Removing all targets from the event rule.");
deleteTargetsFromRule(eventBrClient, eventRuleName);
deleteRuleByName(eventBrClient, eventRuleName);
deleteSNSTopic(snsClient, topicArn);
deleteS3Bucket(s3Client, bucketName);
deleteRole(iam, roleName);
}
public static void deleteRole(IamClient iam, String roleName) {
String policyArn = "arn:aws:iam::aws:policy/AmazonEventBridgeFullAccess";
DetachRolePolicyRequest policyRequest = DetachRolePolicyRequest.builder()
.policyArn(policyArn)
.roleName(roleName)
.build();
iam.detachRolePolicy(policyRequest);
System.out.println("Successfully detached policy " + policyArn + " from role " + roleName);
// Delete the role.
DeleteRoleRequest roleRequest = DeleteRoleRequest.builder()
.roleName(roleName)
.build();
iam.deleteRole(roleRequest);
System.out.println("*** Successfully deleted " + roleName);
}
public static void deleteS3Bucket(S3Client s3Client, String bucketName) {
// Remove all the objects from the S3 bucket.
ListObjectsRequest listObjects = ListObjectsRequest.builder()
.bucket(bucketName)
.build();
ListObjectsResponse res = s3Client.listObjects(listObjects);
List objects = res.contents();
ArrayList toDelete = new ArrayList<>();
for (S3Object myValue : objects) {
toDelete.add(ObjectIdentifier.builder()
.key(myValue.key())
.build());
}
DeleteObjectsRequest dor = DeleteObjectsRequest.builder()
.bucket(bucketName)
.delete(Delete.builder()
.objects(toDelete).build())
.build();
s3Client.deleteObjects(dor);
// Delete the S3 bucket.
DeleteBucketRequest deleteBucketRequest = DeleteBucketRequest.builder()
.bucket(bucketName)
.build();
s3Client.deleteBucket(deleteBucketRequest);
System.out.println("You have deleted the bucket and the objects");
}
// Delete the SNS topic.
public static void deleteSNSTopic(SnsClient snsClient, String topicArn) {
try {
DeleteTopicRequest request = DeleteTopicRequest.builder()
.topicArn(topicArn)
.build();
DeleteTopicResponse result = snsClient.deleteTopic(request);
System.out.println("\n\nStatus was " + result.sdkHttpResponse().statusCode());
} catch (SnsException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
public static void deleteRuleByName(EventBridgeClient eventBrClient, String ruleName) {
DeleteRuleRequest ruleRequest = DeleteRuleRequest.builder()
.name(ruleName)
.build();
eventBrClient.deleteRule(ruleRequest);
System.out.println("Successfully deleted the rule");
}
public static void deleteTargetsFromRule(EventBridgeClient eventBrClient, String eventRuleName) {
// First, get all targets that will be deleted.
ListTargetsByRuleRequest request = ListTargetsByRuleRequest.builder()
.rule(eventRuleName)
.build();
ListTargetsByRuleResponse response = eventBrClient.listTargetsByRule(request);
List allTargets = response.targets();
// Get all targets and delete them.
for (Target myTarget : allTargets) {
RemoveTargetsRequest removeTargetsRequest = RemoveTargetsRequest.builder()
.rule(eventRuleName)
.ids(myTarget.id())
.build();
eventBrClient.removeTargets(removeTargetsRequest);
System.out.println("Successfully removed the target");
}
}
public static void triggerCustomRule(EventBridgeClient eventBrClient, String email) {
String json = "{" +
"\"UserEmail\": \"" + email + "\"," +
"\"Message\": \"This event was generated by example code.\"," +
"\"UtcTime\": \"Now.\"" +
"}";
PutEventsRequestEntry entry = PutEventsRequestEntry.builder()
.source("ExampleSource")
.detail(json)
.detailType("ExampleType")
.build();
PutEventsRequest eventsRequest = PutEventsRequest.builder()
.entries(entry)
.build();
eventBrClient.putEvents(eventsRequest);
}
public static void updateCustomRuleTargetWithTransform(EventBridgeClient eventBrClient, String topicArn,
String ruleName) {
String targetId = java.util.UUID.randomUUID().toString();
InputTransformer inputTransformer = InputTransformer.builder()
.inputTemplate("\"Notification: sample event was received.\"")
.build();
Target target = Target.builder()
.id(targetId)
.arn(topicArn)
.inputTransformer(inputTransformer)
.build();
try {
PutTargetsRequest targetsRequest = PutTargetsRequest.builder()
.rule(ruleName)
.targets(target)
.eventBusName(null)
.build();
eventBrClient.putTargets(targetsRequest);
} catch (EventBridgeException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
public static void updateToCustomRule(EventBridgeClient eventBrClient, String ruleName) {
String customEventsPattern = "{" +
"\"source\": [\"ExampleSource\"]," +
"\"detail-type\": [\"ExampleType\"]" +
"}";
PutRuleRequest request = PutRuleRequest.builder()
.name(ruleName)
.description("Custom test rule")
.eventPattern(customEventsPattern)
.build();
eventBrClient.putRule(request);
}
// Update an Amazon S3 object created rule with a transform on the target.
public static void updateSnsEventRule(EventBridgeClient eventBrClient, String topicArn, String ruleName) {
String targetId = java.util.UUID.randomUUID().toString();
Map myMap = new HashMap<>();
myMap.put("bucket", "$.detail.bucket.name");
myMap.put("time", "$.time");
InputTransformer inputTransformer = InputTransformer.builder()
.inputTemplate("\"Notification: an object was uploaded to bucket at .\"")
.inputPathsMap(myMap)
.build();
Target target = Target.builder()
.id(targetId)
.arn(topicArn)
.inputTransformer(inputTransformer)
.build();
try {
PutTargetsRequest targetsRequest = PutTargetsRequest.builder()
.rule(ruleName)
.targets(target)
.eventBusName(null)
.build();
eventBrClient.putTargets(targetsRequest);
} catch (EventBridgeException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
public static void checkRule(EventBridgeClient eventBrClient, String eventRuleName) {
try {
DescribeRuleRequest ruleRequest = DescribeRuleRequest.builder()
.name(eventRuleName)
.build();
DescribeRuleResponse response = eventBrClient.describeRule(ruleRequest);
System.out.println("The state of the rule is " + response.stateAsString());
} catch (EventBridgeException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
public static void changeRuleState(EventBridgeClient eventBrClient, String eventRuleName, Boolean isEnabled) {
try {
if (!isEnabled) {
System.out.println("Disabling the rule: " + eventRuleName);
DisableRuleRequest ruleRequest = DisableRuleRequest.builder()
.name(eventRuleName)
.build();
eventBrClient.disableRule(ruleRequest);
} else {
System.out.println("Enabling the rule: " + eventRuleName);
EnableRuleRequest ruleRequest = EnableRuleRequest.builder()
.name(eventRuleName)
.build();
eventBrClient.enableRule(ruleRequest);
}
} catch (EventBridgeException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
// Create and upload a file to an S3 bucket to trigger an event.
public static void uploadTextFiletoS3(S3Client s3Client, String bucketName) throws IOException {
// Create a unique file name.
String fileSuffix = new SimpleDateFormat("yyyyMMddHHmmss").format(new Date());
String fileName = "TextFile" + fileSuffix + ".txt";
File myFile = new File(fileName);
FileWriter fw = new FileWriter(myFile.getAbsoluteFile());
BufferedWriter bw = new BufferedWriter(fw);
bw.write("This is a sample file for testing uploads.");
bw.close();
try {
PutObjectRequest putOb = PutObjectRequest.builder()
.bucket(bucketName)
.key(fileName)
.build();
s3Client.putObject(putOb, RequestBody.fromFile(myFile));
} catch (S3Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
public static void listTargetRules(EventBridgeClient eventBrClient, String topicArn) {
ListRuleNamesByTargetRequest ruleNamesByTargetRequest = ListRuleNamesByTargetRequest.builder()
.targetArn(topicArn)
.build();
ListRuleNamesByTargetResponse response = eventBrClient.listRuleNamesByTarget(ruleNamesByTargetRequest);
List rules = response.ruleNames();
for (String rule : rules) {
System.out.println("The rule name is " + rule);
}
}
public static void listTargets(EventBridgeClient eventBrClient, String ruleName) {
ListTargetsByRuleRequest ruleRequest = ListTargetsByRuleRequest.builder()
.rule(ruleName)
.build();
ListTargetsByRuleResponse res = eventBrClient.listTargetsByRule(ruleRequest);
List targetsList = res.targets();
for (Target target: targetsList) {
System.out.println("Target ARN: "+target.arn());
}
}
// Add a rule which triggers an SNS target when a file is uploaded to an S3
// bucket.
public static void addSnsEventRule(EventBridgeClient eventBrClient, String ruleName, String topicArn,
String topicName, String eventRuleName, String bucketName) {
String targetID = java.util.UUID.randomUUID().toString();
Target myTarget = Target.builder()
.id(targetID)
.arn(topicArn)
.build();
List targets = new ArrayList<>();
targets.add(myTarget);
PutTargetsRequest request = PutTargetsRequest.builder()
.eventBusName(null)
.targets(targets)
.rule(ruleName)
.build();
eventBrClient.putTargets(request);
System.out.println("Added event rule " + eventRuleName + " with Amazon SNS target " + topicName + " for bucket "
+ bucketName + ".");
}
public static void subEmail(SnsClient snsClient, String topicArn, String email) {
try {
SubscribeRequest request = SubscribeRequest.builder()
.protocol("email")
.endpoint(email)
.returnSubscriptionArn(true)
.topicArn(topicArn)
.build();
SubscribeResponse result = snsClient.subscribe(request);
System.out.println("Subscription ARN: " + result.subscriptionArn() + "\n\n Status is "
+ result.sdkHttpResponse().statusCode());
} catch (SnsException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
public static void listRules(EventBridgeClient eventBrClient) {
try {
ListRulesRequest rulesRequest = ListRulesRequest.builder()
.eventBusName("default")
.limit(10)
.build();
ListRulesResponse response = eventBrClient.listRules(rulesRequest);
List rules = response.rules();
for (Rule rule : rules) {
System.out.println("The rule name is : " + rule.name());
System.out.println("The rule description is : " + rule.description());
System.out.println("The rule state is : " + rule.stateAsString());
}
} catch (EventBridgeException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
public static String createSnsTopic(SnsClient snsClient, String topicName) {
String topicPolicy = "{" +
"\"Version\": \"2012-10-17\"," +
"\"Statement\": [{" +
"\"Sid\": \"EventBridgePublishTopic\"," +
"\"Effect\": \"Allow\"," +
"\"Principal\": {" +
"\"Service\": \"events.amazonaws.com\"" +
"}," +
"\"Resource\": \"*\"," +
"\"Action\": \"sns:Publish\"" +
"}]" +
"}";
Map topicAttributes = new HashMap<>();
topicAttributes.put("Policy", topicPolicy);
CreateTopicRequest topicRequest = CreateTopicRequest.builder()
.name(topicName)
.attributes(topicAttributes)
.build();
CreateTopicResponse response = snsClient.createTopic(topicRequest);
System.out.println("Added topic " + topicName + " for email subscriptions.");
return response.topicArn();
}
// Create a new event rule that triggers when an Amazon S3 object is created in
// a bucket.
public static void addEventRule(EventBridgeClient eventBrClient, String roleArn, String bucketName,
String eventRuleName) {
String pattern = "{\n" +
" \"source\": [\"aws.s3\"],\n" +
" \"detail-type\": [\"Object Created\"],\n" +
" \"detail\": {\n" +
" \"bucket\": {\n" +
" \"name\": [\"" + bucketName + "\"]\n" +
" }\n" +
" }\n" +
"}";
try {
PutRuleRequest ruleRequest = PutRuleRequest.builder()
.description("Created by using the AWS SDK for Java v2")
.name(eventRuleName)
.eventPattern(pattern)
.roleArn(roleArn)
.build();
PutRuleResponse ruleResponse = eventBrClient.putRule(ruleRequest);
System.out.println("The ARN of the new rule is " + ruleResponse.ruleArn());
} catch (EventBridgeException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
// Determine if the S3 bucket exists.
public static Boolean checkBucket(S3Client s3Client, String bucketName) {
try {
HeadBucketRequest headBucketRequest = HeadBucketRequest.builder()
.bucket(bucketName)
.build();
s3Client.headBucket(headBucketRequest);
return true;
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
}
return false;
}
// Set the S3 bucket notification configuration.
public static void setBucketNotification(S3Client s3Client, String bucketName) {
try {
EventBridgeConfiguration eventBridgeConfiguration = EventBridgeConfiguration.builder()
.build();
NotificationConfiguration configuration = NotificationConfiguration.builder()
.eventBridgeConfiguration(eventBridgeConfiguration)
.build();
PutBucketNotificationConfigurationRequest configurationRequest = PutBucketNotificationConfigurationRequest
.builder()
.bucket(bucketName)
.notificationConfiguration(configuration)
.skipDestinationValidation(true)
.build();
s3Client.putBucketNotificationConfiguration(configurationRequest);
System.out.println("Added bucket " + bucketName + " with EventBridge events enabled.");
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
public static void createBucket(S3Client s3Client, String bucketName) {
try {
S3Waiter s3Waiter = s3Client.waiter();
CreateBucketRequest bucketRequest = CreateBucketRequest.builder()
.bucket(bucketName)
.build();
s3Client.createBucket(bucketRequest);
HeadBucketRequest bucketRequestWait = HeadBucketRequest.builder()
.bucket(bucketName)
.build();
// Wait until the bucket is created and print out the response.
WaiterResponse waiterResponse = s3Waiter.waitUntilBucketExists(bucketRequestWait);
waiterResponse.matched().response().ifPresent(System.out::println);
System.out.println(bucketName + " is ready");
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
public static String createIAMRole(IamClient iam, String rolename, String polJSON) {
try {
CreateRoleRequest request = CreateRoleRequest.builder()
.roleName(rolename)
.assumeRolePolicyDocument(polJSON)
.description("Created using the AWS SDK for Java")
.build();
CreateRoleResponse response = iam.createRole(request);
AttachRolePolicyRequest rolePolicyRequest = AttachRolePolicyRequest.builder()
.roleName(rolename)
.policyArn("arn:aws:iam::aws:policy/AmazonEventBridgeFullAccess")
.build();
iam.attachRolePolicy(rolePolicyRequest);
return response.role().arn();
} catch (IamException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return "";
}
}
```
+ For API details, see the following topics in *AWS SDK for Java 2.x API Reference*.
+ [DeleteRule](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DeleteRule)
+ [DescribeRule](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DescribeRule)
+ [DisableRule](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DisableRule)
+ [EnableRule](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/EnableRule)
+ [ListRuleNamesByTarget](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListRuleNamesByTarget)
+ [ListRules](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListRules)
+ [ListTargetsByRule](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListTargetsByRule)
+ [PutEvents](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/PutEvents)
+ [PutRule](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/PutRule)
+ [PutTargets](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/PutTargets)
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/eventbridge#code-examples).
```
/*
Before running this Kotlin 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-kotlin/latest/developer-guide/setup.html
This Kotlin example performs the following tasks with Amazon EventBridge:
1. Creates an AWS Identity and Access Management (IAM) role to use with Amazon EventBridge.
2. Creates an Amazon Simple Storage Service (Amazon S3) bucket with EventBridge events enabled.
3. Creates a rule that triggers when an object is uploaded to Amazon S3.
4. Lists rules on the event bus.
5. Creates a new Amazon Simple Notification Service (Amazon SNS) topic and lets the user subscribe to it.
6. Adds a target to the rule that sends an email to the specified topic.
7. Creates an EventBridge event that sends an email when an Amazon S3 object is created.
8. Lists targets.
9. Lists the rules for the same target.
10. Triggers the rule by uploading a file to the S3 bucket.
11. Disables a specific rule.
12. Checks and prints the state of the rule.
13. Adds a transform to the rule to change the text of the email.
14. Enables a specific rule.
15. Triggers the updated rule by uploading a file to the S3 bucket.
16. Updates the rule to a custom rule pattern.
17. Sends an event to trigger the rule.
18. Cleans up resources.
*/
val DASHES: String = String(CharArray(80)).replace("\u0000", "-")
suspend fun main(args: Array) {
val usage = """
Usage:
Where:
roleName - The name of the role to create.
bucketName - The Amazon Simple Storage Service (Amazon S3) bucket name to create.
topicName - The name of the Amazon Simple Notification Service (Amazon SNS) topic to create.
eventRuleName - The Amazon EventBridge rule name to create.
"""
val polJSON =
"{" +
"\"Version\": \"2012-10-17\"," +
"\"Statement\": [{" +
"\"Effect\": \"Allow\"," +
"\"Principal\": {" +
"\"Service\": \"events.amazonaws.com\"" +
"}," +
"\"Action\": \"sts:AssumeRole\"" +
"}]" +
"}"
if (args.size != 4) {
println(usage)
exitProcess(1)
}
val sc = Scanner(System.`in`)
val roleName = args[0]
val bucketName = args[1]
val topicName = args[2]
val eventRuleName = args[3]
println(DASHES)
println("Welcome to the Amazon EventBridge example scenario.")
println(DASHES)
println(DASHES)
println("1. Create an AWS Identity and Access Management (IAM) role to use with Amazon EventBridge.")
val roleArn = createIAMRole(roleName, polJSON)
println(DASHES)
println(DASHES)
println("2. Create an S3 bucket with EventBridge events enabled.")
if (checkBucket(bucketName)) {
println("$bucketName already exists. Ending this scenario.")
exitProcess(1)
}
createBucket(bucketName)
delay(3000)
setBucketNotification(bucketName)
println(DASHES)
println(DASHES)
println("3. Create a rule that triggers when an object is uploaded to Amazon S3.")
delay(10000)
addEventRule(roleArn, bucketName, eventRuleName)
println(DASHES)
println(DASHES)
println("4. List rules on the event bus.")
listRules()
println(DASHES)
println(DASHES)
println("5. Create a new SNS topic for testing and let the user subscribe to the topic.")
val topicArn = createSnsTopic(topicName)
println(DASHES)
println(DASHES)
println("6. Add a target to the rule that sends an email to the specified topic.")
println("Enter your email to subscribe to the Amazon SNS topic:")
val email = sc.nextLine()
subEmail(topicArn, email)
println("Use the link in the email you received to confirm your subscription. Then press Enter to continue.")
sc.nextLine()
println(DASHES)
println(DASHES)
println("7. Create an EventBridge event that sends an email when an Amazon S3 object is created.")
addSnsEventRule(eventRuleName, topicArn, topicName, eventRuleName, bucketName)
println(DASHES)
println(DASHES)
println("8. List targets.")
listTargets(eventRuleName)
println(DASHES)
println(DASHES)
println(" 9. List the rules for the same target.")
listTargetRules(topicArn)
println(DASHES)
println(DASHES)
println("10. Trigger the rule by uploading a file to the S3 bucket.")
println("Press Enter to continue.")
sc.nextLine()
uploadTextFiletoS3(bucketName)
println(DASHES)
println(DASHES)
println("11. Disable a specific rule.")
changeRuleState(eventRuleName, false)
println(DASHES)
println(DASHES)
println("12. Check and print the state of the rule.")
checkRule(eventRuleName)
println(DASHES)
println(DASHES)
println("13. Add a transform to the rule to change the text of the email.")
updateSnsEventRule(topicArn, eventRuleName)
println(DASHES)
println(DASHES)
println("14. Enable a specific rule.")
changeRuleState(eventRuleName, true)
println(DASHES)
println(DASHES)
println("15. Trigger the updated rule by uploading a file to the S3 bucket.")
println("Press Enter to continue.")
sc.nextLine()
uploadTextFiletoS3(bucketName)
println(DASHES)
println(DASHES)
println("16. Update the rule to a custom rule pattern.")
updateToCustomRule(eventRuleName)
println("Updated event rule $eventRuleName to use a custom pattern.")
updateCustomRuleTargetWithTransform(topicArn, eventRuleName)
println("Updated event target $topicArn.")
println(DASHES)
println(DASHES)
println("17. Send an event to trigger the rule. This will trigger a subscription email.")
triggerCustomRule(email)
println("Events have been sent. Press Enter to continue.")
sc.nextLine()
println(DASHES)
println(DASHES)
println("18. Clean up resources.")
println("Do you want to clean up resources (y/n)")
val ans = sc.nextLine()
if (ans.compareTo("y") == 0) {
cleanupResources(topicArn, eventRuleName, bucketName, roleName)
} else {
println("The resources will not be cleaned up. ")
}
println(DASHES)
println(DASHES)
println("The Amazon EventBridge example scenario has successfully completed.")
println(DASHES)
}
suspend fun cleanupResources(
topicArn: String?,
eventRuleName: String?,
bucketName: String?,
roleName: String?,
) {
println("Removing all targets from the event rule.")
deleteTargetsFromRule(eventRuleName)
deleteRuleByName(eventRuleName)
deleteSNSTopic(topicArn)
deleteS3Bucket(bucketName)
deleteRole(roleName)
}
suspend fun deleteRole(roleNameVal: String?) {
val policyArnVal = "arn:aws:iam::aws:policy/AmazonEventBridgeFullAccess"
val policyRequest =
DetachRolePolicyRequest {
policyArn = policyArnVal
roleName = roleNameVal
}
IamClient.fromEnvironment { region = "us-east-1" }.use { iam ->
iam.detachRolePolicy(policyRequest)
println("Successfully detached policy $policyArnVal from role $roleNameVal")
// Delete the role.
val roleRequest =
DeleteRoleRequest {
roleName = roleNameVal
}
iam.deleteRole(roleRequest)
println("*** Successfully deleted $roleNameVal")
}
}
suspend fun deleteS3Bucket(bucketName: String?) {
// Remove all the objects from the S3 bucket.
val listObjects =
ListObjectsRequest {
bucket = bucketName
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3Client ->
val res = s3Client.listObjects(listObjects)
val myObjects = res.contents
val toDelete = mutableListOf()
if (myObjects != null) {
for (myValue in myObjects) {
toDelete.add(
ObjectIdentifier {
key = myValue.key
},
)
}
}
val delOb =
Delete {
objects = toDelete
}
val dor =
DeleteObjectsRequest {
bucket = bucketName
delete = delOb
}
s3Client.deleteObjects(dor)
// Delete the S3 bucket.
val deleteBucketRequest =
DeleteBucketRequest {
bucket = bucketName
}
s3Client.deleteBucket(deleteBucketRequest)
println("You have deleted the bucket and the objects")
}
}
// Delete the SNS topic.
suspend fun deleteSNSTopic(topicArnVal: String?) {
val request =
DeleteTopicRequest {
topicArn = topicArnVal
}
SnsClient.fromEnvironment { region = "us-east-1" }.use { snsClient ->
snsClient.deleteTopic(request)
println(" $topicArnVal was deleted.")
}
}
suspend fun deleteRuleByName(ruleName: String?) {
val ruleRequest =
DeleteRuleRequest {
name = ruleName
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
eventBrClient.deleteRule(ruleRequest)
println("Successfully deleted the rule")
}
}
suspend fun deleteTargetsFromRule(eventRuleName: String?) {
// First, get all targets that will be deleted.
val request =
ListTargetsByRuleRequest {
rule = eventRuleName
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
val response = eventBrClient.listTargetsByRule(request)
val allTargets = response.targets
// Get all targets and delete them.
if (allTargets != null) {
for (myTarget in allTargets) {
val removeTargetsRequest =
RemoveTargetsRequest {
rule = eventRuleName
ids = listOf(myTarget.id.toString())
}
eventBrClient.removeTargets(removeTargetsRequest)
println("Successfully removed the target")
}
}
}
}
suspend fun triggerCustomRule(email: String) {
val json =
"{" +
"\"UserEmail\": \"" + email + "\"," +
"\"Message\": \"This event was generated by example code.\"" +
"\"UtcTime\": \"Now.\"" +
"}"
val entry =
PutEventsRequestEntry {
source = "ExampleSource"
detail = json
detailType = "ExampleType"
}
val eventsRequest =
PutEventsRequest {
this.entries = listOf(entry)
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
eventBrClient.putEvents(eventsRequest)
}
}
suspend fun updateCustomRuleTargetWithTransform(
topicArn: String?,
ruleName: String?,
) {
val targetId = UUID.randomUUID().toString()
val inputTransformerOb =
InputTransformer {
inputTemplate = "\"Notification: sample event was received.\""
}
val target =
Target {
id = targetId
arn = topicArn
inputTransformer = inputTransformerOb
}
val targetsRequest =
PutTargetsRequest {
rule = ruleName
targets = listOf(target)
eventBusName = null
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
eventBrClient.putTargets(targetsRequest)
}
}
suspend fun updateToCustomRule(ruleName: String?) {
val customEventsPattern =
"{" +
"\"source\": [\"ExampleSource\"]," +
"\"detail-type\": [\"ExampleType\"]" +
"}"
val request =
PutRuleRequest {
name = ruleName
description = "Custom test rule"
eventPattern = customEventsPattern
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
eventBrClient.putRule(request)
}
}
// Update an Amazon S3 object created rule with a transform on the target.
suspend fun updateSnsEventRule(
topicArn: String?,
ruleName: String?,
) {
val targetId = UUID.randomUUID().toString()
val myMap = mutableMapOf()
myMap["bucket"] = "$.detail.bucket.name"
myMap["time"] = "$.time"
val inputTransOb =
InputTransformer {
inputTemplate = "\"Notification: an object was uploaded to bucket at .\""
inputPathsMap = myMap
}
val targetOb =
Target {
id = targetId
arn = topicArn
inputTransformer = inputTransOb
}
val targetsRequest =
PutTargetsRequest {
rule = ruleName
targets = listOf(targetOb)
eventBusName = null
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
eventBrClient.putTargets(targetsRequest)
}
}
suspend fun checkRule(eventRuleName: String?) {
val ruleRequest =
DescribeRuleRequest {
name = eventRuleName
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
val response = eventBrClient.describeRule(ruleRequest)
println("The state of the rule is $response")
}
}
suspend fun changeRuleState(
eventRuleName: String,
isEnabled: Boolean?,
) {
if (!isEnabled!!) {
println("Disabling the rule: $eventRuleName")
val ruleRequest =
DisableRuleRequest {
name = eventRuleName
}
EventBridgeClient { region = "us-east-1" }.use { eventBrClient ->
eventBrClient.disableRule(ruleRequest)
}
} else {
println("Enabling the rule: $eventRuleName")
val ruleRequest =
EnableRuleRequest {
name = eventRuleName
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
eventBrClient.enableRule(ruleRequest)
}
}
}
// Create and upload a file to an S3 bucket to trigger an event.
@Throws(IOException::class)
suspend fun uploadTextFiletoS3(bucketName: String?) {
val fileSuffix = SimpleDateFormat("yyyyMMddHHmmss").format(Date())
val fileName = "TextFile$fileSuffix.txt"
val myFile = File(fileName)
val fw = FileWriter(myFile.absoluteFile)
val bw = BufferedWriter(fw)
bw.write("This is a sample file for testing uploads.")
bw.close()
val putOb =
PutObjectRequest {
bucket = bucketName
key = fileName
body = myFile.asByteStream()
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3Client ->
s3Client.putObject(putOb)
}
}
suspend fun listTargetRules(topicArnVal: String?) {
val ruleNamesByTargetRequest =
ListRuleNamesByTargetRequest {
targetArn = topicArnVal
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
val response = eventBrClient.listRuleNamesByTarget(ruleNamesByTargetRequest)
response.ruleNames?.forEach { rule ->
println("The rule name is $rule")
}
}
}
suspend fun listTargets(ruleName: String?) {
val ruleRequest =
ListTargetsByRuleRequest {
rule = ruleName
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
val response = eventBrClient.listTargetsByRule(ruleRequest)
response.targets?.forEach { target ->
println("Target ARN: ${target.arn}")
}
}
}
// Add a rule that triggers an SNS target when a file is uploaded to an S3 bucket.
suspend fun addSnsEventRule(
ruleName: String?,
topicArn: String?,
topicName: String,
eventRuleName: String,
bucketName: String,
) {
val targetID = UUID.randomUUID().toString()
val myTarget =
Target {
id = targetID
arn = topicArn
}
val targetsOb = mutableListOf()
targetsOb.add(myTarget)
val request =
PutTargetsRequest {
eventBusName = null
targets = targetsOb
rule = ruleName
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
eventBrClient.putTargets(request)
println("Added event rule $eventRuleName with Amazon SNS target $topicName for bucket $bucketName.")
}
}
suspend fun subEmail(
topicArnVal: String?,
email: String?,
) {
val request =
SubscribeRequest {
protocol = "email"
endpoint = email
returnSubscriptionArn = true
topicArn = topicArnVal
}
SnsClient.fromEnvironment { region = "us-east-1" }.use { snsClient ->
val result = snsClient.subscribe(request)
println(" Subscription ARN: ${result.subscriptionArn}")
}
}
suspend fun createSnsTopic(topicName: String): String? {
val topicPolicy = """
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "EventBridgePublishTopic",
"Effect": "Allow",
"Principal": {
"Service": "events.amazonaws.com"
},
"Resource": "*",
"Action": "sns:Publish"
}
]
}
""".trimIndent()
val topicAttributes = mutableMapOf()
topicAttributes["Policy"] = topicPolicy
val topicRequest =
CreateTopicRequest {
name = topicName
attributes = topicAttributes
}
SnsClient.fromEnvironment { region = "us-east-1" }.use { snsClient ->
val response = snsClient.createTopic(topicRequest)
println("Added topic $topicName for email subscriptions.")
return response.topicArn
}
}
suspend fun listRules() {
val rulesRequest =
ListRulesRequest {
eventBusName = "default"
limit = 10
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
val response = eventBrClient.listRules(rulesRequest)
response.rules?.forEach { rule ->
println("The rule name is ${rule.name}")
println("The rule ARN is ${rule.arn}")
}
}
}
// Create a new event rule that triggers when an Amazon S3 object is created in a bucket.
suspend fun addEventRule(
roleArnVal: String?,
bucketName: String,
eventRuleName: String?,
) {
val pattern = """
{
"source": ["aws.s3"],
"detail-type": ["Object Created"],
"detail": {
"bucket": {
"name": ["$bucketName"]
}
}
}
""".trimIndent()
val ruleRequest =
PutRuleRequest {
description = "Created by using the AWS SDK for Kotlin"
name = eventRuleName
eventPattern = pattern
roleArn = roleArnVal
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
val ruleResponse = eventBrClient.putRule(ruleRequest)
println("The ARN of the new rule is ${ruleResponse.ruleArn}")
}
}
// Set the Amazon S3 bucket notification configuration.
suspend fun setBucketNotification(bucketName: String) {
val eventBridgeConfig =
EventBridgeConfiguration {
}
val configuration =
NotificationConfiguration {
eventBridgeConfiguration = eventBridgeConfig
}
val configurationRequest =
PutBucketNotificationConfigurationRequest {
bucket = bucketName
notificationConfiguration = configuration
skipDestinationValidation = true
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3Client ->
s3Client.putBucketNotificationConfiguration(configurationRequest)
println("Added bucket $bucketName with EventBridge events enabled.")
}
}
// Create an S3 bucket using a waiter.
suspend fun createBucket(bucketName: String) {
val request =
CreateBucketRequest {
bucket = bucketName
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3 ->
s3.createBucket(request)
s3.waitUntilBucketExists {
bucket = bucketName
}
println("$bucketName is ready")
}
}
suspend fun checkBucket(bucketName: String?): Boolean {
try {
// Determine if the S3 bucket exists.
val headBucketRequest =
HeadBucketRequest {
bucket = bucketName
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3Client ->
s3Client.headBucket(headBucketRequest)
return true
}
} catch (e: S3Exception) {
System.err.println(e.message)
}
return false
}
suspend fun createIAMRole(
rolenameVal: String?,
polJSON: String?,
): String? {
val request =
CreateRoleRequest {
roleName = rolenameVal
assumeRolePolicyDocument = polJSON
description = "Created using the AWS SDK for Kotlin"
}
val rolePolicyRequest =
AttachRolePolicyRequest {
roleName = rolenameVal
policyArn = "arn:aws:iam::aws:policy/AmazonEventBridgeFullAccess"
}
IamClient.fromEnvironment { region = "us-east-1" }.use { iam ->
val response = iam.createRole(request)
iam.attachRolePolicy(rolePolicyRequest)
return response.role?.arn
}
}
```
+ For API details, see the following topics in *AWS SDK for Kotlin API reference*.
+ [DeleteRule](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DescribeRule](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DisableRule](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [EnableRule](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [ListRuleNamesByTarget](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [ListRules](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [ListTargetsByRule](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [PutEvents](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [PutRule](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [PutTargets](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
------
# Actions for EventBridge using AWS SDKs
/// Delete an event rule by name.
///
/// True if successful.
public async Task DeleteRuleByName(string ruleName)
{
var response = await _amazonEventBridge.DeleteRuleAsync(
new DeleteRuleRequest()
{
Name = ruleName
});
return response.HttpStatusCode == HttpStatusCode.OK;
}
```
+ For API details, see [DeleteRule](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/DeleteRule) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To delete a CloudWatch Events rule**
This example deletes the rule named EC2InstanceStateChanges:
```
aws events delete-rule --name "EC2InstanceStateChanges"
```
+ For API details, see [DeleteRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/delete-rule.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/eventbridge#code-examples).
```
public static void deleteRuleByName(EventBridgeClient eventBrClient, String ruleName) {
DeleteRuleRequest ruleRequest = DeleteRuleRequest.builder()
.name(ruleName)
.build();
eventBrClient.deleteRule(ruleRequest);
System.out.println("Successfully deleted the rule");
}
```
+ For API details, see [DeleteRule](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DeleteRule) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/eventbridge#code-examples).
```
suspend fun deleteRuleByName(ruleName: String?) {
val ruleRequest =
DeleteRuleRequest {
name = ruleName
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
eventBrClient.deleteRule(ruleRequest)
println("Successfully deleted the rule")
}
}
```
+ For API details, see [DeleteRule](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
# Use `DescribeRule` with an AWS SDK or CLI
/// Get the state for a rule by the rule name.
///
/// The state of the rule.
public async Task GetRuleStateByRuleName(string ruleName, string? eventBusName = null)
{
var ruleResponse = await _amazonEventBridge.DescribeRuleAsync(
new DescribeRuleRequest()
{
Name = ruleName,
EventBusName = eventBusName
});
return ruleResponse.State;
}
```
+ For API details, see [DescribeRule](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/DescribeRule) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To display information about a CloudWatch Events rule**
This example displays information about the rule named DailyLambdaFunction:
```
aws events describe-rule --name "DailyLambdaFunction"
```
+ For API details, see [DescribeRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/describe-rule.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/eventbridge#code-examples).
```
public static void checkRule(EventBridgeClient eventBrClient, String eventRuleName) {
try {
DescribeRuleRequest ruleRequest = DescribeRuleRequest.builder()
.name(eventRuleName)
.build();
DescribeRuleResponse response = eventBrClient.describeRule(ruleRequest);
System.out.println("The state of the rule is " + response.stateAsString());
} catch (EventBridgeException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ For API details, see [DescribeRule](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DescribeRule) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/eventbridge#code-examples).
```
suspend fun checkRule(eventRuleName: String?) {
val ruleRequest =
DescribeRuleRequest {
name = eventRuleName
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
val response = eventBrClient.describeRule(ruleRequest)
println("The state of the rule is $response")
}
}
```
+ For API details, see [DescribeRule](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
# Use `DisableRule` with an AWS SDK or CLI
/// Disable a particular rule on an event bus.
/// The name of the rule.
/// True if successful.
public async Task DisableRuleByName(string ruleName)
{
var ruleResponse = await _amazonEventBridge.DisableRuleAsync(
new DisableRuleRequest()
{
Name = ruleName
});
return ruleResponse.HttpStatusCode == HttpStatusCode.OK;
}
```
+ For API details, see [DisableRule](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/DisableRule) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To disable a CloudWatch Events rule**
This example disables the rule named DailyLambdaFunction. The rule is not deleted:
```
aws events disable-rule --name "DailyLambdaFunction"
```
+ For API details, see [DisableRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/disable-rule.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/eventbridge#code-examples).
Disable a rule by using its rule name.
```
public static void changeRuleState(EventBridgeClient eventBrClient, String eventRuleName, Boolean isEnabled) {
try {
if (!isEnabled) {
System.out.println("Disabling the rule: " + eventRuleName);
DisableRuleRequest ruleRequest = DisableRuleRequest.builder()
.name(eventRuleName)
.build();
eventBrClient.disableRule(ruleRequest);
} else {
System.out.println("Enabling the rule: " + eventRuleName);
EnableRuleRequest ruleRequest = EnableRuleRequest.builder()
.name(eventRuleName)
.build();
eventBrClient.enableRule(ruleRequest);
}
} catch (EventBridgeException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ For API details, see [DisableRule](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DisableRule) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/eventbridge#code-examples).
```
suspend fun changeRuleState(
eventRuleName: String,
isEnabled: Boolean?,
) {
if (!isEnabled!!) {
println("Disabling the rule: $eventRuleName")
val ruleRequest =
DisableRuleRequest {
name = eventRuleName
}
EventBridgeClient { region = "us-east-1" }.use { eventBrClient ->
eventBrClient.disableRule(ruleRequest)
}
} else {
println("Enabling the rule: $eventRuleName")
val ruleRequest =
EnableRuleRequest {
name = eventRuleName
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
eventBrClient.enableRule(ruleRequest)
}
}
}
```
+ For API details, see [DisableRule](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
# Use `EnableRule` with an AWS SDK or CLI
/// Enable a particular rule on an event bus.
///
/// True if successful.
public async Task EnableRuleByName(string ruleName)
{
var ruleResponse = await _amazonEventBridge.EnableRuleAsync(
new EnableRuleRequest()
{
Name = ruleName
});
return ruleResponse.HttpStatusCode == HttpStatusCode.OK;
}
```
+ For API details, see [EnableRule](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/EnableRule) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To enable a CloudWatch Events rule**
This example enables the rule named DailyLambdaFunction, which had been previously disabled:
```
aws events enable-rule --name "DailyLambdaFunction"
```
+ For API details, see [EnableRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/enable-rule.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/eventbridge#code-examples).
Enable a rule by using its rule name.
```
public static void changeRuleState(EventBridgeClient eventBrClient, String eventRuleName, Boolean isEnabled) {
try {
if (!isEnabled) {
System.out.println("Disabling the rule: " + eventRuleName);
DisableRuleRequest ruleRequest = DisableRuleRequest.builder()
.name(eventRuleName)
.build();
eventBrClient.disableRule(ruleRequest);
} else {
System.out.println("Enabling the rule: " + eventRuleName);
EnableRuleRequest ruleRequest = EnableRuleRequest.builder()
.name(eventRuleName)
.build();
eventBrClient.enableRule(ruleRequest);
}
} catch (EventBridgeException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ For API details, see [EnableRule](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/EnableRule) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/eventbridge#code-examples).
```
suspend fun changeRuleState(
eventRuleName: String,
isEnabled: Boolean?,
) {
if (!isEnabled!!) {
println("Disabling the rule: $eventRuleName")
val ruleRequest =
DisableRuleRequest {
name = eventRuleName
}
EventBridgeClient { region = "us-east-1" }.use { eventBrClient ->
eventBrClient.disableRule(ruleRequest)
}
} else {
println("Enabling the rule: $eventRuleName")
val ruleRequest =
EnableRuleRequest {
name = eventRuleName
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
eventBrClient.enableRule(ruleRequest)
}
}
}
```
+ For API details, see [EnableRule](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
# Use `ListRuleNamesByTarget` with an AWS SDK or CLI
/// List names of all rules matching a target.
///
/// The list of rule names.
public async Task> ListAllRuleNamesByTarget(string targetArn)
{
var results = new List();
var request = new ListRuleNamesByTargetRequest()
{
TargetArn = targetArn
};
ListRuleNamesByTargetResponse response;
do
{
response = await _amazonEventBridge.ListRuleNamesByTargetAsync(request);
results.AddRange(response.RuleNames);
request.NextToken = response.NextToken;
} while (response.NextToken is not null);
return results;
}
```
+ For API details, see [ListRuleNamesByTarget](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/ListRuleNamesByTarget) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To display all the rules that have a specified target**
This example displays all rules that have the Lambda function named "MyFunctionName" as the target:
```
aws events list-rule-names-by-target --target-arn "arn:aws:lambda:us-east-1:123456789012:function:MyFunctionName"
```
+ For API details, see [ListRuleNamesByTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/list-rule-names-by-target.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/eventbridge#code-examples).
List all of the rule names by using the target.
```
public static void listTargetRules(EventBridgeClient eventBrClient, String topicArn) {
ListRuleNamesByTargetRequest ruleNamesByTargetRequest = ListRuleNamesByTargetRequest.builder()
.targetArn(topicArn)
.build();
ListRuleNamesByTargetResponse response = eventBrClient.listRuleNamesByTarget(ruleNamesByTargetRequest);
List rules = response.ruleNames();
for (String rule : rules) {
System.out.println("The rule name is " + rule);
}
}
```
+ For API details, see [ListRuleNamesByTarget](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListRuleNamesByTarget) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/eventbridge#code-examples).
```
suspend fun listTargetRules(topicArnVal: String?) {
val ruleNamesByTargetRequest =
ListRuleNamesByTargetRequest {
targetArn = topicArnVal
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
val response = eventBrClient.listRuleNamesByTarget(ruleNamesByTargetRequest)
response.ruleNames?.forEach { rule ->
println("The rule name is $rule")
}
}
}
```
+ For API details, see [ListRuleNamesByTarget](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
# Use `ListRules` with an AWS SDK or CLI
/// List the rules on an event bus.
///
/// The list of rules.
public async Task> ListAllRulesForEventBus(string? eventBusArn = null)
{
var results = new List();
var request = new ListRulesRequest()
{
EventBusName = eventBusArn
};
// Get all of the pages of rules.
ListRulesResponse response;
do
{
response = await _amazonEventBridge.ListRulesAsync(request);
results.AddRange(response.Rules);
request.NextToken = response.NextToken;
} while (response.NextToken is not null);
return results;
}
```
+ For API details, see [ListRules](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/ListRules) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To display a list of all CloudWatch Events rules**
This example displays all CloudWatch Events rules in the region:
```
aws events list-rules
```
**To display a list of CloudWatch Events rules beginning with a certain string.**
This example displays all CloudWatch Events rules in the region that have a name starting with "Daily":
```
aws events list-rules --name-prefix "Daily"
```
+ For API details, see [ListRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/list-rules.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/eventbridge#code-examples).
Enable a rule by using its rule name.
```
public static void listRules(EventBridgeClient eventBrClient) {
try {
ListRulesRequest rulesRequest = ListRulesRequest.builder()
.eventBusName("default")
.limit(10)
.build();
ListRulesResponse response = eventBrClient.listRules(rulesRequest);
List rules = response.rules();
for (Rule rule : rules) {
System.out.println("The rule name is : " + rule.name());
System.out.println("The rule description is : " + rule.description());
System.out.println("The rule state is : " + rule.stateAsString());
}
} catch (EventBridgeException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ For API details, see [ListRules](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListRules) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/eventbridge#code-examples).
```
suspend fun listRules() {
val rulesRequest =
ListRulesRequest {
eventBusName = "default"
limit = 10
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
val response = eventBrClient.listRules(rulesRequest)
response.rules?.forEach { rule ->
println("The rule name is ${rule.name}")
println("The rule ARN is ${rule.arn}")
}
}
}
```
+ For API details, see [ListRules](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
# Use `ListTargetsByRule` with an AWS SDK or CLI
/// List all of the targets matching a rule by name.
///
/// The list of targets.
public async Task> ListAllTargetsOnRule(string ruleName)
{
var results = new List();
var request = new ListTargetsByRuleRequest()
{
Rule = ruleName
};
ListTargetsByRuleResponse response;
do
{
response = await _amazonEventBridge.ListTargetsByRuleAsync(request);
results.AddRange(response.Targets);
request.NextToken = response.NextToken;
} while (response.NextToken is not null);
return results;
}
```
+ For API details, see [ListTargetsByRule](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/ListTargetsByRule) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To display all the targets for a CloudWatch Events rule**
This example displays all the targets of the rule named DailyLambdaFunction:
```
aws events list-targets-by-rule --rule "DailyLambdaFunction"
```
+ For API details, see [ListTargetsByRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/list-targets-by-rule.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/eventbridge#code-examples).
List all of the targets for a rule by using the rule name.
```
public static void listTargets(EventBridgeClient eventBrClient, String ruleName) {
ListTargetsByRuleRequest ruleRequest = ListTargetsByRuleRequest.builder()
.rule(ruleName)
.build();
ListTargetsByRuleResponse res = eventBrClient.listTargetsByRule(ruleRequest);
List targetsList = res.targets();
for (Target target: targetsList) {
System.out.println("Target ARN: "+target.arn());
}
}
```
+ For API details, see [ListTargetsByRule](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListTargetsByRule) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/eventbridge#code-examples).
```
suspend fun listTargets(ruleName: String?) {
val ruleRequest =
ListTargetsByRuleRequest {
rule = ruleName
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
val response = eventBrClient.listTargetsByRule(ruleRequest)
response.targets?.forEach { target ->
println("Target ARN: ${target.arn}")
}
}
}
```
+ For API details, see [ListTargetsByRule](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
# Use `PutEvents` with an AWS SDK or CLI
/// Add an event to the event bus that includes an email, message, and time.
///
/// True if successful.
public async Task PutCustomEmailEvent(string email)
{
var eventDetail = new
{
UserEmail = email,
Message = "This event was generated by example code.",
UtcTime = DateTime.UtcNow.ToString("g")
};
var response = await _amazonEventBridge.PutEventsAsync(
new PutEventsRequest()
{
Entries = new List()
{
new PutEventsRequestEntry()
{
Source = "ExampleSource",
Detail = JsonSerializer.Serialize(eventDetail),
DetailType = "ExampleType"
}
}
});
return response.FailedEntryCount == 0;
}
```
+ For API details, see [PutEvents](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/PutEvents) in *AWS SDK for .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/eventbridge#code-examples).
Include the required files.
```
#include
#include
#include
#include
#include
#include
```
Send the event.
```
Aws::CloudWatchEvents::EventBridgeClient cwe;
Aws::CloudWatchEvents::Model::PutEventsRequestEntry event_entry;
event_entry.SetDetail(MakeDetails(event_key, event_value));
event_entry.SetDetailType("sampleSubmitted");
event_entry.AddResources(resource_arn);
event_entry.SetSource("aws-sdk-cpp-cloudwatch-example");
Aws::CloudWatchEvents::Model::PutEventsRequest request;
request.AddEntries(event_entry);
auto outcome = cwe.PutEvents(request);
if (!outcome.IsSuccess())
{
std::cout << "Failed to post CloudWatch event: " <<
outcome.GetError().GetMessage() << std::endl;
}
else
{
std::cout << "Successfully posted CloudWatch event" << std::endl;
}
```
+ For API details, see [PutEvents](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/PutEvents) in *AWS SDK for C\$1\$1 API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To send a custom event to CloudWatch Events**
This example sends a custom event to CloudWatch Events. The event is contained within the putevents.json file:
```
aws events put-events --entries file://putevents.json
```
Here are the contents of the putevents.json file:
```
[
{
"Source": "com.mycompany.myapp",
"Detail": "{ \"key1\": \"value1\", \"key2\": \"value2\" }",
"Resources": [
"resource1",
"resource2"
],
"DetailType": "myDetailType"
},
{
"Source": "com.mycompany.myapp",
"Detail": "{ \"key1\": \"value3\", \"key2\": \"value4\" }",
"Resources": [
"resource1",
"resource2"
],
"DetailType": "myDetailType"
}
]
```
+ For API details, see [PutEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/put-events.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/eventbridge#code-examples).
```
public static void triggerCustomRule(EventBridgeClient eventBrClient, String email) {
String json = "{" +
"\"UserEmail\": \"" + email + "\"," +
"\"Message\": \"This event was generated by example code.\"," +
"\"UtcTime\": \"Now.\"" +
"}";
PutEventsRequestEntry entry = PutEventsRequestEntry.builder()
.source("ExampleSource")
.detail(json)
.detailType("ExampleType")
.build();
PutEventsRequest eventsRequest = PutEventsRequest.builder()
.entries(entry)
.build();
eventBrClient.putEvents(eventsRequest);
}
```
+ For API details, see [PutEvents](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/PutEvents) in *AWS SDK for Java 2.x API Reference*.
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/eventbridge#code-examples).
Import the SDK and client modules and call the API.
```
import {
EventBridgeClient,
PutEventsCommand,
} from "@aws-sdk/client-eventbridge";
export const putEvents = async (
source = "eventbridge.integration.test",
detailType = "greeting",
resources = [],
) => {
const client = new EventBridgeClient({});
const response = await client.send(
new PutEventsCommand({
Entries: [
{
Detail: JSON.stringify({ greeting: "Hello there." }),
DetailType: detailType,
Resources: resources,
Source: source,
},
],
}),
);
console.log("PutEvents response:");
console.log(response);
// PutEvents response:
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: '3d0df73d-dcea-4a23-ae0d-f5556a3ac109',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// Entries: [ { EventId: '51620841-5af4-6402-d9bc-b77734991eb5' } ],
// FailedEntryCount: 0
// }
return response;
};
```
+ For API details, see [PutEvents](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/eventbridge/command/PutEventsCommand) in *AWS SDK for JavaScript API Reference*.
**SDK for JavaScript (v2)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascript/example_code/eventbridge#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 ebevents = new AWS.EventBridge({ apiVersion: "2015-10-07" });
var params = {
Entries: [
{
Detail: '{ "key1": "value1", "key2": "value2" }',
DetailType: "appRequestSubmitted",
Resources: ["RESOURCE_ARN"],
Source: "com.company.app",
},
],
};
ebevents.putEvents(params, function (err, data) {
if (err) {
console.log("Error", err);
} else {
console.log("Success", data.Entries);
}
});
```
+ For API details, see [PutEvents](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/eventbridge-2015-10-07/PutEvents) in *AWS SDK for JavaScript API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/eventbridge#code-examples).
```
suspend fun triggerCustomRule(email: String) {
val json =
"{" +
"\"UserEmail\": \"" + email + "\"," +
"\"Message\": \"This event was generated by example code.\"" +
"\"UtcTime\": \"Now.\"" +
"}"
val entry =
PutEventsRequestEntry {
source = "ExampleSource"
detail = json
detailType = "ExampleType"
}
val eventsRequest =
PutEventsRequest {
this.entries = listOf(entry)
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
eventBrClient.putEvents(eventsRequest)
}
}
```
+ For API details, see [PutEvents](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
# Use `PutRule` with an AWS SDK or CLI
/// Create a new event rule that triggers when an Amazon S3 object is created in a bucket.
///
/// The ARN of the new rule.
public async Task PutS3UploadRule(string roleArn, string ruleName, string bucketName)
{
string eventPattern = "{" +
"\"source\": [\"aws.s3\"]," +
"\"detail-type\": [\"Object Created\"]," +
"\"detail\": {" +
"\"bucket\": {" +
"\"name\": [\"" + bucketName + "\"]" +
"}" +
"}" +
"}";
var response = await _amazonEventBridge.PutRuleAsync(
new PutRuleRequest()
{
Name = ruleName,
Description = "Example S3 upload rule for EventBridge",
RoleArn = roleArn,
EventPattern = eventPattern
});
return response.RuleArn;
}
```
Create a rule that uses a custom pattern.
```
///
/// Update a rule to use a custom defined event pattern.
///
/// The ARN of the updated rule.
public async Task UpdateCustomEventPattern(string ruleName)
{
string customEventsPattern = "{" +
"\"source\": [\"ExampleSource\"]," +
"\"detail-type\": [\"ExampleType\"]" +
"}";
var response = await _amazonEventBridge.PutRuleAsync(
new PutRuleRequest()
{
Name = ruleName,
Description = "Custom test rule",
EventPattern = customEventsPattern
});
return response.RuleArn;
}
```
+ For API details, see [PutRule](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/PutRule) in *AWS SDK for .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/eventbridge#code-examples).
Include the required files.
```
#include
#include
#include
#include
#include
#include
```
Create the rule.
```
Aws::CloudWatchEvents::EventBridgeClient cwe;
Aws::CloudWatchEvents::Model::PutRuleRequest request;
request.SetName(rule_name);
request.SetRoleArn(role_arn);
request.SetScheduleExpression("rate(5 minutes)");
request.SetState(Aws::CloudWatchEvents::Model::RuleState::ENABLED);
auto outcome = cwe.PutRule(request);
if (!outcome.IsSuccess())
{
std::cout << "Failed to create CloudWatch events rule " <<
rule_name << ": " << outcome.GetError().GetMessage() <<
std::endl;
}
else
{
std::cout << "Successfully created CloudWatch events rule " <<
rule_name << " with resulting Arn " <<
outcome.GetResult().GetRuleArn() << std::endl;
}
```
+ For API details, see [PutRule](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/PutRule) in *AWS SDK for C\$1\$1 API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To create CloudWatch Events rules**
This example creates a rule that triggers every day at 9:00am (UTC). If you use put-targets to add a Lambda function as a target of this rule, you could run the Lambda function every day at the specified time:
```
aws events put-rule --name "DailyLambdaFunction" --schedule-expression "cron(0 9 * * ? *)"
```
This example creates a rule that triggers when any EC2 instance in the region changes state:
```
aws events put-rule --name "EC2InstanceStateChanges" --event-pattern "{\"source\":[\"aws.ec2\"],\"detail-type\":[\"EC2 Instance State-change Notification\"]}" --role-arn "arn:aws:iam::123456789012:role/MyRoleForThisRule"
```
This example creates a rule that triggers when any EC2 instance in the region is stopped or terminated:
```
aws events put-rule --name "EC2InstanceStateChangeStopOrTerminate" --event-pattern "{\"source\":[\"aws.ec2\"],\"detail-type\":[\"EC2 Instance State-change Notification\"],\"detail\":{\"state\":[\"stopped\",\"terminated\"]}}" --role-arn "arn:aws:iam::123456789012:role/MyRoleForThisRule"
```
+ For API details, see [PutRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/put-rule.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/eventbridge#code-examples).
Create a scheduled rule.
```
public static void createEBRule(EventBridgeClient eventBrClient, String ruleName, String cronExpression) {
try {
PutRuleRequest ruleRequest = PutRuleRequest.builder()
.name(ruleName)
.eventBusName("default")
.scheduleExpression(cronExpression)
.state("ENABLED")
.description("A test rule that runs on a schedule created by the Java API")
.build();
PutRuleResponse ruleResponse = eventBrClient.putRule(ruleRequest);
System.out.println("The ARN of the new rule is " + ruleResponse.ruleArn());
} catch (EventBridgeException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
Create a rule that triggers when an object is added to an Amazon Simple Storage Service bucket.
```
// Create a new event rule that triggers when an Amazon S3 object is created in
// a bucket.
public static void addEventRule(EventBridgeClient eventBrClient, String roleArn, String bucketName,
String eventRuleName) {
String pattern = "{\n" +
" \"source\": [\"aws.s3\"],\n" +
" \"detail-type\": [\"Object Created\"],\n" +
" \"detail\": {\n" +
" \"bucket\": {\n" +
" \"name\": [\"" + bucketName + "\"]\n" +
" }\n" +
" }\n" +
"}";
try {
PutRuleRequest ruleRequest = PutRuleRequest.builder()
.description("Created by using the AWS SDK for Java v2")
.name(eventRuleName)
.eventPattern(pattern)
.roleArn(roleArn)
.build();
PutRuleResponse ruleResponse = eventBrClient.putRule(ruleRequest);
System.out.println("The ARN of the new rule is " + ruleResponse.ruleArn());
} catch (EventBridgeException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ For API details, see [PutRule](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/PutRule) in *AWS SDK for Java 2.x API Reference*.
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/eventbridge#code-examples).
Import the SDK and client modules and call the API.
```
import { EventBridgeClient, PutRuleCommand } from "@aws-sdk/client-eventbridge";
export const putRule = async (
ruleName = "some-rule",
source = "some-source",
) => {
const client = new EventBridgeClient({});
const response = await client.send(
new PutRuleCommand({
Name: ruleName,
EventPattern: JSON.stringify({ source: [source] }),
State: "ENABLED",
EventBusName: "default",
}),
);
console.log("PutRule response:");
console.log(response);
// PutRule response:
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: 'd7292ced-1544-421b-842f-596326bc7072',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// RuleArn: 'arn:aws:events:us-east-1:xxxxxxxxxxxx:rule/EventBridgeTestRule-1696280037720'
// }
return response;
};
```
+ For API details, see [PutRule](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/eventbridge/command/PutRuleCommand) in *AWS SDK for JavaScript API Reference*.
**SDK for JavaScript (v2)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascript/example_code/eventbridge#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 ebevents = new AWS.EventBridge({ apiVersion: "2015-10-07" });
var params = {
Name: "DEMO_EVENT",
RoleArn: "IAM_ROLE_ARN",
ScheduleExpression: "rate(5 minutes)",
State: "ENABLED",
};
ebevents.putRule(params, function (err, data) {
if (err) {
console.log("Error", err);
} else {
console.log("Success", data.RuleArn);
}
});
```
+ For API details, see [PutRule](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/eventbridge-2015-10-07/PutRule) in *AWS SDK for JavaScript API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/eventbridge#code-examples).
Create a scheduled rule.
```
suspend fun createScRule(
ruleName: String?,
cronExpression: String?,
) {
val ruleRequest =
PutRuleRequest {
name = ruleName
eventBusName = "default"
scheduleExpression = cronExpression
state = RuleState.Enabled
description = "A test rule that runs on a schedule created by the Kotlin API"
}
EventBridgeClient.fromEnvironment { region = "us-west-2" }.use { eventBrClient ->
val ruleResponse = eventBrClient.putRule(ruleRequest)
println("The ARN of the new rule is ${ruleResponse.ruleArn}")
}
}
```
Create a rule that triggers when an object is added to an Amazon Simple Storage Service bucket.
```
// Create a new event rule that triggers when an Amazon S3 object is created in a bucket.
suspend fun addEventRule(
roleArnVal: String?,
bucketName: String,
eventRuleName: String?,
) {
val pattern = """
{
"source": ["aws.s3"],
"detail-type": ["Object Created"],
"detail": {
"bucket": {
"name": ["$bucketName"]
}
}
}
""".trimIndent()
val ruleRequest =
PutRuleRequest {
description = "Created by using the AWS SDK for Kotlin"
name = eventRuleName
eventPattern = pattern
roleArn = roleArnVal
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
val ruleResponse = eventBrClient.putRule(ruleRequest)
println("The ARN of the new rule is ${ruleResponse.ruleArn}")
}
}
```
+ For API details, see [PutRule](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
# Use `PutTargets` with an AWS SDK or CLI
/// Add an Amazon SNS target topic to a rule.
///
/// The ID of the target.
public async Task AddSnsTargetToRule(string ruleName, string targetArn, string? eventBusArn = null)
{
var targetID = Guid.NewGuid().ToString();
// Create the list of targets and add a new target.
var targets = new List
{
new Target()
{
Arn = targetArn,
Id = targetID
}
};
// Add the targets to the rule.
var response = await _amazonEventBridge.PutTargetsAsync(
new PutTargetsRequest()
{
EventBusName = eventBusArn,
Rule = ruleName,
Targets = targets,
});
if (response.FailedEntryCount > 0)
{
response.FailedEntries.ForEach(e =>
{
_logger.LogError(
$"Failed to add target {e.TargetId}: {e.ErrorMessage}, code {e.ErrorCode}");
});
}
return targetID;
}
```
Add an input transformer to a target for a rule.
```
///
/// Update an Amazon S3 object created rule with a transform on the target.
///
/// The ID of the target.
public async Task UpdateS3UploadRuleTargetWithTransform(string ruleName, string targetArn, string? eventBusArn = null)
{
var targetID = Guid.NewGuid().ToString();
var targets = new List
{
new Target()
{
Id = targetID,
Arn = targetArn,
InputTransformer = new InputTransformer()
{
InputPathsMap = new Dictionary()
{
{"bucket", "$.detail.bucket.name"},
{"time", "$.time"}
},
InputTemplate = "\"Notification: an object was uploaded to bucket at .\""
}
}
};
var response = await _amazonEventBridge.PutTargetsAsync(
new PutTargetsRequest()
{
EventBusName = eventBusArn,
Rule = ruleName,
Targets = targets,
});
if (response.FailedEntryCount > 0)
{
response.FailedEntries.ForEach(e =>
{
_logger.LogError(
$"Failed to add target {e.TargetId}: {e.ErrorMessage}, code {e.ErrorCode}");
});
}
return targetID;
}
```
+ For API details, see [PutTargets](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/PutTargets) in *AWS SDK for .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/eventbridge#code-examples).
Include the required files.
```
#include
#include
#include
#include
#include
#include
```
Add the target.
```
Aws::CloudWatchEvents::EventBridgeClient cwe;
Aws::CloudWatchEvents::Model::Target target;
target.SetArn(lambda_arn);
target.SetId(target_id);
Aws::CloudWatchEvents::Model::PutTargetsRequest request;
request.SetRule(rule_name);
request.AddTargets(target);
auto putTargetsOutcome = cwe.PutTargets(request);
if (!putTargetsOutcome.IsSuccess())
{
std::cout << "Failed to create CloudWatch events target for rule "
<< rule_name << ": " <<
putTargetsOutcome.GetError().GetMessage() << std::endl;
}
else
{
std::cout <<
"Successfully created CloudWatch events target for rule "
<< rule_name << std::endl;
}
```
+ For API details, see [PutTargets](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/PutTargets) in *AWS SDK for C\$1\$1 API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To add targets for CloudWatch Events rules**
This example adds a Lambda function as the target of a rule:
```
aws events put-targets --rule DailyLambdaFunction --targets "Id"="1","Arn"="arn:aws:lambda:us-east-1:123456789012:function:MyFunctionName"
```
This example sets an Amazon Kinesis stream as the target, so that events caught by this rule are relayed to the stream:
```
aws events put-targets --rule EC2InstanceStateChanges --targets "Id"="1","Arn"="arn:aws:kinesis:us-east-1:123456789012:stream/MyStream","RoleArn"="arn:aws:iam::123456789012:role/MyRoleForThisRule"
```
This example sets two Amazon Kinesis streams as targets for one rule:
```
aws events put-targets --rule DailyLambdaFunction --targets "Id"="Target1","Arn"="arn:aws:kinesis:us-east-1:379642911888:stream/MyStream1","RoleArn"="arn:aws:iam::379642911888:role/ MyRoleToAccessLambda" "Id"="Target2"," Arn"="arn:aws:kinesis:us-east-1:379642911888:stream/MyStream2","RoleArn"="arn:aws:iam::379642911888:role/MyRoleToAccessLambda"
```
+ For API details, see [PutTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/put-targets.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/eventbridge#code-examples).
Add an Amazon SNS topic as a target for a rule.
```
// Add a rule which triggers an SNS target when a file is uploaded to an S3
// bucket.
public static void addSnsEventRule(EventBridgeClient eventBrClient, String ruleName, String topicArn,
String topicName, String eventRuleName, String bucketName) {
String targetID = java.util.UUID.randomUUID().toString();
Target myTarget = Target.builder()
.id(targetID)
.arn(topicArn)
.build();
List targets = new ArrayList<>();
targets.add(myTarget);
PutTargetsRequest request = PutTargetsRequest.builder()
.eventBusName(null)
.targets(targets)
.rule(ruleName)
.build();
eventBrClient.putTargets(request);
System.out.println("Added event rule " + eventRuleName + " with Amazon SNS target " + topicName + " for bucket "
+ bucketName + ".");
}
```
Add an input transformer to a target for a rule.
```
public static void updateCustomRuleTargetWithTransform(EventBridgeClient eventBrClient, String topicArn,
String ruleName) {
String targetId = java.util.UUID.randomUUID().toString();
InputTransformer inputTransformer = InputTransformer.builder()
.inputTemplate("\"Notification: sample event was received.\"")
.build();
Target target = Target.builder()
.id(targetId)
.arn(topicArn)
.inputTransformer(inputTransformer)
.build();
try {
PutTargetsRequest targetsRequest = PutTargetsRequest.builder()
.rule(ruleName)
.targets(target)
.eventBusName(null)
.build();
eventBrClient.putTargets(targetsRequest);
} catch (EventBridgeException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ For API details, see [PutTargets](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/PutTargets) in *AWS SDK for Java 2.x API Reference*.
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/eventbridge#code-examples).
Import the SDK and client modules and call the API.
```
import {
EventBridgeClient,
PutTargetsCommand,
} from "@aws-sdk/client-eventbridge";
export const putTarget = async (
existingRuleName = "some-rule",
targetArn = "arn:aws:lambda:us-east-1:000000000000:function:test-func",
uniqueId = Date.now().toString(),
) => {
const client = new EventBridgeClient({});
const response = await client.send(
new PutTargetsCommand({
Rule: existingRuleName,
Targets: [
{
Arn: targetArn,
Id: uniqueId,
},
],
}),
);
console.log("PutTargets response:");
console.log(response);
// PutTargets response:
// {
// '$metadata': {
// httpStatusCode: 200,
// requestId: 'f5b23b9a-2c17-45c1-ad5c-f926c3692e3d',
// extendedRequestId: undefined,
// cfId: undefined,
// attempts: 1,
// totalRetryDelay: 0
// },
// FailedEntries: [],
// FailedEntryCount: 0
// }
return response;
};
```
+ For API details, see [PutTargets](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/eventbridge/command/PutTargetsCommand) in *AWS SDK for JavaScript API Reference*.
**SDK for JavaScript (v2)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascript/example_code/eventbridge#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 ebevents = new AWS.EventBridge({ apiVersion: "2015-10-07" });
var params = {
Rule: "DEMO_EVENT",
Targets: [
{
Arn: "LAMBDA_FUNCTION_ARN",
Id: "myEventBridgeTarget",
},
],
};
ebevents.putTargets(params, function (err, data) {
if (err) {
console.log("Error", err);
} else {
console.log("Success", data);
}
});
```
+ For API details, see [PutTargets](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/eventbridge-2015-10-07/PutTargets) in *AWS SDK for JavaScript API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/eventbridge#code-examples).
```
// Add a rule that triggers an SNS target when a file is uploaded to an S3 bucket.
suspend fun addSnsEventRule(
ruleName: String?,
topicArn: String?,
topicName: String,
eventRuleName: String,
bucketName: String,
) {
val targetID = UUID.randomUUID().toString()
val myTarget =
Target {
id = targetID
arn = topicArn
}
val targetsOb = mutableListOf()
targetsOb.add(myTarget)
val request =
PutTargetsRequest {
eventBusName = null
targets = targetsOb
rule = ruleName
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
eventBrClient.putTargets(request)
println("Added event rule $eventRuleName with Amazon SNS target $topicName for bucket $bucketName.")
}
}
```
Add an input transformer to a target for a rule.
```
suspend fun updateCustomRuleTargetWithTransform(
topicArn: String?,
ruleName: String?,
) {
val targetId = UUID.randomUUID().toString()
val inputTransformerOb =
InputTransformer {
inputTemplate = "\"Notification: sample event was received.\""
}
val target =
Target {
id = targetId
arn = topicArn
inputTransformer = inputTransformerOb
}
val targetsRequest =
PutTargetsRequest {
rule = ruleName
targets = listOf(target)
eventBusName = null
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
eventBrClient.putTargets(targetsRequest)
}
}
```
+ For API details, see [PutTargets](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
# Use `RemoveTargets` with an AWS SDK or CLI
/// Delete an event rule by name.
///
/// True if successful.
public async Task RemoveAllTargetsFromRule(string ruleName)
{
var targetIds = new List();
var request = new ListTargetsByRuleRequest()
{
Rule = ruleName
};
ListTargetsByRuleResponse targetsResponse;
do
{
targetsResponse = await _amazonEventBridge.ListTargetsByRuleAsync(request);
targetIds.AddRange(targetsResponse.Targets.Select(t => t.Id));
request.NextToken = targetsResponse.NextToken;
} while (targetsResponse.NextToken is not null);
var removeResponse = await _amazonEventBridge.RemoveTargetsAsync(
new RemoveTargetsRequest()
{
Rule = ruleName,
Ids = targetIds
});
if (removeResponse.FailedEntryCount > 0)
{
removeResponse.FailedEntries.ForEach(e =>
{
_logger.LogError(
$"Failed to remove target {e.TargetId}: {e.ErrorMessage}, code {e.ErrorCode}");
});
}
return removeResponse.HttpStatusCode == HttpStatusCode.OK;
}
```
+ For API details, see [RemoveTargets](https://docs.aws.amazon.com/goto/DotNetSDKV3/eventbridge-2015-10-07/RemoveTargets) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To remove a target for an event**
This example removes the Amazon Kinesis stream named MyStream1 from being a target of the rule DailyLambdaFunction. When DailyLambdaFunction was created, this stream was set as a target with an ID of Target1:
```
aws events remove-targets --rule "DailyLambdaFunction" --ids "Target1"
```
+ For API details, see [RemoveTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/remove-targets.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/eventbridge#code-examples).
Remove all of the targets for a rule by using the rule name.
```
public static void deleteTargetsFromRule(EventBridgeClient eventBrClient, String eventRuleName) {
// First, get all targets that will be deleted.
ListTargetsByRuleRequest request = ListTargetsByRuleRequest.builder()
.rule(eventRuleName)
.build();
ListTargetsByRuleResponse response = eventBrClient.listTargetsByRule(request);
List allTargets = response.targets();
// Get all targets and delete them.
for (Target myTarget : allTargets) {
RemoveTargetsRequest removeTargetsRequest = RemoveTargetsRequest.builder()
.rule(eventRuleName)
.ids(myTarget.id())
.build();
eventBrClient.removeTargets(removeTargetsRequest);
System.out.println("Successfully removed the target");
}
}
```
+ For API details, see [RemoveTargets](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/RemoveTargets) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/eventbridge#code-examples).
```
suspend fun deleteTargetsFromRule(eventRuleName: String?) {
// First, get all targets that will be deleted.
val request =
ListTargetsByRuleRequest {
rule = eventRuleName
}
EventBridgeClient.fromEnvironment { region = "us-east-1" }.use { eventBrClient ->
val response = eventBrClient.listTargetsByRule(request)
val allTargets = response.targets
// Get all targets and delete them.
if (allTargets != null) {
for (myTarget in allTargets) {
val removeTargetsRequest =
RemoveTargetsRequest {
rule = eventRuleName
ids = listOf(myTarget.id.toString())
}
eventBrClient.removeTargets(removeTargetsRequest)
println("Successfully removed the target")
}
}
}
}
```
+ For API details, see [RemoveTargets](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
# Scenarios for EventBridge using AWS SDKs