software.amazon.awscdk.services.amazonmq

Interface CfnBrokerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBrokerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:15.596Z")
 @Stability(value=Stable)
public interface CfnBrokerProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::AmazonMQ::Broker`.

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.amazonmq.*;
 CfnBrokerProps cfnBrokerProps = CfnBrokerProps.builder()
         .autoMinorVersionUpgrade(false)
         .brokerName("brokerName")
         .deploymentMode("deploymentMode")
         .engineType("engineType")
         .engineVersion("engineVersion")
         .hostInstanceType("hostInstanceType")
         .publiclyAccessible(false)
         .users(List.of(UserProperty.builder()
                 .password("password")
                 .username("username")
                 // the properties below are optional
                 .consoleAccess(false)
                 .groups(List.of("groups"))
                 .build()))
         // the properties below are optional
         .authenticationStrategy("authenticationStrategy")
         .configuration(ConfigurationIdProperty.builder()
                 .id("id")
                 .revision(123)
                 .build())
         .encryptionOptions(EncryptionOptionsProperty.builder()
                 .useAwsOwnedKey(false)
                 // the properties below are optional
                 .kmsKeyId("kmsKeyId")
                 .build())
         .ldapServerMetadata(LdapServerMetadataProperty.builder()
                 .hosts(List.of("hosts"))
                 .roleBase("roleBase")
                 .roleSearchMatching("roleSearchMatching")
                 .serviceAccountPassword("serviceAccountPassword")
                 .serviceAccountUsername("serviceAccountUsername")
                 .userBase("userBase")
                 .userSearchMatching("userSearchMatching")
                 // the properties below are optional
                 .roleName("roleName")
                 .roleSearchSubtree(false)
                 .userRoleName("userRoleName")
                 .userSearchSubtree(false)
                 .build())
         .logs(LogListProperty.builder()
                 .audit(false)
                 .general(false)
                 .build())
         .maintenanceWindowStartTime(MaintenanceWindowProperty.builder()
                 .dayOfWeek("dayOfWeek")
                 .timeOfDay("timeOfDay")
                 .timeZone("timeZone")
                 .build())
         .securityGroups(List.of("securityGroups"))
         .storageType("storageType")
         .subnetIds(List.of("subnetIds"))
         .tags(List.of(TagsEntryProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnBrokerProps.Builder A builder for CfnBrokerProps
static class	CfnBrokerProps.Jsii$Proxy An implementation for CfnBrokerProps

Method Summary

Modifier and Type	Method and Description
static CfnBrokerProps.Builder	builder()
default String	getAuthenticationStrategy() `AWS::AmazonMQ::Broker.AuthenticationStrategy`.
Object	getAutoMinorVersionUpgrade() `AWS::AmazonMQ::Broker.AutoMinorVersionUpgrade`.
String	getBrokerName() `AWS::AmazonMQ::Broker.BrokerName`.
default Object	getConfiguration() `AWS::AmazonMQ::Broker.Configuration`.
String	getDeploymentMode() `AWS::AmazonMQ::Broker.DeploymentMode`.
default Object	getEncryptionOptions() `AWS::AmazonMQ::Broker.EncryptionOptions`.
String	getEngineType() `AWS::AmazonMQ::Broker.EngineType`.
String	getEngineVersion() `AWS::AmazonMQ::Broker.EngineVersion`.
String	getHostInstanceType() `AWS::AmazonMQ::Broker.HostInstanceType`.
default Object	getLdapServerMetadata() `AWS::AmazonMQ::Broker.LdapServerMetadata`.
default Object	getLogs() `AWS::AmazonMQ::Broker.Logs`.
default Object	getMaintenanceWindowStartTime() `AWS::AmazonMQ::Broker.MaintenanceWindowStartTime`.
Object	getPubliclyAccessible() `AWS::AmazonMQ::Broker.PubliclyAccessible`.
default List<String>	getSecurityGroups() `AWS::AmazonMQ::Broker.SecurityGroups`.
default String	getStorageType() `AWS::AmazonMQ::Broker.StorageType`.
default List<String>	getSubnetIds() `AWS::AmazonMQ::Broker.SubnetIds`.
default List<CfnBroker.TagsEntryProperty>	getTags() `AWS::AmazonMQ::Broker.Tags`.
Object	getUsers() `AWS::AmazonMQ::Broker.Users`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAuthenticationStrategy

@Stability(value=Stable)
 @Nullable
default String getAuthenticationStrategy()

`AWS::AmazonMQ::Broker.AuthenticationStrategy`.

getAutoMinorVersionUpgrade

@Stability(value=Stable)
 @NotNull
Object getAutoMinorVersionUpgrade()

`AWS::AmazonMQ::Broker.AutoMinorVersionUpgrade`.

getBrokerName

@Stability(value=Stable)
 @NotNull
String getBrokerName()

`AWS::AmazonMQ::Broker.BrokerName`.

getConfiguration

@Stability(value=Stable)
 @Nullable
default Object getConfiguration()

`AWS::AmazonMQ::Broker.Configuration`.

getDeploymentMode

@Stability(value=Stable)
 @NotNull
String getDeploymentMode()

`AWS::AmazonMQ::Broker.DeploymentMode`.

getEncryptionOptions

@Stability(value=Stable)
 @Nullable
default Object getEncryptionOptions()

`AWS::AmazonMQ::Broker.EncryptionOptions`.

getEngineType

@Stability(value=Stable)
 @NotNull
String getEngineType()

`AWS::AmazonMQ::Broker.EngineType`.

getEngineVersion

@Stability(value=Stable)
 @NotNull
String getEngineVersion()

`AWS::AmazonMQ::Broker.EngineVersion`.

getHostInstanceType

@Stability(value=Stable)
 @NotNull
String getHostInstanceType()

`AWS::AmazonMQ::Broker.HostInstanceType`.

getLdapServerMetadata

@Stability(value=Stable)
 @Nullable
default Object getLdapServerMetadata()

`AWS::AmazonMQ::Broker.LdapServerMetadata`.

getLogs

@Stability(value=Stable)
 @Nullable
default Object getLogs()

`AWS::AmazonMQ::Broker.Logs`.

getMaintenanceWindowStartTime

@Stability(value=Stable)
 @Nullable
default Object getMaintenanceWindowStartTime()

`AWS::AmazonMQ::Broker.MaintenanceWindowStartTime`.

getPubliclyAccessible

@Stability(value=Stable)
 @NotNull
Object getPubliclyAccessible()

`AWS::AmazonMQ::Broker.PubliclyAccessible`.

getSecurityGroups

@Stability(value=Stable)
 @Nullable
default List<String> getSecurityGroups()

`AWS::AmazonMQ::Broker.SecurityGroups`.

getStorageType

@Stability(value=Stable)
 @Nullable
default String getStorageType()

`AWS::AmazonMQ::Broker.StorageType`.

getSubnetIds

@Stability(value=Stable)
 @Nullable
default List<String> getSubnetIds()

`AWS::AmazonMQ::Broker.SubnetIds`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnBroker.TagsEntryProperty> getTags()

`AWS::AmazonMQ::Broker.Tags`.

getUsers

@Stability(value=Stable)
 @NotNull
Object getUsers()

`AWS::AmazonMQ::Broker.Users`.

builder

@Stability(value=Stable)
static CfnBrokerProps.Builder builder()

Returns:

a CfnBrokerProps.Builder of CfnBrokerProps