Package io.micronaut.objectstorage.aws

Class AwsS3Configuration

java.lang.Object

io.micronaut.objectstorage.configuration.AbstractObjectStorageModuleConfiguration

io.micronaut.objectstorage.configuration.AbstractObjectStorageConfiguration

io.micronaut.objectstorage.aws.AwsS3Configuration

All Implemented Interfaces:

io.micronaut.core.naming.Named, io.micronaut.core.util.Toggleable, ObjectStorageConfiguration, ObjectStorageModuleConfiguration

@EachProperty("micronaut.object-storage.aws")
@Introspected
public class AwsS3Configuration
extends AbstractObjectStorageConfiguration

AWS object storage configuration properties.

Since:

1.0

Author:

Pavol Gressa

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	Configuration Prefix ending.
static final String	PREFIX	Configuration Prefix.

Fields inherited from class io.micronaut.objectstorage.configuration.AbstractObjectStorageConfiguration

name

Fields inherited from class io.micronaut.objectstorage.configuration.AbstractObjectStorageModuleConfiguration

enabled

Fields inherited from interface io.micronaut.objectstorage.configuration.ObjectStorageModuleConfiguration

DEFAULT_ENABLED

Constructor Summary

Constructors

Constructor	Description
AwsS3Configuration(String name)

Method Summary

Modifier and Type	Method	Description
@NonNull String	getBucket()	The name of the AWS S3 bucket.
boolean	isEnabled()	Whether to enable or disable this object storage.
void	setBucket(@NonNull String bucket)

Methods inherited from class io.micronaut.objectstorage.configuration.AbstractObjectStorageConfiguration

getName

Methods inherited from class io.micronaut.objectstorage.configuration.AbstractObjectStorageModuleConfiguration

setEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

Configuration Prefix ending.

See Also:

• Constant Field Values

PREFIX

public static final String PREFIX

Configuration Prefix.

See Also:

• Constant Field Values

Constructor Details

AwsS3Configuration

public AwsS3Configuration(@Parameter
 String name)

Parameters:

name - Bean Qualifier name

Method Details

getBucket

@NonNull
public @NonNull String getBucket()

The name of the AWS S3 bucket.

Returns:

The name of the AWS S3 bucket.

setBucket

public void setBucket(@NonNull
 @NonNull String bucket)

Parameters:

bucket - The name of the AWS S3 bucket.

isEnabled

public boolean isEnabled()

Whether to enable or disable this object storage.

Since:

2.0.2