Package software.amazon.awssdk.services.config.model

Class DeliveryChannel

java.lang.Object

software.amazon.awssdk.services.config.model.DeliveryChannel

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DeliveryChannel.Builder,DeliveryChannel>

@Generated("software.amazon.awssdk:codegen")
public final class DeliveryChannel
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DeliveryChannel.Builder,DeliveryChannel>

The channel through which Config delivers notifications and updated configuration states.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeliveryChannel.Builder

Method Summary

Modifier and Type	Method	Description
static DeliveryChannel.Builder	builder()
ConfigSnapshotDeliveryProperties	configSnapshotDeliveryProperties()	The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the delivery channel.
String	s3BucketName()	The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.
String	s3KeyPrefix()	The prefix for the specified Amazon S3 bucket.
String	s3KmsKeyArn()	The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config.
List<SdkField<?>>	sdkFields()
static Class<? extends DeliveryChannel.Builder>	serializableBuilderClass()
String	snsTopicARN()	The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.
DeliveryChannel.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of the delivery channel. By default, Config assigns the name "default" when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.

Returns:

The name of the delivery channel. By default, Config assigns the name "default" when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.

s3BucketName

public final String s3BucketName()

The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.

If you specify a bucket that belongs to another Amazon Web Services account, that bucket must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon S3 Bucket in the Config Developer Guide.

Returns:

The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.

If you specify a bucket that belongs to another Amazon Web Services account, that bucket must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon S3 Bucket in the Config Developer Guide.

s3KeyPrefix

public final String s3KeyPrefix()

The prefix for the specified Amazon S3 bucket.

Returns:

The prefix for the specified Amazon S3 bucket.

s3KmsKeyArn

public final String s3KmsKeyArn()

The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config. Must belong to the same Region as the destination S3 bucket.

Returns:

The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config. Must belong to the same Region as the destination S3 bucket.

snsTopicARN

public final String snsTopicARN()

The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.

If you choose a topic from another account, the topic must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon SNS Topic in the Config Developer Guide.

Returns:

The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.

If you choose a topic from another account, the topic must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon SNS Topic in the Config Developer Guide.

configSnapshotDeliveryProperties

public final ConfigSnapshotDeliveryProperties configSnapshotDeliveryProperties()

The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.

Returns:

The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.

toBuilder

public DeliveryChannel.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeliveryChannel.Builder,DeliveryChannel>

builder

public static DeliveryChannel.Builder builder()

serializableBuilderClass

public static Class<? extends DeliveryChannel.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo