types

package
v1.27.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 14, 2024 License: Apache-2.0 Imports: 4 Imported by: 7

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionRequired added in v1.13.0 

type ActionRequired struct {

	// The code you can use to find instructions on the action required to resolve
	// your broker issue.
	ActionRequiredCode *string

	// Information about the action required to resolve your broker issue.
	ActionRequiredInfo *string
	// contains filtered or unexported fields
}

Action required for a broker.

type AuthenticationStrategy 

type AuthenticationStrategy string
const (
	AuthenticationStrategySimple AuthenticationStrategy = "SIMPLE"
	AuthenticationStrategyLdap   AuthenticationStrategy = "LDAP"
)

Enum values for AuthenticationStrategy

func (AuthenticationStrategy) Values added in v0.29.0 

func (AuthenticationStrategy) Values() []AuthenticationStrategy

Values returns all known values for AuthenticationStrategy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AvailabilityZone 

type AvailabilityZone struct {

	// Id for the availability zone.
	Name *string
	// contains filtered or unexported fields
}

Name of the availability zone.

type BadRequestException 

type BadRequestException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorAttribute *string
	// contains filtered or unexported fields
}

Returns information about an error.

func (*BadRequestException) Error 

func (e *BadRequestException) Error() string

func (*BadRequestException) ErrorCode 

func (e *BadRequestException) ErrorCode() string

func (*BadRequestException) ErrorFault 

func (e *BadRequestException) ErrorFault() smithy.ErrorFault

func (*BadRequestException) ErrorMessage 

func (e *BadRequestException) ErrorMessage() string

type BrokerEngineType 

type BrokerEngineType struct {

	// The broker's engine type.
	EngineType EngineType

	// The list of engine versions.
	EngineVersions []EngineVersion
	// contains filtered or unexported fields
}

Types of broker engines.

type BrokerInstance 

type BrokerInstance struct {

	// The brokers web console URL.
	ConsoleURL *string

	// The broker's wire-level protocol endpoints.
	Endpoints []string

	// The IP address of the Elastic Network Interface (ENI) attached to the broker.
	// Does not apply to RabbitMQ brokers.
	IpAddress *string
	// contains filtered or unexported fields
}

Returns information about all brokers.

type BrokerInstanceOption 

type BrokerInstanceOption struct {

	// The list of available az.
	AvailabilityZones []AvailabilityZone

	// The broker's engine type.
	EngineType EngineType

	// The broker's instance type.
	HostInstanceType *string

	// The broker's storage type.
	StorageType BrokerStorageType

	// The list of supported deployment modes.
	SupportedDeploymentModes []DeploymentMode

	// The list of supported engine versions.
	SupportedEngineVersions []string
	// contains filtered or unexported fields
}

Option for host instance type.

type BrokerState 

type BrokerState string
const (
	BrokerStateCreationInProgress     BrokerState = "CREATION_IN_PROGRESS"
	BrokerStateCreationFailed         BrokerState = "CREATION_FAILED"
	BrokerStateDeletionInProgress     BrokerState = "DELETION_IN_PROGRESS"
	BrokerStateRunning                BrokerState = "RUNNING"
	BrokerStateRebootInProgress       BrokerState = "REBOOT_IN_PROGRESS"
	BrokerStateCriticalActionRequired BrokerState = "CRITICAL_ACTION_REQUIRED"
	BrokerStateReplica                BrokerState = "REPLICA"
)

Enum values for BrokerState

func (BrokerState) Values added in v0.29.0 

func (BrokerState) Values() []BrokerState

Values returns all known values for BrokerState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BrokerStorageType 

type BrokerStorageType string
const (
	BrokerStorageTypeEbs BrokerStorageType = "EBS"
	BrokerStorageTypeEfs BrokerStorageType = "EFS"
)

Enum values for BrokerStorageType

func (BrokerStorageType) Values added in v0.29.0 

func (BrokerStorageType) Values() []BrokerStorageType

Values returns all known values for BrokerStorageType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BrokerSummary 

