@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:45.849Z") public class CfnEventSubscription extends CfnResource implements IInspectable
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.redshift.*; CfnEventSubscription cfnEventSubscription = CfnEventSubscription.Builder.create(this, "MyCfnEventSubscription") .subscriptionName("subscriptionName") // the properties below are optional .enabled(false) .eventCategories(List.of("eventCategories")) .severity("severity") .snsTopicArn("snsTopicArn") .sourceIds(List.of("sourceIds")) .sourceType("sourceType") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnEventSubscription.Builder
A fluent builder for
CfnEventSubscription . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnEventSubscription(Construct scope,
java.lang.String id,
CfnEventSubscriptionProps props)
Create a new `AWS::Redshift::EventSubscription`.
|
protected |
CfnEventSubscription(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnEventSubscription(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrCustomerAwsId()
The AWS account associated with the Amazon Redshift event notification subscription.
|
java.lang.String |
getAttrCustSubscriptionId()
The name of the Amazon Redshift event notification subscription.
|
java.util.List<java.lang.String> |
getAttrEventCategoriesList()
The list of Amazon Redshift event categories specified in the event notification subscription.
|
java.util.List<java.lang.String> |
getAttrSourceIdsList()
A list of the sources that publish events to the Amazon Redshift event notification subscription.
|
java.lang.String |
getAttrStatus()
The status of the Amazon Redshift event notification subscription.
|
java.lang.String |
getAttrSubscriptionCreationTime()
The date and time the Amazon Redshift event notification subscription was created.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getEnabled()
A boolean value;
|
java.util.List<java.lang.String> |
getEventCategories()
Specifies the Amazon Redshift event categories to be published by the event notification subscription.
|
java.lang.String |
getSeverity()
Specifies the Amazon Redshift event severity to be published by the event notification subscription.
|
java.lang.String |
getSnsTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.
|
java.util.List<java.lang.String> |
getSourceIds()
A list of one or more identifiers of Amazon Redshift source objects.
|
java.lang.String |
getSourceType()
The type of source that will be generating the events.
|
java.lang.String |
getSubscriptionName()
The name of the event subscription to be created.
|
TagManager |
getTags()
A list of tag instances.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setEnabled(java.lang.Boolean value)
A boolean value;
|
void |
setEnabled(IResolvable value)
A boolean value;
|
void |
setEventCategories(java.util.List<java.lang.String> value)
Specifies the Amazon Redshift event categories to be published by the event notification subscription.
|
void |
setSeverity(java.lang.String value)
Specifies the Amazon Redshift event severity to be published by the event notification subscription.
|
void |
setSnsTopicArn(java.lang.String value)
The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.
|
void |
setSourceIds(java.util.List<java.lang.String> value)
A list of one or more identifiers of Amazon Redshift source objects.
|
void |
setSourceType(java.lang.String value)
The type of source that will be generating the events.
|
void |
setSubscriptionName(java.lang.String value)
The name of the event subscription to be created.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnEventSubscription(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnEventSubscription(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnEventSubscription(Construct scope, java.lang.String id, CfnEventSubscriptionProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrCustomerAwsId()
public java.lang.String getAttrCustSubscriptionId()
public java.util.List<java.lang.String> getAttrEventCategoriesList()
Values: Configuration, Management, Monitoring, Security, Pending
public java.util.List<java.lang.String> getAttrSourceIdsList()
public java.lang.String getAttrStatus()
Constraints:
public java.lang.String getAttrSubscriptionCreationTime()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getSubscriptionName()
Constraints:
public void setSubscriptionName(java.lang.String value)
Constraints:
public java.lang.Object getEnabled()
set to true
to activate the subscription, and set to false
to create the subscription but not activate it.
public void setEnabled(java.lang.Boolean value)
set to true
to activate the subscription, and set to false
to create the subscription but not activate it.
public void setEnabled(IResolvable value)
set to true
to activate the subscription, and set to false
to create the subscription but not activate it.
public java.util.List<java.lang.String> getEventCategories()
Values: configuration, management, monitoring, security, pending
public void setEventCategories(java.util.List<java.lang.String> value)
Values: configuration, management, monitoring, security, pending
public java.lang.String getSeverity()
Values: ERROR, INFO
public void setSeverity(java.lang.String value)
Values: ERROR, INFO
public java.lang.String getSnsTopicArn()
The ARN is created by Amazon SNS when you create a topic and subscribe to it.
public void setSnsTopicArn(java.lang.String value)
The ARN is created by Amazon SNS when you create a topic and subscribe to it.
public java.util.List<java.lang.String> getSourceIds()
All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
public void setSourceIds(java.util.List<java.lang.String> value)
All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
public java.lang.String getSourceType()
For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account . You must specify a source type in order to specify source IDs.
Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.
public void setSourceType(java.lang.String value)
For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account . You must specify a source type in order to specify source IDs.
Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.