Class CfnEventBus

java.lang.Object
software.amazon.jsii.JsiiObject
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.980Z") @Stability(Stable) public class CfnEventBus extends CfnResource implements IInspectable
A CloudFormation AWS::Events::EventBus.

Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.events.*;
 CfnEventBus cfnEventBus = CfnEventBus.Builder.create(this, "MyCfnEventBus")
         .name("name")
         // the properties below are optional
         .eventSourceName("eventSourceName")
         .tags(List.of(TagEntryProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 
  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.
  • Constructor Details

    • CfnEventBus

      protected CfnEventBus(software.amazon.jsii.JsiiObjectRef objRef)
    • CfnEventBus

      protected CfnEventBus(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • CfnEventBus

      @Stability(Stable) public CfnEventBus(@NotNull Construct scope, @NotNull String id, @NotNull CfnEventBusProps props)
      Create a new AWS::Events::EventBus.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.
  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.
    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.
    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the event bus, such as arn:aws:events:us-east-2:123456789012:event-bus/aws.partner/PartnerName/acct1/repo1 .
    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      The name of the event bus, such as PartnerName/acct1/repo1 .
    • getAttrPolicy

      @Stability(Stable) @NotNull public String getAttrPolicy()
      The policy for the event bus in JSON form.
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the new event bus.

      Custom event bus names can't contain the / character, but you can use the / character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.

      You can't use the name default for a custom event bus, as this name is already used for your account's default event bus.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the new event bus.

      Custom event bus names can't contain the / character, but you can use the / character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.

      You can't use the name default for a custom event bus, as this name is already used for your account's default event bus.

    • getEventSourceName

      @Stability(Stable) @Nullable public String getEventSourceName()
      If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
    • setEventSourceName

      @Stability(Stable) public void setEventSourceName(@Nullable String value)
      If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
    • getTags

      @Stability(Stable) @Nullable public List<CfnEventBus.TagEntryProperty> getTags()
      Tags to associate with the event bus.
    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnEventBus.TagEntryProperty> value)
      Tags to associate with the event bus.