type BrokerSummary struct {

	// The broker's deployment mode.
	//
	// This member is required.
	DeploymentMode DeploymentMode

	// The type of broker engine.
	//
	// This member is required.
	EngineType EngineType

	// The broker's Amazon Resource Name (ARN).
	BrokerArn *string

	// The unique ID that Amazon MQ generates for the broker.
	BrokerId *string

	// The broker's name. This value is unique in your Amazon Web Services account,
	// 1-50 characters long, and containing only letters, numbers, dashes, and
	// underscores, and must not contain white spaces, brackets, wildcard characters,
	// or special characters.
	BrokerName *string

	// The broker's status.
	BrokerState BrokerState

	// The time when the broker was created.
	Created *time.Time

	// The broker's instance type.
	HostInstanceType *string
	// contains filtered or unexported fields
}

Returns information about all brokers.

type ChangeType 

type ChangeType string
const (
	ChangeTypeCreate ChangeType = "CREATE"
	ChangeTypeUpdate ChangeType = "UPDATE"
	ChangeTypeDelete ChangeType = "DELETE"
)

Enum values for ChangeType

func (ChangeType) Values added in v0.29.0 

func (ChangeType) Values() []ChangeType

Values returns all known values for ChangeType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Configuration 

type Configuration struct {

	// Required. The ARN of the configuration.
	//
	// This member is required.
	Arn *string

	// Optional. The authentication strategy associated with the configuration. The
	// default is SIMPLE.
	//
	// This member is required.
	AuthenticationStrategy AuthenticationStrategy

	// Required. The date and time of the configuration revision.
	//
	// This member is required.
	Created *time.Time

	// Required. The description of the configuration.
	//
	// This member is required.
	Description *string

	// Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and
	// RABBITMQ.
	//
	// This member is required.
	EngineType EngineType

	// The broker engine version. Defaults to the latest available version for the
	// specified broker engine type. For a list of supported engine versions, see the [ActiveMQ version management]
	// and the [RabbitMQ version management]sections in the Amazon MQ Developer Guide.
	//
	// [RabbitMQ version management]: https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html
	// [ActiveMQ version management]: https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html
	//
	// This member is required.
	EngineVersion *string

	// Required. The unique ID that Amazon MQ generates for the configuration.
	//
	// This member is required.
	Id *string

	// Required. The latest revision of the configuration.
	//
	// This member is required.
	LatestRevision *ConfigurationRevision

	// Required. The name of the configuration. This value can contain only
	// alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~).
	// This value must be 1-150 characters long.
	//
	// This member is required.
	Name *string

	// The list of all tags associated with this configuration.
	Tags map[string]string
	// contains filtered or unexported fields
}

Returns information about all configurations.

type ConfigurationId 

type ConfigurationId struct {

	// Required. The unique ID that Amazon MQ generates for the configuration.
	//
	// This member is required.
	Id *string

	// The revision number of the configuration.
	Revision *int32
	// contains filtered or unexported fields
}

A list of information about the configuration.

type ConfigurationRevision 

type ConfigurationRevision struct {

	// Required. The date and time of the configuration revision.
	//
	// This member is required.
	Created *time.Time

	// Required. The revision number of the configuration.
	//
	// This member is required.
	Revision *int32

	// The description of the configuration revision.
	Description *string
	// contains filtered or unexported fields
}

Returns information about the specified configuration revision.

type Configurations 

type Configurations struct {

	// The broker's current configuration.
	Current *ConfigurationId

	// The history of configurations applied to the broker.
	History []ConfigurationId

	// The broker's pending configuration.
	Pending *ConfigurationId
	// contains filtered or unexported fields
}

Broker configuration information

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorAttribute *string
	// contains filtered or unexported fields
}

Returns information about an error.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type DataReplicationCounterpart added in v1.15.0 

type DataReplicationCounterpart struct {

	// Required. The unique broker id generated by Amazon MQ.
	//
	// This member is required.
	BrokerId *string

	// Required. The region of the broker.
	//
	// This member is required.
	Region *string
	// contains filtered or unexported fields
}

Specifies a broker in a data replication pair.

type DataReplicationMetadataOutput added in v1.15.0 

type DataReplicationMetadataOutput struct {

	// Defines the role of this broker in a data replication pair. When a replica
	// broker is promoted to primary, this role is interchanged.
	//
	// This member is required.
	DataReplicationRole *string

	// Describes the replica/primary broker. Only returned if this broker is currently
	// set as a primary or replica in the broker's dataReplicationRole property.
	DataReplicationCounterpart *DataReplicationCounterpart
	// contains filtered or unexported fields
}

The replication details of the data replication-enabled broker. Only returned if dataReplicationMode or pendingDataReplicationMode is set to CRDR.

type DataReplicationMode added in v1.15.0 

type DataReplicationMode string
const (
	DataReplicationModeNone DataReplicationMode = "NONE"
	DataReplicationModeCrdr DataReplicationMode = "CRDR"
)

Enum values for DataReplicationMode

func (DataReplicationMode) Values added in v1.15.0 

func (DataReplicationMode) Values() []DataReplicationMode

Values returns all known values for DataReplicationMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DayOfWeek 

type DayOfWeek string
const (
	DayOfWeekMonday    DayOfWeek = "MONDAY"
	DayOfWeekTuesday   DayOfWeek = "TUESDAY"
	DayOfWeekWednesday DayOfWeek = "WEDNESDAY"
	DayOfWeekThursday  DayOfWeek = "THURSDAY"
	DayOfWeekFriday    DayOfWeek = "FRIDAY"
	DayOfWeekSaturday  DayOfWeek = "SATURDAY"
	DayOfWeekSunday    DayOfWeek = "SUNDAY"
)

Enum values for DayOfWeek

func (DayOfWeek) Values added in v0.29.0 

func (DayOfWeek) Values() []DayOfWeek

Values returns all known values for DayOfWeek. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DeploymentMode 

type DeploymentMode string
const (
	DeploymentModeSingleInstance       DeploymentMode = "SINGLE_INSTANCE"
	DeploymentModeActiveStandbyMultiAz DeploymentMode = "ACTIVE_STANDBY_MULTI_AZ"
	DeploymentModeClusterMultiAz       DeploymentMode = "CLUSTER_MULTI_AZ"
)

Enum values for DeploymentMode

func (DeploymentMode) Values added in v0.29.0 

func (DeploymentMode) Values() []DeploymentMode

Values returns all known values for DeploymentMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EncryptionOptions 

type EncryptionOptions struct {

	// Enables the use of an Amazon Web Services owned CMK using KMS (KMS). Set to
	// true by default, if no value is provided, for example, for RabbitMQ brokers.
	//
	// This member is required.
	UseAwsOwnedKey *bool

	// The customer master key (CMK) to use for the A KMS (KMS). This key is used to
	// encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to
	// encrypt your data.
	KmsKeyId *string
	// contains filtered or unexported fields
}

Encryption options for the broker.

type EngineType 

type EngineType string
const (
	EngineTypeActivemq EngineType = "ACTIVEMQ"
	EngineTypeRabbitmq EngineType = "RABBITMQ"
)

Enum values for EngineType

func (EngineType) Values added in v0.29.0 

func (EngineType) Values() []EngineType

Values returns all known values for EngineType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EngineVersion 

type EngineVersion struct {

	// Id for the version.
	Name *string
	// contains filtered or unexported fields
}

Id of the engine version.

type ForbiddenException 

type ForbiddenException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorAttribute *string
	// contains filtered or unexported fields
}

Returns information about an error.

func (*ForbiddenException) Error 

func (e *ForbiddenException) Error() string

func (*ForbiddenException) ErrorCode 

func (e *ForbiddenException) ErrorCode() string

func (*ForbiddenException) ErrorFault 

func (e *ForbiddenException) ErrorFault() smithy.ErrorFault

func (*ForbiddenException) ErrorMessage 

func (e *ForbiddenException) ErrorMessage() string

type InternalServerErrorException 

type InternalServerErrorException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorAttribute *string
	// contains filtered or unexported fields
}

Returns information about an error.

func (*InternalServerErrorException) Error 

func (e *InternalServerErrorException) Error() string

func (*InternalServerErrorException) ErrorCode 

func (e *InternalServerErrorException) ErrorCode() string

func (*InternalServerErrorException) ErrorFault 

func (e *InternalServerErrorException) ErrorFault() smithy.ErrorFault

func (*InternalServerErrorException) ErrorMessage 

func (e *InternalServerErrorException) ErrorMessage() string

type LdapServerMetadataInput 

type LdapServerMetadataInput struct {

	// Specifies the location of the LDAP server such as Directory Service for
	// Microsoft Active Directory. Optional failover server.
	//
	// This member is required.
	Hosts []string

	// The distinguished name of the node in the directory information tree (DIT) to
	// search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example,
	// dc=com.
	//
	// This member is required.
	RoleBase *string

	// The LDAP search filter used to find roles within the roleBase. The
	// distinguished name of the user matched by userSearchMatching is substituted into
	// the {0} placeholder in the search filter. The client's username is substituted
	// into the {1} placeholder. For example, if you set this option to
	// (member=uid={1})for the user janedoe, the search filter becomes
	// (member=uid=janedoe) after string substitution. It matches all role entries that
	// have a member attribute equal to uid=janedoe under the subtree selected by the
	// roleBase.
	//
	// This member is required.
	RoleSearchMatching *string

	// Service account password. A service account is an account in your LDAP server
	// that has access to initiate a connection. For example, cn=admin,dc=corp,
	// dc=example, dc=com.
	//
	// This member is required.
	ServiceAccountPassword *string

	// Service account username. A service account is an account in your LDAP server
	// that has access to initiate a connection. For example, cn=admin,dc=corp,
	// dc=example, dc=com.
	//
	// This member is required.
	ServiceAccountUsername *string

	// Select a particular subtree of the directory information tree (DIT) to search
	// for user entries. The subtree is specified by a DN, which specifies the base
	// node of the subtree. For example, by setting this option to ou=Users,ou=corp,
	// dc=corp, dc=example, dc=com, the search for user entries is restricted to the
	// subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.
	//
	// This member is required.
	UserBase *string

	// The LDAP search filter used to find users within the userBase. The client's
	// username is substituted into the {0} placeholder in the search filter. For
	// example, if this option is set to (uid={0}) and the received username is
	// janedoe, the search filter becomes (uid=janedoe) after string substitution. It
	// will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp,
	// dc=example, dc=com.
	//
	// This member is required.
	UserSearchMatching *string

	// Specifies the LDAP attribute that identifies the group name attribute in the
	// object returned from the group membership query.
	RoleName *string

	// The directory search scope for the role. If set to true, scope is to search the
	// entire subtree.
	RoleSearchSubtree *bool

	// Specifies the name of the LDAP attribute for the user group membership.
	UserRoleName *string

	// The directory search scope for the user. If set to true, scope is to search the
	// entire subtree.
	UserSearchSubtree *bool
	// contains filtered or unexported fields
}

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.

Does not apply to RabbitMQ brokers.

type LdapServerMetadataOutput 

type LdapServerMetadataOutput struct {

	// Specifies the location of the LDAP server such as Directory Service for
	// Microsoft Active Directory. Optional failover server.
	//
	// This member is required.
	Hosts []string

	// The distinguished name of the node in the directory information tree (DIT) to
	// search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example,
	// dc=com.
	//
	// This member is required.
	RoleBase *string

	// The LDAP search filter used to find roles within the roleBase. The
	// distinguished name of the user matched by userSearchMatching is substituted into
	// the {0} placeholder in the search filter. The client's username is substituted
	// into the {1} placeholder. For example, if you set this option to
	// (member=uid={1})for the user janedoe, the search filter becomes
	// (member=uid=janedoe) after string substitution. It matches all role entries that
	// have a member attribute equal to uid=janedoe under the subtree selected by the
	// roleBase.
	//
	// This member is required.
	RoleSearchMatching *string

	// Service account username. A service account is an account in your LDAP server
	// that has access to initiate a connection. For example, cn=admin,dc=corp,
	// dc=example, dc=com.
	//
	// This member is required.
	ServiceAccountUsername *string

	// Select a particular subtree of the directory information tree (DIT) to search
	// for user entries. The subtree is specified by a DN, which specifies the base
	// node of the subtree. For example, by setting this option to ou=Users,ou=corp,
	// dc=corp, dc=example, dc=com, the search for user entries is restricted to the
	// subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.
	//
	// This member is required.
	UserBase *string

	// The LDAP search filter used to find users within the userBase. The client's
	// username is substituted into the {0} placeholder in the search filter. For
	// example, if this option is set to (uid={0}) and the received username is
	// janedoe, the search filter becomes (uid=janedoe) after string substitution. It
	// will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp,
	// dc=example, dc=com.
	//
	// This member is required.
	UserSearchMatching *string

	// Specifies the LDAP attribute that identifies the group name attribute in the
	// object returned from the group membership query.
	RoleName *string

	// The directory search scope for the role. If set to true, scope is to search the
	// entire subtree.
	RoleSearchSubtree *bool

	// Specifies the name of the LDAP attribute for the user group membership.
	UserRoleName *string

	// The directory search scope for the user. If set to true, scope is to search the
	// entire subtree.
	UserSearchSubtree *bool
	// contains filtered or unexported fields
}

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.

type Logs 

type Logs struct {

	// Enables audit logging. Every user management action made using JMX or the
	// ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
	Audit *bool

	// Enables general logging.
	General *bool
	// contains filtered or unexported fields
}

The list of information about logs to be enabled for the specified broker.

type LogsSummary 

type LogsSummary struct {

	// Enables general logging.
	//
	// This member is required.
	General *bool

	// The location of the CloudWatch Logs log group where general logs are sent.
	//
	// This member is required.
	GeneralLogGroup *string

	// Enables audit logging. Every user management action made using JMX or the
	// ActiveMQ Web Console is logged.
	Audit *bool

	// The location of the CloudWatch Logs log group where audit logs are sent.
	AuditLogGroup *string

	// The list of information about logs pending to be deployed for the specified
	// broker.
	Pending *PendingLogs
	// contains filtered or unexported fields
}

The list of information about logs currently enabled and pending to be deployed for the specified broker.

type NotFoundException 

type NotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorAttribute *string
	// contains filtered or unexported fields
}

Returns information about an error.

func (*NotFoundException) Error 

func (e *NotFoundException) Error() string

func (*NotFoundException) ErrorCode 

func (e *NotFoundException) ErrorCode() string

func (*NotFoundException) ErrorFault 

func (e *NotFoundException) ErrorFault() smithy.ErrorFault

func (*NotFoundException) ErrorMessage 

func (e *NotFoundException) ErrorMessage() string

type PendingLogs 

type PendingLogs struct {

	// Enables audit logging. Every user management action made using JMX or the
	// ActiveMQ Web Console is logged.
	Audit *bool

	// Enables general logging.
	General *bool
	// contains filtered or unexported fields
}

The list of information about logs to be enabled for the specified broker.

type PromoteMode added in v1.15.0 

type PromoteMode string
const (
	PromoteModeSwitchover PromoteMode = "SWITCHOVER"
	PromoteModeFailover   PromoteMode = "FAILOVER"
)

Enum values for PromoteMode

func (PromoteMode) Values added in v1.15.0 

func (PromoteMode) Values() []PromoteMode

Values returns all known values for PromoteMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SanitizationWarning 

type SanitizationWarning struct {

	// The reason for which the configuration elements or attributes were sanitized.
	//
	// This member is required.
	Reason SanitizationWarningReason

	// The name of the configuration attribute that has been sanitized.
	AttributeName *string

	// The name of the configuration element that has been sanitized.
	ElementName *string
	// contains filtered or unexported fields
}

Returns information about the configuration element or attribute that was sanitized in the configuration.

type SanitizationWarningReason 

type SanitizationWarningReason string
const (
	SanitizationWarningReasonDisallowedElementRemoved     SanitizationWarningReason = "DISALLOWED_ELEMENT_REMOVED"
	SanitizationWarningReasonDisallowedAttributeRemoved   SanitizationWarningReason = "DISALLOWED_ATTRIBUTE_REMOVED"
	SanitizationWarningReasonInvalidAttributeValueRemoved SanitizationWarningReason = "INVALID_ATTRIBUTE_VALUE_REMOVED"
)

Enum values for SanitizationWarningReason

func (SanitizationWarningReason) Values added in v0.29.0 

func (SanitizationWarningReason) Values() []SanitizationWarningReason

Values returns all known values for SanitizationWarningReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type UnauthorizedException 

type UnauthorizedException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorAttribute *string
	// contains filtered or unexported fields
}

Returns information about an error.

func (*UnauthorizedException) Error 

func (e *UnauthorizedException) Error() string

func (*UnauthorizedException) ErrorCode 

func (e *UnauthorizedException) ErrorCode() string

func (*UnauthorizedException) ErrorFault 

func (e *UnauthorizedException) ErrorFault() smithy.ErrorFault

func (*UnauthorizedException) ErrorMessage 

func (e *UnauthorizedException) ErrorMessage() string

type User 

type User struct {

	// Required. The password of the user. This value must be at least 12 characters
	// long, must contain at least 4 unique characters, and must not contain commas,
	// colons, or equal signs (,:=).
	//
	// This member is required.
	Password *string

	// The username of the broker user. The following restrictions apply to broker
	// usernames:
	//
	//   - For Amazon MQ for ActiveMQ brokers, this value can contain only
	//   alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~).
	//   This value must be 2-100 characters long.
	//
	//   - para>For Amazon MQ for RabbitMQ brokers, this value can contain only
	//   alphanumeric characters, dashes, periods, underscores (- . _). This value must
	//   not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid
	//   usename. This value must be 2-100 characters long.
	//
	// Do not add personally identifiable information (PII) or other confidential or
	// sensitive information in broker usernames. Broker usernames are accessible to
	// other Amazon Web Services services, including CloudWatch Logs. Broker usernames
	// are not intended to be used for private or sensitive data.
	//
	// This member is required.
	Username *string

	// Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not
	// apply to RabbitMQ brokers.
	ConsoleAccess *bool

	// The list of groups (20 maximum) to which the ActiveMQ user belongs. This value
	// can contain only alphanumeric characters, dashes, periods, underscores, and
	// tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to
	// RabbitMQ brokers.
	Groups []string

	// Defines if this user is intended for CRDR replication purposes.
	ReplicationUser *bool
	// contains filtered or unexported fields
}

A user associated with the broker. For Amazon MQ for RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.

type UserPendingChanges 

type UserPendingChanges struct {

	// Required. The type of change pending for the ActiveMQ user.
	//
	// This member is required.
	PendingChange ChangeType

	// Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
	ConsoleAccess *bool

	// The list of groups (20 maximum) to which the ActiveMQ user belongs. This value
	// can contain only alphanumeric characters, dashes, periods, underscores, and
	// tildes (- . _ ~). This value must be 2-100 characters long.
	Groups []string
	// contains filtered or unexported fields
}

Returns information about the status of the changes pending for the ActiveMQ user.

type UserSummary 

type UserSummary struct {

	// Required. The username of the broker user. This value can contain only
	// alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~).
	// This value must be 2-100 characters long.
	//
	// This member is required.
	Username *string

	// The type of change pending for the broker user.
	PendingChange ChangeType
	// contains filtered or unexported fields
}

Returns a list of all broker users. Does not apply to RabbitMQ brokers.

type WeeklyStartTime 

type WeeklyStartTime struct {

	// Required. The day of the week.
	//
	// This member is required.
	DayOfWeek DayOfWeek

	// Required. The time, in 24-hour format.
	//
	// This member is required.
	TimeOfDay *string

	// The time zone, UTC by default, in either the Country/City format, or the UTC
	// offset format.
	TimeZone *string
	// contains filtered or unexported fields
}

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.