securityhub

package
v1.42.9 Latest Latest
Warning

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

Go to latest
Published: Aug 3, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package securityhub provides the client and types for making API requests to AWS SecurityHub.

Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services environment and resources. It also provides you with the readiness status of your environment based on controls from supported security standards. Security Hub collects security data from Amazon Web Services accounts, services, and integrated third-party products and helps you analyze security trends in your environment to identify the highest priority security issues. For more information about Security Hub, see the Security HubUser Guide (https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html).

When you use operations in the Security Hub API, the requests are executed only in the Amazon Web Services Region that is currently active or in the specific Amazon Web Services Region that you specify in your request. Any configuration or settings change that results from the operation is applied only to that Region. To make the same change in other Regions, run the same command for each Region in which you want to apply the change.

For example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of the member account with the administrator account is created only in the us-west-2 Region. Security Hub must be enabled for the member account in the same Region that the invitation was sent from.

The following throttling limits apply to using Security Hub API operations.

  • BatchEnableStandards - RateLimit of 1 request per second. BurstLimit of 1 request per second.

  • GetFindings - RateLimit of 3 requests per second. BurstLimit of 6 requests per second.

  • BatchImportFindings - RateLimit of 10 requests per second. BurstLimit of 30 requests per second.

  • BatchUpdateFindings - RateLimit of 10 requests per second. BurstLimit of 30 requests per second.

  • UpdateStandardsControl - RateLimit of 1 request per second. BurstLimit of 5 requests per second.

  • All other operations - RateLimit of 10 requests per second. BurstLimit of 30 requests per second.

See https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26 for more information on this service.

See securityhub package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/securityhub/

Using the Client

To contact AWS SecurityHub with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS SecurityHub client SecurityHub for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/securityhub/#New

Index

Examples

Constants

View Source
const (
	// AdminStatusEnabled is a AdminStatus enum value
	AdminStatusEnabled = "ENABLED"

	// AdminStatusDisableInProgress is a AdminStatus enum value
	AdminStatusDisableInProgress = "DISABLE_IN_PROGRESS"
)
View Source
const (
	// AssociationStatusEnabled is a AssociationStatus enum value
	AssociationStatusEnabled = "ENABLED"

	// AssociationStatusDisabled is a AssociationStatus enum value
	AssociationStatusDisabled = "DISABLED"
)
View Source
const (
	// AutoEnableStandardsNone is a AutoEnableStandards enum value
	AutoEnableStandardsNone = "NONE"

	// AutoEnableStandardsDefault is a AutoEnableStandards enum value
	AutoEnableStandardsDefault = "DEFAULT"
)
View Source
const (
	// AwsIamAccessKeyStatusActive is a AwsIamAccessKeyStatus enum value
	AwsIamAccessKeyStatusActive = "Active"

	// AwsIamAccessKeyStatusInactive is a AwsIamAccessKeyStatus enum value
	AwsIamAccessKeyStatusInactive = "Inactive"
)
View Source
const (
	// AwsS3BucketNotificationConfigurationS3KeyFilterRuleNamePrefix is a AwsS3BucketNotificationConfigurationS3KeyFilterRuleName enum value
	AwsS3BucketNotificationConfigurationS3KeyFilterRuleNamePrefix = "Prefix"

	// AwsS3BucketNotificationConfigurationS3KeyFilterRuleNameSuffix is a AwsS3BucketNotificationConfigurationS3KeyFilterRuleName enum value
	AwsS3BucketNotificationConfigurationS3KeyFilterRuleNameSuffix = "Suffix"
)
View Source
const (
	// ComplianceStatusPassed is a ComplianceStatus enum value
	ComplianceStatusPassed = "PASSED"

	// ComplianceStatusWarning is a ComplianceStatus enum value
	ComplianceStatusWarning = "WARNING"

	// ComplianceStatusFailed is a ComplianceStatus enum value
	ComplianceStatusFailed = "FAILED"

	// ComplianceStatusNotAvailable is a ComplianceStatus enum value
	ComplianceStatusNotAvailable = "NOT_AVAILABLE"
)
View Source
const (
	// ControlFindingGeneratorStandardControl is a ControlFindingGenerator enum value
	ControlFindingGeneratorStandardControl = "STANDARD_CONTROL"

	// ControlFindingGeneratorSecurityControl is a ControlFindingGenerator enum value
	ControlFindingGeneratorSecurityControl = "SECURITY_CONTROL"
)
View Source
const (
	// ControlStatusEnabled is a ControlStatus enum value
	ControlStatusEnabled = "ENABLED"

	// ControlStatusDisabled is a ControlStatus enum value
	ControlStatusDisabled = "DISABLED"
)
View Source
const (
	// FindingHistoryUpdateSourceTypeBatchUpdateFindings is a FindingHistoryUpdateSourceType enum value
	FindingHistoryUpdateSourceTypeBatchUpdateFindings = "BATCH_UPDATE_FINDINGS"

	// FindingHistoryUpdateSourceTypeBatchImportFindings is a FindingHistoryUpdateSourceType enum value
	FindingHistoryUpdateSourceTypeBatchImportFindings = "BATCH_IMPORT_FINDINGS"
)
View Source
const (
	// IntegrationTypeSendFindingsToSecurityHub is a IntegrationType enum value
	IntegrationTypeSendFindingsToSecurityHub = "SEND_FINDINGS_TO_SECURITY_HUB"

	// IntegrationTypeReceiveFindingsFromSecurityHub is a IntegrationType enum value
	IntegrationTypeReceiveFindingsFromSecurityHub = "RECEIVE_FINDINGS_FROM_SECURITY_HUB"

	// IntegrationTypeUpdateFindingsInSecurityHub is a IntegrationType enum value
	IntegrationTypeUpdateFindingsInSecurityHub = "UPDATE_FINDINGS_IN_SECURITY_HUB"
)
View Source
const (
	// MalwareStateObserved is a MalwareState enum value
	MalwareStateObserved = "OBSERVED"

	// MalwareStateRemovalFailed is a MalwareState enum value
	MalwareStateRemovalFailed = "REMOVAL_FAILED"

	// MalwareStateRemoved is a MalwareState enum value
	MalwareStateRemoved = "REMOVED"
)
View Source
const (
	// MalwareTypeAdware is a MalwareType enum value
	MalwareTypeAdware = "ADWARE"

	// MalwareTypeBlendedThreat is a MalwareType enum value
	MalwareTypeBlendedThreat = "BLENDED_THREAT"

	// MalwareTypeBotnetAgent is a MalwareType enum value
	MalwareTypeBotnetAgent = "BOTNET_AGENT"

	// MalwareTypeCoinMiner is a MalwareType enum value
	MalwareTypeCoinMiner = "COIN_MINER"

	// MalwareTypeExploitKit is a MalwareType enum value
	MalwareTypeExploitKit = "EXPLOIT_KIT"

	// MalwareTypeKeylogger is a MalwareType enum value
	MalwareTypeKeylogger = "KEYLOGGER"

	// MalwareTypeMacro is a MalwareType enum value
	MalwareTypeMacro = "MACRO"

	// MalwareTypePotentiallyUnwanted is a MalwareType enum value
	MalwareTypePotentiallyUnwanted = "POTENTIALLY_UNWANTED"

	// MalwareTypeSpyware is a MalwareType enum value
	MalwareTypeSpyware = "SPYWARE"

	// MalwareTypeRansomware is a MalwareType enum value
	MalwareTypeRansomware = "RANSOMWARE"

	// MalwareTypeRemoteAccess is a MalwareType enum value
	MalwareTypeRemoteAccess = "REMOTE_ACCESS"

	// MalwareTypeRootkit is a MalwareType enum value
	MalwareTypeRootkit = "ROOTKIT"

	// MalwareTypeTrojan is a MalwareType enum value
	MalwareTypeTrojan = "TROJAN"

	// MalwareTypeVirus is a MalwareType enum value
	MalwareTypeVirus = "VIRUS"

	// MalwareTypeWorm is a MalwareType enum value
	MalwareTypeWorm = "WORM"
)
View Source
const (
	// MapFilterComparisonEquals is a MapFilterComparison enum value
	MapFilterComparisonEquals = "EQUALS"

	// MapFilterComparisonNotEquals is a MapFilterComparison enum value
	MapFilterComparisonNotEquals = "NOT_EQUALS"

	// MapFilterComparisonContains is a MapFilterComparison enum value
	MapFilterComparisonContains = "CONTAINS"

	// MapFilterComparisonNotContains is a MapFilterComparison enum value
	MapFilterComparisonNotContains = "NOT_CONTAINS"
)
View Source
const (
	// NetworkDirectionIn is a NetworkDirection enum value
	NetworkDirectionIn = "IN"

	// NetworkDirectionOut is a NetworkDirection enum value
	NetworkDirectionOut = "OUT"
)
View Source
const (
	// PartitionAws is a Partition enum value
	PartitionAws = "aws"

	// PartitionAwsCn is a Partition enum value
	PartitionAwsCn = "aws-cn"

	// PartitionAwsUsGov is a Partition enum value
	PartitionAwsUsGov = "aws-us-gov"
)
View Source
const (
	// RecordStateActive is a RecordState enum value
	RecordStateActive = "ACTIVE"

	// RecordStateArchived is a RecordState enum value
	RecordStateArchived = "ARCHIVED"
)
View Source
const (
	// RegionAvailabilityStatusAvailable is a RegionAvailabilityStatus enum value
	RegionAvailabilityStatusAvailable = "AVAILABLE"

	// RegionAvailabilityStatusUnavailable is a RegionAvailabilityStatus enum value
	RegionAvailabilityStatusUnavailable = "UNAVAILABLE"
)
View Source
const (
	// RuleStatusEnabled is a RuleStatus enum value
	RuleStatusEnabled = "ENABLED"

	// RuleStatusDisabled is a RuleStatus enum value
	RuleStatusDisabled = "DISABLED"
)
View Source
const (
	// SeverityLabelInformational is a SeverityLabel enum value
	SeverityLabelInformational = "INFORMATIONAL"

	// SeverityLabelLow is a SeverityLabel enum value
	SeverityLabelLow = "LOW"

	// SeverityLabelMedium is a SeverityLabel enum value
	SeverityLabelMedium = "MEDIUM"

	// SeverityLabelHigh is a SeverityLabel enum value
	SeverityLabelHigh = "HIGH"

	// SeverityLabelCritical is a SeverityLabel enum value
	SeverityLabelCritical = "CRITICAL"
)
View Source
const (
	// SeverityRatingLow is a SeverityRating enum value
	SeverityRatingLow = "LOW"

	// SeverityRatingMedium is a SeverityRating enum value
	SeverityRatingMedium = "MEDIUM"

	// SeverityRatingHigh is a SeverityRating enum value
	SeverityRatingHigh = "HIGH"

	// SeverityRatingCritical is a SeverityRating enum value
	SeverityRatingCritical = "CRITICAL"
)
View Source
const (
	// SortOrderAsc is a SortOrder enum value
	SortOrderAsc = "asc"

	// SortOrderDesc is a SortOrder enum value
	SortOrderDesc = "desc"
)
View Source
const (
	// StandardsStatusPending is a StandardsStatus enum value
	StandardsStatusPending = "PENDING"

	// StandardsStatusReady is a StandardsStatus enum value
	StandardsStatusReady = "READY"

	// StandardsStatusFailed is a StandardsStatus enum value
	StandardsStatusFailed = "FAILED"

	// StandardsStatusDeleting is a StandardsStatus enum value
	StandardsStatusDeleting = "DELETING"

	// StandardsStatusIncomplete is a StandardsStatus enum value
	StandardsStatusIncomplete = "INCOMPLETE"
)
View Source
const (
	// StatusReasonCodeNoAvailableConfigurationRecorder is a StatusReasonCode enum value
	StatusReasonCodeNoAvailableConfigurationRecorder = "NO_AVAILABLE_CONFIGURATION_RECORDER"

	// StatusReasonCodeInternalError is a StatusReasonCode enum value
	StatusReasonCodeInternalError = "INTERNAL_ERROR"
)
View Source
const (
	// StringFilterComparisonEquals is a StringFilterComparison enum value
	StringFilterComparisonEquals = "EQUALS"

	// StringFilterComparisonPrefix is a StringFilterComparison enum value
	StringFilterComparisonPrefix = "PREFIX"

	// StringFilterComparisonNotEquals is a StringFilterComparison enum value
	StringFilterComparisonNotEquals = "NOT_EQUALS"

	// StringFilterComparisonPrefixNotEquals is a StringFilterComparison enum value
	StringFilterComparisonPrefixNotEquals = "PREFIX_NOT_EQUALS"

	// StringFilterComparisonContains is a StringFilterComparison enum value
	StringFilterComparisonContains = "CONTAINS"

	// StringFilterComparisonNotContains is a StringFilterComparison enum value
	StringFilterComparisonNotContains = "NOT_CONTAINS"
)
View Source
const (
	// ThreatIntelIndicatorCategoryBackdoor is a ThreatIntelIndicatorCategory enum value
	ThreatIntelIndicatorCategoryBackdoor = "BACKDOOR"

	// ThreatIntelIndicatorCategoryCardStealer is a ThreatIntelIndicatorCategory enum value
	ThreatIntelIndicatorCategoryCardStealer = "CARD_STEALER"

	// ThreatIntelIndicatorCategoryCommandAndControl is a ThreatIntelIndicatorCategory enum value
	ThreatIntelIndicatorCategoryCommandAndControl = "COMMAND_AND_CONTROL"

	// ThreatIntelIndicatorCategoryDropSite is a ThreatIntelIndicatorCategory enum value
	ThreatIntelIndicatorCategoryDropSite = "DROP_SITE"

	// ThreatIntelIndicatorCategoryExploitSite is a ThreatIntelIndicatorCategory enum value
	ThreatIntelIndicatorCategoryExploitSite = "EXPLOIT_SITE"

	// ThreatIntelIndicatorCategoryKeylogger is a ThreatIntelIndicatorCategory enum value
	ThreatIntelIndicatorCategoryKeylogger = "KEYLOGGER"
)
View Source
const (
	// ThreatIntelIndicatorTypeDomain is a ThreatIntelIndicatorType enum value
	ThreatIntelIndicatorTypeDomain = "DOMAIN"

	// ThreatIntelIndicatorTypeEmailAddress is a ThreatIntelIndicatorType enum value
	ThreatIntelIndicatorTypeEmailAddress = "EMAIL_ADDRESS"

	// ThreatIntelIndicatorTypeHashMd5 is a ThreatIntelIndicatorType enum value
	ThreatIntelIndicatorTypeHashMd5 = "HASH_MD5"

	// ThreatIntelIndicatorTypeHashSha1 is a ThreatIntelIndicatorType enum value
	ThreatIntelIndicatorTypeHashSha1 = "HASH_SHA1"

	// ThreatIntelIndicatorTypeHashSha256 is a ThreatIntelIndicatorType enum value
	ThreatIntelIndicatorTypeHashSha256 = "HASH_SHA256"

	// ThreatIntelIndicatorTypeHashSha512 is a ThreatIntelIndicatorType enum value
	ThreatIntelIndicatorTypeHashSha512 = "HASH_SHA512"

	// ThreatIntelIndicatorTypeIpv4Address is a ThreatIntelIndicatorType enum value
	ThreatIntelIndicatorTypeIpv4Address = "IPV4_ADDRESS"

	// ThreatIntelIndicatorTypeIpv6Address is a ThreatIntelIndicatorType enum value
	ThreatIntelIndicatorTypeIpv6Address = "IPV6_ADDRESS"

	// ThreatIntelIndicatorTypeMutex is a ThreatIntelIndicatorType enum value
	ThreatIntelIndicatorTypeMutex = "MUTEX"

	// ThreatIntelIndicatorTypeProcess is a ThreatIntelIndicatorType enum value
	ThreatIntelIndicatorTypeProcess = "PROCESS"

	// ThreatIntelIndicatorTypeUrl is a ThreatIntelIndicatorType enum value
	ThreatIntelIndicatorTypeUrl = "URL"
)
View Source
const (
	// UnprocessedErrorCodeInvalidInput is a UnprocessedErrorCode enum value
	UnprocessedErrorCodeInvalidInput = "INVALID_INPUT"

	// UnprocessedErrorCodeAccessDenied is a UnprocessedErrorCode enum value
	UnprocessedErrorCodeAccessDenied = "ACCESS_DENIED"

	// UnprocessedErrorCodeNotFound is a UnprocessedErrorCode enum value
	UnprocessedErrorCodeNotFound = "NOT_FOUND"

	// UnprocessedErrorCodeLimitExceeded is a UnprocessedErrorCode enum value
	UnprocessedErrorCodeLimitExceeded = "LIMIT_EXCEEDED"
)
View Source
const (
	// VerificationStateUnknown is a VerificationState enum value
	VerificationStateUnknown = "UNKNOWN"

	// VerificationStateTruePositive is a VerificationState enum value
	VerificationStateTruePositive = "TRUE_POSITIVE"

	// VerificationStateFalsePositive is a VerificationState enum value
	VerificationStateFalsePositive = "FALSE_POSITIVE"

	// VerificationStateBenignPositive is a VerificationState enum value
	VerificationStateBenignPositive = "BENIGN_POSITIVE"
)
View Source
const (
	// VulnerabilityFixAvailableYes is a VulnerabilityFixAvailable enum value
	VulnerabilityFixAvailableYes = "YES"

	// VulnerabilityFixAvailableNo is a VulnerabilityFixAvailable enum value
	VulnerabilityFixAvailableNo = "NO"

	// VulnerabilityFixAvailablePartial is a VulnerabilityFixAvailable enum value
	VulnerabilityFixAvailablePartial = "PARTIAL"
)
View Source
const (
	// WorkflowStateNew is a WorkflowState enum value
	WorkflowStateNew = "NEW"

	// WorkflowStateAssigned is a WorkflowState enum value
	WorkflowStateAssigned = "ASSIGNED"

	// WorkflowStateInProgress is a WorkflowState enum value
	WorkflowStateInProgress = "IN_PROGRESS"

	// WorkflowStateDeferred is a WorkflowState enum value
	WorkflowStateDeferred = "DEFERRED"

	// WorkflowStateResolved is a WorkflowState enum value
	WorkflowStateResolved = "RESOLVED"
)
View Source
const (
	// WorkflowStatusNew is a WorkflowStatus enum value
	WorkflowStatusNew = "NEW"

	// WorkflowStatusNotified is a WorkflowStatus enum value
	WorkflowStatusNotified = "NOTIFIED"

	// WorkflowStatusResolved is a WorkflowStatus enum value
	WorkflowStatusResolved = "RESOLVED"

	// WorkflowStatusSuppressed is a WorkflowStatus enum value
	WorkflowStatusSuppressed = "SUPPRESSED"
)
View Source
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You don't have permission to perform the action specified in the request.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeInternalException for service response error code
	// "InternalException".
	//
	// Internal server error.
	ErrCodeInternalException = "InternalException"

	// ErrCodeInvalidAccessException for service response error code
	// "InvalidAccessException".
	//
	// The account doesn't have permission to perform this action.
	ErrCodeInvalidAccessException = "InvalidAccessException"

	// ErrCodeInvalidInputException for service response error code
	// "InvalidInputException".
	//
	// The request was rejected because you supplied an invalid or out-of-range
	// value for an input parameter.
	ErrCodeInvalidInputException = "InvalidInputException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The request was rejected because it attempted to create resources beyond
	// the current Amazon Web Services account or throttling limits. The error code
	// describes the limit exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceConflictException for service response error code
	// "ResourceConflictException".
	//
	// The resource specified in the request conflicts with an existing resource.
	ErrCodeResourceConflictException = "ResourceConflictException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The request was rejected because we can't find the specified resource.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
View Source
const (
	ServiceName = "SecurityHub" // Name of service.
	EndpointsID = "securityhub" // ID to lookup a service endpoint with.
	ServiceID   = "SecurityHub" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// AutomationRulesActionTypeFindingFieldsUpdate is a AutomationRulesActionType enum value
	AutomationRulesActionTypeFindingFieldsUpdate = "FINDING_FIELDS_UPDATE"
)
View Source
const (
	// DateRangeUnitDays is a DateRangeUnit enum value
	DateRangeUnitDays = "DAYS"
)

Variables

This section is empty.

Functions

func AdminStatus_Values

func AdminStatus_Values() []string

AdminStatus_Values returns all elements of the AdminStatus enum

func AssociationStatus_Values added in v1.42.9

func AssociationStatus_Values() []string

AssociationStatus_Values returns all elements of the AssociationStatus enum

func AutoEnableStandards_Values added in v1.42.9

func AutoEnableStandards_Values() []string

AutoEnableStandards_Values returns all elements of the AutoEnableStandards enum

func AutomationRulesActionType_Values added in v1.42.9

func AutomationRulesActionType_Values() []string

AutomationRulesActionType_Values returns all elements of the AutomationRulesActionType enum

func AwsIamAccessKeyStatus_Values

func AwsIamAccessKeyStatus_Values() []string

AwsIamAccessKeyStatus_Values returns all elements of the AwsIamAccessKeyStatus enum

func AwsS3BucketNotificationConfigurationS3KeyFilterRuleName_Values

func AwsS3BucketNotificationConfigurationS3KeyFilterRuleName_Values() []string

AwsS3BucketNotificationConfigurationS3KeyFilterRuleName_Values returns all elements of the AwsS3BucketNotificationConfigurationS3KeyFilterRuleName enum

func ComplianceStatus_Values

func ComplianceStatus_Values() []string

ComplianceStatus_Values returns all elements of the ComplianceStatus enum

func ControlFindingGenerator_Values added in v1.42.9

func ControlFindingGenerator_Values() []string

ControlFindingGenerator_Values returns all elements of the ControlFindingGenerator enum

func ControlStatus_Values

func ControlStatus_Values() []string

ControlStatus_Values returns all elements of the ControlStatus enum

func DateRangeUnit_Values

func DateRangeUnit_Values() []string

DateRangeUnit_Values returns all elements of the DateRangeUnit enum

func FindingHistoryUpdateSourceType_Values added in v1.42.9

func FindingHistoryUpdateSourceType_Values() []string

FindingHistoryUpdateSourceType_Values returns all elements of the FindingHistoryUpdateSourceType enum

func IntegrationType_Values

func IntegrationType_Values() []string

IntegrationType_Values returns all elements of the IntegrationType enum

func MalwareState_Values

func MalwareState_Values() []string

MalwareState_Values returns all elements of the MalwareState enum

func MalwareType_Values

func MalwareType_Values() []string

MalwareType_Values returns all elements of the MalwareType enum

func MapFilterComparison_Values

func MapFilterComparison_Values() []string

MapFilterComparison_Values returns all elements of the MapFilterComparison enum

func NetworkDirection_Values

func NetworkDirection_Values() []string

NetworkDirection_Values returns all elements of the NetworkDirection enum

func Partition_Values

func Partition_Values() []string

Partition_Values returns all elements of the Partition enum

func RecordState_Values

func RecordState_Values() []string

RecordState_Values returns all elements of the RecordState enum

func RegionAvailabilityStatus_Values added in v1.42.9

func RegionAvailabilityStatus_Values() []string

RegionAvailabilityStatus_Values returns all elements of the RegionAvailabilityStatus enum

func RuleStatus_Values added in v1.42.9

func RuleStatus_Values() []string

RuleStatus_Values returns all elements of the RuleStatus enum

func SeverityLabel_Values

func SeverityLabel_Values() []string

SeverityLabel_Values returns all elements of the SeverityLabel enum

func SeverityRating_Values

func SeverityRating_Values() []string

SeverityRating_Values returns all elements of the SeverityRating enum

func SortOrder_Values

func SortOrder_Values() []string

SortOrder_Values returns all elements of the SortOrder enum

func StandardsStatus_Values

func StandardsStatus_Values() []string

StandardsStatus_Values returns all elements of the StandardsStatus enum

func StatusReasonCode_Values added in v1.42.9

func StatusReasonCode_Values() []string

StatusReasonCode_Values returns all elements of the StatusReasonCode enum

func StringFilterComparison_Values

func StringFilterComparison_Values() []string

StringFilterComparison_Values returns all elements of the StringFilterComparison enum

func ThreatIntelIndicatorCategory_Values

func ThreatIntelIndicatorCategory_Values() []string

ThreatIntelIndicatorCategory_Values returns all elements of the ThreatIntelIndicatorCategory enum

func ThreatIntelIndicatorType_Values

func ThreatIntelIndicatorType_Values() []string

ThreatIntelIndicatorType_Values returns all elements of the ThreatIntelIndicatorType enum

func UnprocessedErrorCode_Values added in v1.42.9

func UnprocessedErrorCode_Values() []string

UnprocessedErrorCode_Values returns all elements of the UnprocessedErrorCode enum

func VerificationState_Values

func VerificationState_Values() []string

VerificationState_Values returns all elements of the VerificationState enum

func VulnerabilityFixAvailable_Values added in v1.42.9

func VulnerabilityFixAvailable_Values() []string

VulnerabilityFixAvailable_Values returns all elements of the VulnerabilityFixAvailable enum

func WorkflowState_Values

func WorkflowState_Values() []string

WorkflowState_Values returns all elements of the WorkflowState enum

func WorkflowStatus_Values

func WorkflowStatus_Values() []string

WorkflowStatus_Values returns all elements of the WorkflowStatus enum

Types

type AcceptAdministratorInvitationInput

type AcceptAdministratorInvitationInput struct {

	// The account ID of the Security Hub administrator account that sent the invitation.
	//
	// AdministratorId is a required field
	AdministratorId *string `type:"string" required:"true"`

	// The identifier of the invitation sent from the Security Hub administrator
	// account.
	//
	// InvitationId is a required field
	InvitationId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AcceptAdministratorInvitationInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceptAdministratorInvitationInput) SetAdministratorId

SetAdministratorId sets the AdministratorId field's value.

func (*AcceptAdministratorInvitationInput) SetInvitationId

SetInvitationId sets the InvitationId field's value.

func (AcceptAdministratorInvitationInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceptAdministratorInvitationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type AcceptAdministratorInvitationOutput

type AcceptAdministratorInvitationOutput struct {
	// contains filtered or unexported fields
}

func (AcceptAdministratorInvitationOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AcceptAdministratorInvitationOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AcceptInvitationInput

type AcceptInvitationInput struct {

	// The identifier of the invitation sent from the Security Hub administrator
	// account.
	//
	// InvitationId is a required field
	InvitationId *string `type:"string" required:"true"`

	// The account ID of the Security Hub administrator account that sent the invitation.
	//
	// MasterId is a required field
	MasterId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AcceptInvitationInput) GoString

func (s AcceptInvitationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceptInvitationInput) SetInvitationId

func (s *AcceptInvitationInput) SetInvitationId(v string) *AcceptInvitationInput

SetInvitationId sets the InvitationId field's value.

func (*AcceptInvitationInput) SetMasterId

SetMasterId sets the MasterId field's value.

func (AcceptInvitationInput) String

func (s AcceptInvitationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceptInvitationInput) Validate

func (s *AcceptInvitationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AcceptInvitationOutput

type AcceptInvitationOutput struct {
	// contains filtered or unexported fields
}

func (AcceptInvitationOutput) GoString

func (s AcceptInvitationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AcceptInvitationOutput) String

func (s AcceptInvitationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccessDeniedException

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

You don't have permission to perform the action specified in the request.

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccountDetails

type AccountDetails struct {

	// The ID of an Amazon Web Services account.
	//
	// AccountId is a required field
	AccountId *string `type:"string" required:"true"`

	// The email of an Amazon Web Services account.
	Email *string `type:"string"`
	// contains filtered or unexported fields
}

The details of an Amazon Web Services account.

func (AccountDetails) GoString

func (s AccountDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountDetails) SetAccountId

func (s *AccountDetails) SetAccountId(v string) *AccountDetails

SetAccountId sets the AccountId field's value.

func (*AccountDetails) SetEmail

func (s *AccountDetails) SetEmail(v string) *AccountDetails

SetEmail sets the Email field's value.

func (AccountDetails) String

func (s AccountDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountDetails) Validate

func (s *AccountDetails) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Action

type Action struct {

	// The type of action that was detected. The possible action types are:
	//
	//    * NETWORK_CONNECTION
	//
	//    * AWS_API_CALL
	//
	//    * DNS_REQUEST
	//
	//    * PORT_PROBE
	ActionType *string `type:"string"`

	// Included if ActionType is AWS_API_CALL. Provides details about the API call
	// that was detected.
	AwsApiCallAction *AwsApiCallAction `type:"structure"`

	// Included if ActionType is DNS_REQUEST. Provides details about the DNS request
	// that was detected.
	DnsRequestAction *DnsRequestAction `type:"structure"`

	// Included if ActionType is NETWORK_CONNECTION. Provides details about the
	// network connection that was detected.
	NetworkConnectionAction *NetworkConnectionAction `type:"structure"`

	// Included if ActionType is PORT_PROBE. Provides details about the port probe
	// that was detected.
	PortProbeAction *PortProbeAction `type:"structure"`
	// contains filtered or unexported fields
}

Provides details about one of the following actions that affects or that was taken on a resource:

  • A remote IP address issued an Amazon Web Services API call

  • A DNS request was received

  • A remote IP address attempted to connect to an EC2 instance

  • A remote IP address attempted a port probe on an EC2 instance

func (Action) GoString

func (s Action) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Action) SetActionType

func (s *Action) SetActionType(v string) *Action

SetActionType sets the ActionType field's value.

func (*Action) SetAwsApiCallAction

func (s *Action) SetAwsApiCallAction(v *AwsApiCallAction) *Action

SetAwsApiCallAction sets the AwsApiCallAction field's value.

func (*Action) SetDnsRequestAction

func (s *Action) SetDnsRequestAction(v *DnsRequestAction) *Action

SetDnsRequestAction sets the DnsRequestAction field's value.

func (*Action) SetNetworkConnectionAction

func (s *Action) SetNetworkConnectionAction(v *NetworkConnectionAction) *Action

SetNetworkConnectionAction sets the NetworkConnectionAction field's value.

func (*Action) SetPortProbeAction

func (s *Action) SetPortProbeAction(v *PortProbeAction) *Action

SetPortProbeAction sets the PortProbeAction field's value.

func (Action) String

func (s Action) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActionLocalIpDetails

type ActionLocalIpDetails struct {

	// The IP address.
	IpAddressV4 *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the IP address where the scanned port is located.

func (ActionLocalIpDetails) GoString

func (s ActionLocalIpDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionLocalIpDetails) SetIpAddressV4

func (s *ActionLocalIpDetails) SetIpAddressV4(v string) *ActionLocalIpDetails

SetIpAddressV4 sets the IpAddressV4 field's value.

func (ActionLocalIpDetails) String

func (s ActionLocalIpDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActionLocalPortDetails

type ActionLocalPortDetails struct {

	// The number of the port.
	Port *int64 `type:"integer"`

	// The port name of the local connection.
	PortName *string `type:"string"`
	// contains filtered or unexported fields
}

For NetworkConnectionAction and PortProbeDetails, LocalPortDetails provides information about the local port that was involved in the action.

func (ActionLocalPortDetails) GoString

func (s ActionLocalPortDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionLocalPortDetails) SetPort

SetPort sets the Port field's value.

func (*ActionLocalPortDetails) SetPortName

SetPortName sets the PortName field's value.

func (ActionLocalPortDetails) String

func (s ActionLocalPortDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActionRemoteIpDetails

type ActionRemoteIpDetails struct {

	// The city where the remote IP address is located.
	City *City `type:"structure"`

	// The country where the remote IP address is located.
	Country *Country `type:"structure"`

	// The coordinates of the location of the remote IP address.
	GeoLocation *GeoLocation `type:"structure"`

	// The IP address.
	IpAddressV4 *string `type:"string"`

	// The internet service provider (ISP) organization associated with the remote
	// IP address.
	Organization *IpOrganizationDetails `type:"structure"`
	// contains filtered or unexported fields
}

For AwsApiAction, NetworkConnectionAction, and PortProbeAction, RemoteIpDetails provides information about the remote IP address that was involved in the action.

func (ActionRemoteIpDetails) GoString

func (s ActionRemoteIpDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionRemoteIpDetails) SetCity

SetCity sets the City field's value.

func (*ActionRemoteIpDetails) SetCountry

SetCountry sets the Country field's value.

func (*ActionRemoteIpDetails) SetGeoLocation

SetGeoLocation sets the GeoLocation field's value.

func (*ActionRemoteIpDetails) SetIpAddressV4

func (s *ActionRemoteIpDetails) SetIpAddressV4(v string) *ActionRemoteIpDetails

SetIpAddressV4 sets the IpAddressV4 field's value.

func (*ActionRemoteIpDetails) SetOrganization

SetOrganization sets the Organization field's value.

func (ActionRemoteIpDetails) String

func (s ActionRemoteIpDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActionRemotePortDetails

type ActionRemotePortDetails struct {

	// The number of the port.
	Port *int64 `type:"integer"`

	// The port name of the remote connection.
	PortName *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the remote port that was involved in an attempted network connection.

func (ActionRemotePortDetails) GoString

func (s ActionRemotePortDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionRemotePortDetails) SetPort

SetPort sets the Port field's value.

func (*ActionRemotePortDetails) SetPortName

SetPortName sets the PortName field's value.

func (ActionRemotePortDetails) String

func (s ActionRemotePortDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActionTarget

type ActionTarget struct {

	// The ARN for the target action.
	//
	// ActionTargetArn is a required field
	ActionTargetArn *string `type:"string" required:"true"`

	// The description of the target action.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// The name of the action target.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

An ActionTarget object.

func (ActionTarget) GoString

func (s ActionTarget) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionTarget) SetActionTargetArn

func (s *ActionTarget) SetActionTargetArn(v string) *ActionTarget

SetActionTargetArn sets the ActionTargetArn field's value.

func (*ActionTarget) SetDescription

func (s *ActionTarget) SetDescription(v string) *ActionTarget

SetDescription sets the Description field's value.

func (*ActionTarget) SetName

func (s *ActionTarget) SetName(v string) *ActionTarget

SetName sets the Name field's value.

func (ActionTarget) String

func (s ActionTarget) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Adjustment

type Adjustment struct {

	// The metric to adjust.
	Metric *string `type:"string"`

	// The reason for the adjustment.
	Reason *string `type:"string"`
	// contains filtered or unexported fields
}

An adjustment to the CVSS metric.

func (Adjustment) GoString

func (s Adjustment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Adjustment) SetMetric

func (s *Adjustment) SetMetric(v string) *Adjustment

SetMetric sets the Metric field's value.

func (*Adjustment) SetReason

func (s *Adjustment) SetReason(v string) *Adjustment

SetReason sets the Reason field's value.

func (Adjustment) String

func (s Adjustment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminAccount

type AdminAccount struct {

	// The Amazon Web Services account identifier of the Security Hub administrator
	// account.
	AccountId *string `type:"string"`

	// The current status of the Security Hub administrator account. Indicates whether
	// the account is currently enabled as a Security Hub administrator.
	Status *string `type:"string" enum:"AdminStatus"`
	// contains filtered or unexported fields
}

Represents a Security Hub administrator account designated by an organization management account.

func (AdminAccount) GoString

func (s AdminAccount) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminAccount) SetAccountId

func (s *AdminAccount) SetAccountId(v string) *AdminAccount

SetAccountId sets the AccountId field's value.

func (*AdminAccount) SetStatus

func (s *AdminAccount) SetStatus(v string) *AdminAccount

SetStatus sets the Status field's value.

func (AdminAccount) String

func (s AdminAccount) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociatedStandard added in v1.42.9

type AssociatedStandard struct {

	// The unique identifier of a standard in which a control is enabled. This field
	// consists of the resource portion of the Amazon Resource Name (ARN) returned
	// for a standard in the DescribeStandards (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html)
	// API response.
	StandardsId *string `type:"string"`
	// contains filtered or unexported fields
}

Information about an enabled security standard in which a security control is enabled.

func (AssociatedStandard) GoString added in v1.42.9

func (s AssociatedStandard) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociatedStandard) SetStandardsId added in v1.42.9

func (s *AssociatedStandard) SetStandardsId(v string) *AssociatedStandard

SetStandardsId sets the StandardsId field's value.

func (AssociatedStandard) String added in v1.42.9

func (s AssociatedStandard) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociationSetDetails added in v1.42.9

type AssociationSetDetails struct {

	// The state of the association between a route table and a subnet or gateway.
	AssociationState *AssociationStateDetails `type:"structure"`

	// The ID of the internet gateway or virtual private gateway.
	GatewayId *string `type:"string"`

	// Indicates whether this is the main route table.
	Main *bool `type:"boolean"`

	// The ID of the association.
	RouteTableAssociationId *string `type:"string"`

	// The ID of the route table.
	RouteTableId *string `type:"string"`

	// The ID of the subnet. A subnet ID is not returned for an implicit association.
	SubnetId *string `type:"string"`
	// contains filtered or unexported fields
}

The associations between a route table and one or more subnets or a gateway.

func (AssociationSetDetails) GoString added in v1.42.9

func (s AssociationSetDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociationSetDetails) SetAssociationState added in v1.42.9

SetAssociationState sets the AssociationState field's value.

func (*AssociationSetDetails) SetGatewayId added in v1.42.9

SetGatewayId sets the GatewayId field's value.

func (*AssociationSetDetails) SetMain added in v1.42.9

SetMain sets the Main field's value.

func (*AssociationSetDetails) SetRouteTableAssociationId added in v1.42.9

func (s *AssociationSetDetails) SetRouteTableAssociationId(v string) *AssociationSetDetails

SetRouteTableAssociationId sets the RouteTableAssociationId field's value.

func (*AssociationSetDetails) SetRouteTableId added in v1.42.9

func (s *AssociationSetDetails) SetRouteTableId(v string) *AssociationSetDetails

SetRouteTableId sets the RouteTableId field's value.

func (*AssociationSetDetails) SetSubnetId added in v1.42.9

SetSubnetId sets the SubnetId field's value.

func (AssociationSetDetails) String added in v1.42.9

func (s AssociationSetDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociationStateDetails added in v1.42.9

type AssociationStateDetails struct {

	// The state of the association.
	State *string `type:"string"`

	// The status message, if applicable.
	StatusMessage *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the state of an association between a route table and a subnet or gateway.

func (AssociationStateDetails) GoString added in v1.42.9

func (s AssociationStateDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociationStateDetails) SetState added in v1.42.9

SetState sets the State field's value.

func (*AssociationStateDetails) SetStatusMessage added in v1.42.9

func (s *AssociationStateDetails) SetStatusMessage(v string) *AssociationStateDetails

SetStatusMessage sets the StatusMessage field's value.

func (AssociationStateDetails) String added in v1.42.9

func (s AssociationStateDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutomationRulesAction added in v1.42.9

type AutomationRulesAction struct {

	// Specifies that the automation rule action is an update to a finding field.
	FindingFieldsUpdate *AutomationRulesFindingFieldsUpdate `type:"structure"`

	// Specifies that the rule action should update the Types finding field. The
	// Types finding field classifies findings in the format of namespace/category/classifier.
	// For more information, see Types taxonomy for ASFF (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format-type-taxonomy.html)
	// in the Security Hub User Guide.
	Type *string `type:"string" enum:"AutomationRulesActionType"`
	// contains filtered or unexported fields
}

One or more actions to update finding fields if a finding matches the defined criteria of the rule.

func (AutomationRulesAction) GoString added in v1.42.9

func (s AutomationRulesAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutomationRulesAction) SetFindingFieldsUpdate added in v1.42.9

SetFindingFieldsUpdate sets the FindingFieldsUpdate field's value.

func (*AutomationRulesAction) SetType added in v1.42.9

SetType sets the Type field's value.

func (AutomationRulesAction) String added in v1.42.9

func (s AutomationRulesAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutomationRulesAction) Validate added in v1.42.9

func (s *AutomationRulesAction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AutomationRulesConfig added in v1.42.9

type AutomationRulesConfig struct {

	// One or more actions to update finding fields if a finding matches the defined
	// criteria of the rule.
	Actions []*AutomationRulesAction `min:"1" type:"list"`

	// A timestamp that indicates when the rule was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces. For example, 2020-03-22T13:22:13.933Z.
	CreatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The principal that created a rule.
	CreatedBy *string `type:"string"`

	// A set of Amazon Web Services Security Finding Format (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html)
	// finding field attributes and corresponding expected values that Security
	// Hub uses to filter findings. If a rule is enabled and a finding matches the
	// conditions specified in this parameter, Security Hub applies the rule action
	// to the finding.
	Criteria *AutomationRulesFindingFilters `type:"structure"`

	// A description of the rule.
	Description *string `type:"string"`

	// Specifies whether a rule is the last to be applied with respect to a finding
	// that matches the rule criteria. This is useful when a finding matches the
	// criteria for multiple rules, and each rule has different actions. If a rule
	// is terminal, Security Hub applies the rule action to a finding that matches
	// the rule criteria and doesn't evaluate other rules for the finding. By default,
	// a rule isn't terminal.
	IsTerminal *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of a rule.
	RuleArn *string `type:"string"`

	// The name of the rule.
	RuleName *string `type:"string"`

	// An integer ranging from 1 to 1000 that represents the order in which the
	// rule action is applied to findings. Security Hub applies rules with lower
	// values for this parameter first.
	RuleOrder *int64 `min:"1" type:"integer"`

	// Whether the rule is active after it is created. If this parameter is equal
	// to ENABLED, Security Hub starts applying the rule to findings and finding
	// updates after the rule is created.
	RuleStatus *string `type:"string" enum:"RuleStatus"`

	// A timestamp that indicates when the rule was most recently updated.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces. For example, 2020-03-22T13:22:13.933Z.
	UpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

Defines the configuration of an automation rule.

func (AutomationRulesConfig) GoString added in v1.42.9

func (s AutomationRulesConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutomationRulesConfig) SetActions added in v1.42.9

SetActions sets the Actions field's value.

func (*AutomationRulesConfig) SetCreatedAt added in v1.42.9

SetCreatedAt sets the CreatedAt field's value.

func (*AutomationRulesConfig) SetCreatedBy added in v1.42.9

SetCreatedBy sets the CreatedBy field's value.

func (*AutomationRulesConfig) SetCriteria added in v1.42.9

SetCriteria sets the Criteria field's value.

func (*AutomationRulesConfig) SetDescription added in v1.42.9

func (s *AutomationRulesConfig) SetDescription(v string) *AutomationRulesConfig

SetDescription sets the Description field's value.

func (*AutomationRulesConfig) SetIsTerminal added in v1.42.9

func (s *AutomationRulesConfig) SetIsTerminal(v bool) *AutomationRulesConfig

SetIsTerminal sets the IsTerminal field's value.

func (*AutomationRulesConfig) SetRuleArn added in v1.42.9

SetRuleArn sets the RuleArn field's value.

func (*AutomationRulesConfig) SetRuleName added in v1.42.9

SetRuleName sets the RuleName field's value.

func (*AutomationRulesConfig) SetRuleOrder added in v1.42.9

SetRuleOrder sets the RuleOrder field's value.

func (*AutomationRulesConfig) SetRuleStatus added in v1.42.9

func (s *AutomationRulesConfig) SetRuleStatus(v string) *AutomationRulesConfig

SetRuleStatus sets the RuleStatus field's value.

func (*AutomationRulesConfig) SetUpdatedAt added in v1.42.9

SetUpdatedAt sets the UpdatedAt field's value.

func (AutomationRulesConfig) String added in v1.42.9

func (s AutomationRulesConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutomationRulesFindingFieldsUpdate added in v1.42.9

type AutomationRulesFindingFieldsUpdate struct {

	// The rule action updates the Confidence field of a finding.
	Confidence *int64 `type:"integer"`

	// The rule action updates the Criticality field of a finding.
	Criticality *int64 `type:"integer"`

	// The updated note.
	Note *NoteUpdate `type:"structure"`

	// The rule action updates the RelatedFindings field of a finding.
	RelatedFindings []*RelatedFinding `type:"list"`

	// Updates to the severity information for a finding.
	Severity *SeverityUpdate `type:"structure"`

	// The rule action updates the Types field of a finding.
	Types []*string `type:"list"`

	// The rule action updates the UserDefinedFields field of a finding.
	UserDefinedFields map[string]*string `type:"map"`

	// The rule action updates the VerificationState field of a finding.
	VerificationState *string `type:"string" enum:"VerificationState"`

	// Used to update information about the investigation into the finding.
	Workflow *WorkflowUpdate `type:"structure"`
	// contains filtered or unexported fields
}

Identifies the finding fields that the automation rule action updates when a finding matches the defined criteria.

func (AutomationRulesFindingFieldsUpdate) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutomationRulesFindingFieldsUpdate) SetConfidence added in v1.42.9

SetConfidence sets the Confidence field's value.

func (*AutomationRulesFindingFieldsUpdate) SetCriticality added in v1.42.9

SetCriticality sets the Criticality field's value.

func (*AutomationRulesFindingFieldsUpdate) SetNote added in v1.42.9

SetNote sets the Note field's value.

func (*AutomationRulesFindingFieldsUpdate) SetRelatedFindings added in v1.42.9

SetRelatedFindings sets the RelatedFindings field's value.

func (*AutomationRulesFindingFieldsUpdate) SetSeverity added in v1.42.9

SetSeverity sets the Severity field's value.

func (*AutomationRulesFindingFieldsUpdate) SetTypes added in v1.42.9

SetTypes sets the Types field's value.

func (*AutomationRulesFindingFieldsUpdate) SetUserDefinedFields added in v1.42.9

SetUserDefinedFields sets the UserDefinedFields field's value.

func (*AutomationRulesFindingFieldsUpdate) SetVerificationState added in v1.42.9

SetVerificationState sets the VerificationState field's value.

func (*AutomationRulesFindingFieldsUpdate) SetWorkflow added in v1.42.9

SetWorkflow sets the Workflow field's value.

func (AutomationRulesFindingFieldsUpdate) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutomationRulesFindingFieldsUpdate) Validate added in v1.42.9

Validate inspects the fields of the type to determine if they are valid.

type AutomationRulesFindingFilters added in v1.42.9

type AutomationRulesFindingFilters struct {

	// The Amazon Web Services account ID in which a finding was generated.
	AwsAccountId []*StringFilter `type:"list"`

	// The name of the company for the product that generated the finding. For control-based
	// findings, the company is Amazon Web Services.
	CompanyName []*StringFilter `type:"list"`

	// The unique identifier of a standard in which a control is enabled. This field
	// consists of the resource portion of the Amazon Resource Name (ARN) returned
	// for a standard in the DescribeStandards (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html)
	// API response.
	ComplianceAssociatedStandardsId []*StringFilter `type:"list"`

	// The security control ID for which a finding was generated. Security control
	// IDs are the same across standards.
	ComplianceSecurityControlId []*StringFilter `type:"list"`

	// The result of a security check. This field is only used for findings generated
	// from controls.
	ComplianceStatus []*StringFilter `type:"list"`

	// The likelihood that a finding accurately identifies the behavior or issue
	// that it was intended to identify. Confidence is scored on a 0–100 basis
	// using a ratio scale. A value of 0 means 0 percent confidence, and a value
	// of 100 means 100 percent confidence. For example, a data exfiltration detection
	// based on a statistical deviation of network traffic has low confidence because
	// an actual exfiltration hasn't been verified. For more information, see Confidence
	// (https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-confidence)
	// in the Security Hub User Guide.
	Confidence []*NumberFilter `type:"list"`

	// A timestamp that indicates when this finding record was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces. For example, 2020-03-22T13:22:13.933Z.
	CreatedAt []*DateFilter `type:"list"`

	// The level of importance that is assigned to the resources that are associated
	// with a finding. Criticality is scored on a 0–100 basis, using a ratio scale
	// that supports only full integers. A score of 0 means that the underlying
	// resources have no criticality, and a score of 100 is reserved for the most
	// critical resources. For more information, see Criticality (https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-criticality)
	// in the Security Hub User Guide.
	Criticality []*NumberFilter `type:"list"`

	// A finding's description.
	Description []*StringFilter `type:"list"`

	// A timestamp that indicates when the potential security issue captured by
	// a finding was first observed by the security findings product.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces. For example, 2020-03-22T13:22:13.933Z.
	FirstObservedAt []*DateFilter `type:"list"`

	// The identifier for the solution-specific component that generated a finding.
	GeneratorId []*StringFilter `type:"list"`

	// The product-specific identifier for a finding.
	Id []*StringFilter `type:"list"`

	// A timestamp that indicates when the potential security issue captured by
	// a finding was most recently observed by the security findings product.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces. For example, 2020-03-22T13:22:13.933Z.
	LastObservedAt []*DateFilter `type:"list"`

	// The text of a user-defined note that's added to a finding.
	NoteText []*StringFilter `type:"list"`

	// The timestamp of when the note was updated. Uses the date-time format specified
	// in RFC 3339 section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6).
	// The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.
	NoteUpdatedAt []*DateFilter `type:"list"`

	// The principal that created a note.
	NoteUpdatedBy []*StringFilter `type:"list"`

	// The Amazon Resource Name (ARN) for a third-party product that generated a
	// finding in Security Hub.
	ProductArn []*StringFilter `type:"list"`

	// Provides the name of the product that generated the finding. For control-based
	// findings, the product name is Security Hub.
	ProductName []*StringFilter `type:"list"`

	// Provides the current state of a finding.
	RecordState []*StringFilter `type:"list"`

	// The product-generated identifier for a related finding.
	RelatedFindingsId []*StringFilter `type:"list"`

	// The ARN for the product that generated a related finding.
	RelatedFindingsProductArn []*StringFilter `type:"list"`

	// Custom fields and values about the resource that a finding pertains to.
	ResourceDetailsOther []*MapFilter `type:"list"`

	// The identifier for the given resource type. For Amazon Web Services resources
	// that are identified by Amazon Resource Names (ARNs), this is the ARN. For
	// Amazon Web Services resources that lack ARNs, this is the identifier as defined
	// by the Amazon Web Service that created the resource. For non-Amazon Web Services
	// resources, this is a unique identifier that is associated with the resource.
	ResourceId []*StringFilter `type:"list"`

	// The partition in which the resource that the finding pertains to is located.
	// A partition is a group of Amazon Web Services Regions. Each Amazon Web Services
	// account is scoped to one partition.
	ResourcePartition []*StringFilter `type:"list"`

	// The Amazon Web Services Region where the resource that a finding pertains
	// to is located.
	ResourceRegion []*StringFilter `type:"list"`

	// A list of Amazon Web Services tags associated with a resource at the time
	// the finding was processed.
	ResourceTags []*MapFilter `type:"list"`

	// The type of resource that the finding pertains to.
	ResourceType []*StringFilter `type:"list"`

	// The severity value of the finding.
	SeverityLabel []*StringFilter `type:"list"`

	// Provides a URL that links to a page about the current finding in the finding
	// product.
	SourceUrl []*StringFilter `type:"list"`

	// A finding's title.
	Title []*StringFilter `type:"list"`

	// One or more finding types in the format of namespace/category/classifier
	// that classify a finding. For a list of namespaces, classifiers, and categories,
	// see Types taxonomy for ASFF (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format-type-taxonomy.html)
	// in the Security Hub User Guide.
	Type []*StringFilter `type:"list"`

	// A timestamp that indicates when the finding record was most recently updated.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces. For example, 2020-03-22T13:22:13.933Z.
	UpdatedAt []*DateFilter `type:"list"`

	// A list of user-defined name and value string pairs added to a finding.
	UserDefinedFields []*MapFilter `type:"list"`

	// Provides the veracity of a finding.
	VerificationState []*StringFilter `type:"list"`

	// Provides information about the status of the investigation into a finding.
	WorkflowStatus []*StringFilter `type:"list"`
	// contains filtered or unexported fields
}

The criteria that determine which findings a rule applies to.

func (AutomationRulesFindingFilters) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutomationRulesFindingFilters) SetAwsAccountId added in v1.42.9

SetAwsAccountId sets the AwsAccountId field's value.

func (*AutomationRulesFindingFilters) SetCompanyName added in v1.42.9

SetCompanyName sets the CompanyName field's value.

func (*AutomationRulesFindingFilters) SetComplianceAssociatedStandardsId added in v1.42.9

func (s *AutomationRulesFindingFilters) SetComplianceAssociatedStandardsId(v []*StringFilter) *AutomationRulesFindingFilters

SetComplianceAssociatedStandardsId sets the ComplianceAssociatedStandardsId field's value.

func (*AutomationRulesFindingFilters) SetComplianceSecurityControlId added in v1.42.9

func (s *AutomationRulesFindingFilters) SetComplianceSecurityControlId(v []*StringFilter) *AutomationRulesFindingFilters

SetComplianceSecurityControlId sets the ComplianceSecurityControlId field's value.

func (*AutomationRulesFindingFilters) SetComplianceStatus added in v1.42.9

SetComplianceStatus sets the ComplianceStatus field's value.

func (*AutomationRulesFindingFilters) SetConfidence added in v1.42.9

SetConfidence sets the Confidence field's value.

func (*AutomationRulesFindingFilters) SetCreatedAt added in v1.42.9

SetCreatedAt sets the CreatedAt field's value.

func (*AutomationRulesFindingFilters) SetCriticality added in v1.42.9

SetCriticality sets the Criticality field's value.

func (*AutomationRulesFindingFilters) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*AutomationRulesFindingFilters) SetFirstObservedAt added in v1.42.9

SetFirstObservedAt sets the FirstObservedAt field's value.

func (*AutomationRulesFindingFilters) SetGeneratorId added in v1.42.9

SetGeneratorId sets the GeneratorId field's value.

func (*AutomationRulesFindingFilters) SetId added in v1.42.9

SetId sets the Id field's value.

func (*AutomationRulesFindingFilters) SetLastObservedAt added in v1.42.9

SetLastObservedAt sets the LastObservedAt field's value.

func (*AutomationRulesFindingFilters) SetNoteText added in v1.42.9

SetNoteText sets the NoteText field's value.

func (*AutomationRulesFindingFilters) SetNoteUpdatedAt added in v1.42.9

SetNoteUpdatedAt sets the NoteUpdatedAt field's value.

func (*AutomationRulesFindingFilters) SetNoteUpdatedBy added in v1.42.9

SetNoteUpdatedBy sets the NoteUpdatedBy field's value.

func (*AutomationRulesFindingFilters) SetProductArn added in v1.42.9

SetProductArn sets the ProductArn field's value.

func (*AutomationRulesFindingFilters) SetProductName added in v1.42.9

SetProductName sets the ProductName field's value.

func (*AutomationRulesFindingFilters) SetRecordState added in v1.42.9

SetRecordState sets the RecordState field's value.

func (*AutomationRulesFindingFilters) SetRelatedFindingsId added in v1.42.9

SetRelatedFindingsId sets the RelatedFindingsId field's value.

func (*AutomationRulesFindingFilters) SetRelatedFindingsProductArn added in v1.42.9

func (s *AutomationRulesFindingFilters) SetRelatedFindingsProductArn(v []*StringFilter) *AutomationRulesFindingFilters

SetRelatedFindingsProductArn sets the RelatedFindingsProductArn field's value.

func (*AutomationRulesFindingFilters) SetResourceDetailsOther added in v1.42.9

func (s *AutomationRulesFindingFilters) SetResourceDetailsOther(v []*MapFilter) *AutomationRulesFindingFilters

SetResourceDetailsOther sets the ResourceDetailsOther field's value.

func (*AutomationRulesFindingFilters) SetResourceId added in v1.42.9

SetResourceId sets the ResourceId field's value.

func (*AutomationRulesFindingFilters) SetResourcePartition added in v1.42.9

SetResourcePartition sets the ResourcePartition field's value.

func (*AutomationRulesFindingFilters) SetResourceRegion added in v1.42.9

SetResourceRegion sets the ResourceRegion field's value.

func (*AutomationRulesFindingFilters) SetResourceTags added in v1.42.9

SetResourceTags sets the ResourceTags field's value.

func (*AutomationRulesFindingFilters) SetResourceType added in v1.42.9

SetResourceType sets the ResourceType field's value.

func (*AutomationRulesFindingFilters) SetSeverityLabel added in v1.42.9

SetSeverityLabel sets the SeverityLabel field's value.

func (*AutomationRulesFindingFilters) SetSourceUrl added in v1.42.9

SetSourceUrl sets the SourceUrl field's value.

func (*AutomationRulesFindingFilters) SetTitle added in v1.42.9

SetTitle sets the Title field's value.

func (*AutomationRulesFindingFilters) SetType added in v1.42.9

SetType sets the Type field's value.

func (*AutomationRulesFindingFilters) SetUpdatedAt added in v1.42.9

SetUpdatedAt sets the UpdatedAt field's value.

func (*AutomationRulesFindingFilters) SetUserDefinedFields added in v1.42.9

SetUserDefinedFields sets the UserDefinedFields field's value.

func (*AutomationRulesFindingFilters) SetVerificationState added in v1.42.9

SetVerificationState sets the VerificationState field's value.

func (*AutomationRulesFindingFilters) SetWorkflowStatus added in v1.42.9

SetWorkflowStatus sets the WorkflowStatus field's value.

func (AutomationRulesFindingFilters) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutomationRulesMetadata added in v1.42.9

type AutomationRulesMetadata struct {

	// A timestamp that indicates when the rule was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces. For example, 2020-03-22T13:22:13.933Z.
	CreatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The principal that created a rule.
	CreatedBy *string `type:"string"`

	// A description of the rule.
	Description *string `type:"string"`

	// Specifies whether a rule is the last to be applied with respect to a finding
	// that matches the rule criteria. This is useful when a finding matches the
	// criteria for multiple rules, and each rule has different actions. If a rule
	// is terminal, Security Hub applies the rule action to a finding that matches
	// the rule criteria and doesn't evaluate other rules for the finding. By default,
	// a rule isn't terminal.
	IsTerminal *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) for the rule.
	RuleArn *string `type:"string"`

	// The name of the rule.
	RuleName *string `type:"string"`

	// An integer ranging from 1 to 1000 that represents the order in which the
	// rule action is applied to findings. Security Hub applies rules with lower
	// values for this parameter first.
	RuleOrder *int64 `min:"1" type:"integer"`

	// Whether the rule is active after it is created. If this parameter is equal
	// to ENABLED, Security Hub starts applying the rule to findings and finding
	// updates after the rule is created. To change the value of this parameter
	// after creating a rule, use BatchUpdateAutomationRules (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html).
	RuleStatus *string `type:"string" enum:"RuleStatus"`

	// A timestamp that indicates when the rule was most recently updated.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces. For example, 2020-03-22T13:22:13.933Z.
	UpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

Metadata for automation rules in the calling account. The response includes rules with a RuleStatus of ENABLED and DISABLED.

func (AutomationRulesMetadata) GoString added in v1.42.9

func (s AutomationRulesMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutomationRulesMetadata) SetCreatedAt added in v1.42.9

SetCreatedAt sets the CreatedAt field's value.

func (*AutomationRulesMetadata) SetCreatedBy added in v1.42.9

SetCreatedBy sets the CreatedBy field's value.

func (*AutomationRulesMetadata) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*AutomationRulesMetadata) SetIsTerminal added in v1.42.9

SetIsTerminal sets the IsTerminal field's value.

func (*AutomationRulesMetadata) SetRuleArn added in v1.42.9

SetRuleArn sets the RuleArn field's value.

func (*AutomationRulesMetadata) SetRuleName added in v1.42.9

SetRuleName sets the RuleName field's value.

func (*AutomationRulesMetadata) SetRuleOrder added in v1.42.9

SetRuleOrder sets the RuleOrder field's value.

func (*AutomationRulesMetadata) SetRuleStatus added in v1.42.9

SetRuleStatus sets the RuleStatus field's value.

func (*AutomationRulesMetadata) SetUpdatedAt added in v1.42.9

SetUpdatedAt sets the UpdatedAt field's value.

func (AutomationRulesMetadata) String added in v1.42.9

func (s AutomationRulesMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AvailabilityZone

type AvailabilityZone struct {

	// The ID of the subnet. You can specify one subnet per Availability Zone.
	SubnetId *string `type:"string"`

	// The name of the Availability Zone.
	ZoneName *string `type:"string"`
	// contains filtered or unexported fields
}

Information about an Availability Zone.

func (AvailabilityZone) GoString

func (s AvailabilityZone) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AvailabilityZone) SetSubnetId

func (s *AvailabilityZone) SetSubnetId(v string) *AvailabilityZone

SetSubnetId sets the SubnetId field's value.

func (*AvailabilityZone) SetZoneName

func (s *AvailabilityZone) SetZoneName(v string) *AvailabilityZone

SetZoneName sets the ZoneName field's value.

func (AvailabilityZone) String

func (s AvailabilityZone) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAmazonMqBrokerDetails added in v1.42.9

type AwsAmazonMqBrokerDetails struct {

	// The authentication strategy used to secure the broker. The default is SIMPLE.
	AuthenticationStrategy *string `type:"string"`

	// Whether automatically upgrade new minor versions for brokers, as new versions
	// are released and supported by Amazon MQ. Automatic upgrades occur during
	// the scheduled maintenance window of the broker or after a manual broker reboot.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the broker.
	BrokerArn *string `type:"string"`

	// The unique ID that Amazon MQ generates for the broker.
	BrokerId *string `type:"string"`

	// The broker's name.
	BrokerName *string `type:"string"`

	// The broker's deployment mode.
	DeploymentMode *string `type:"string"`

	// Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.
	EncryptionOptions *AwsAmazonMqBrokerEncryptionOptionsDetails `type:"structure"`

	// The type of broker engine.
	EngineType *string `type:"string"`

	// The version of the broker engine.
	EngineVersion *string `type:"string"`

	// The broker's instance type.
	HostInstanceType *string `type:"string"`

	// The metadata of the Lightweight Directory Access Protocol (LDAP) server used
	// to authenticate and authorize connections to the broker. This is an optional
	// failover server.
	LdapServerMetadata *AwsAmazonMqBrokerLdapServerMetadataDetails `type:"structure"`

	// Turns on Amazon CloudWatch logging for brokers.
	Logs *AwsAmazonMqBrokerLogsDetails `type:"structure"`

	// The scheduled time period (UTC) during which Amazon MQ begins to apply pending
	// updates or patches to the broker.
	MaintenanceWindowStartTime *AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails `type:"structure"`

	// Permits connections from applications outside of the VPC that hosts the broker's
	// subnets.
	PubliclyAccessible *bool `type:"boolean"`

	// The list of rules (one minimum, 125 maximum) that authorize connections to
	// brokers.
	SecurityGroups []*string `type:"list"`

	// The broker's storage type.
	StorageType *string `type:"string"`

	// The list of groups that define which subnets and IP ranges the broker can
	// use from different Availability Zones.
	SubnetIds []*string `type:"list"`

	// The list of all broker usernames for the specified broker. Doesn't apply
	// to RabbitMQ brokers.
	Users []*AwsAmazonMqBrokerUsersDetails `type:"list"`
	// contains filtered or unexported fields
}

Provides details about an Amazon MQ message broker. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.

func (AwsAmazonMqBrokerDetails) GoString added in v1.42.9

func (s AwsAmazonMqBrokerDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAmazonMqBrokerDetails) SetAuthenticationStrategy added in v1.42.9

func (s *AwsAmazonMqBrokerDetails) SetAuthenticationStrategy(v string) *AwsAmazonMqBrokerDetails

SetAuthenticationStrategy sets the AuthenticationStrategy field's value.

func (*AwsAmazonMqBrokerDetails) SetAutoMinorVersionUpgrade added in v1.42.9

func (s *AwsAmazonMqBrokerDetails) SetAutoMinorVersionUpgrade(v bool) *AwsAmazonMqBrokerDetails

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*AwsAmazonMqBrokerDetails) SetBrokerArn added in v1.42.9

SetBrokerArn sets the BrokerArn field's value.

func (*AwsAmazonMqBrokerDetails) SetBrokerId added in v1.42.9

SetBrokerId sets the BrokerId field's value.

func (*AwsAmazonMqBrokerDetails) SetBrokerName added in v1.42.9

SetBrokerName sets the BrokerName field's value.

func (*AwsAmazonMqBrokerDetails) SetDeploymentMode added in v1.42.9

func (s *AwsAmazonMqBrokerDetails) SetDeploymentMode(v string) *AwsAmazonMqBrokerDetails

SetDeploymentMode sets the DeploymentMode field's value.

func (*AwsAmazonMqBrokerDetails) SetEncryptionOptions added in v1.42.9

SetEncryptionOptions sets the EncryptionOptions field's value.

func (*AwsAmazonMqBrokerDetails) SetEngineType added in v1.42.9

SetEngineType sets the EngineType field's value.

func (*AwsAmazonMqBrokerDetails) SetEngineVersion added in v1.42.9

SetEngineVersion sets the EngineVersion field's value.

func (*AwsAmazonMqBrokerDetails) SetHostInstanceType added in v1.42.9

func (s *AwsAmazonMqBrokerDetails) SetHostInstanceType(v string) *AwsAmazonMqBrokerDetails

SetHostInstanceType sets the HostInstanceType field's value.

func (*AwsAmazonMqBrokerDetails) SetLdapServerMetadata added in v1.42.9

SetLdapServerMetadata sets the LdapServerMetadata field's value.

func (*AwsAmazonMqBrokerDetails) SetLogs added in v1.42.9

SetLogs sets the Logs field's value.

func (*AwsAmazonMqBrokerDetails) SetMaintenanceWindowStartTime added in v1.42.9

SetMaintenanceWindowStartTime sets the MaintenanceWindowStartTime field's value.

func (*AwsAmazonMqBrokerDetails) SetPubliclyAccessible added in v1.42.9

func (s *AwsAmazonMqBrokerDetails) SetPubliclyAccessible(v bool) *AwsAmazonMqBrokerDetails

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*AwsAmazonMqBrokerDetails) SetSecurityGroups added in v1.42.9

func (s *AwsAmazonMqBrokerDetails) SetSecurityGroups(v []*string) *AwsAmazonMqBrokerDetails

SetSecurityGroups sets the SecurityGroups field's value.

func (*AwsAmazonMqBrokerDetails) SetStorageType added in v1.42.9

SetStorageType sets the StorageType field's value.

func (*AwsAmazonMqBrokerDetails) SetSubnetIds added in v1.42.9

SetSubnetIds sets the SubnetIds field's value.

func (*AwsAmazonMqBrokerDetails) SetUsers added in v1.42.9

SetUsers sets the Users field's value.

func (AwsAmazonMqBrokerDetails) String added in v1.42.9

func (s AwsAmazonMqBrokerDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAmazonMqBrokerEncryptionOptionsDetails added in v1.42.9

type AwsAmazonMqBrokerEncryptionOptionsDetails struct {

	// The KMS key that’s used to encrypt your data at rest. If not provided,
	// Amazon MQ will use a default KMS key to encrypt your data.
	KmsKeyId *string `type:"string"`

	// Specifies that an KMS key should be used for at-rest encryption. Set to true
	// by default if no value is provided (for example, for RabbitMQ brokers).
	UseAwsOwnedKey *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Provides details about broker encryption options.

func (AwsAmazonMqBrokerEncryptionOptionsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAmazonMqBrokerEncryptionOptionsDetails) SetKmsKeyId added in v1.42.9

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsAmazonMqBrokerEncryptionOptionsDetails) SetUseAwsOwnedKey added in v1.42.9

SetUseAwsOwnedKey sets the UseAwsOwnedKey field's value.

func (AwsAmazonMqBrokerEncryptionOptionsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAmazonMqBrokerLdapServerMetadataDetails added in v1.42.9

type AwsAmazonMqBrokerLdapServerMetadataDetails struct {

	// Specifies the location of the LDAP server, such as Amazon Web Services Directory
	// Service for Microsoft Active Directory.
	Hosts []*string `type:"list"`

	// The distinguished name of the node in the directory information tree (DIT)
	// to search for roles or groups.
	RoleBase *string `type:"string"`

	// The group name attribute in a role entry whose value is the name of that
	// role.
	RoleName *string `type:"string"`

	// The LDAP search filter used to find roles within the roleBase.
	RoleSearchMatching *string `type:"string"`

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

	// A username for the service account, which is an account in your LDAP server
	// that has access to initiate a connection.
	ServiceAccountUsername *string `type:"string"`

	// Selects a particular subtree of the directory information tree (DIT) to search
	// for user entries.
	UserBase *string `type:"string"`

	// The name of the LDAP attribute in the user's directory entry for the user's
	// group membership.
	UserRoleName *string `type:"string"`

	// The LDAP search filter used to find users within the userBase.
	UserSearchMatching *string `type:"string"`

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

The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker. This is an optional failover server.

func (AwsAmazonMqBrokerLdapServerMetadataDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetHosts added in v1.42.9

SetHosts sets the Hosts field's value.

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetRoleBase added in v1.42.9

SetRoleBase sets the RoleBase field's value.

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetRoleName added in v1.42.9

SetRoleName sets the RoleName field's value.

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetRoleSearchMatching added in v1.42.9

SetRoleSearchMatching sets the RoleSearchMatching field's value.

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetRoleSearchSubtree added in v1.42.9

SetRoleSearchSubtree sets the RoleSearchSubtree field's value.

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetServiceAccountUsername added in v1.42.9

SetServiceAccountUsername sets the ServiceAccountUsername field's value.

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetUserBase added in v1.42.9

SetUserBase sets the UserBase field's value.

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetUserRoleName added in v1.42.9

SetUserRoleName sets the UserRoleName field's value.

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetUserSearchMatching added in v1.42.9

SetUserSearchMatching sets the UserSearchMatching field's value.

func (*AwsAmazonMqBrokerLdapServerMetadataDetails) SetUserSearchSubtree added in v1.42.9

SetUserSearchSubtree sets the UserSearchSubtree field's value.

func (AwsAmazonMqBrokerLdapServerMetadataDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAmazonMqBrokerLogsDetails added in v1.42.9

type AwsAmazonMqBrokerLogsDetails struct {

	// Activates audit logging. Every user management action made using JMX or the
	// ActiveMQ Web Console is logged. Doesn't apply to RabbitMQ brokers.
	Audit *bool `type:"boolean"`

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

	// Activates general logging.
	General *bool `type:"boolean"`

	// The location of the CloudWatch Logs log group where general logs are sent.
	GeneralLogGroup *string `type:"string"`

	// The list of information about logs that are to be turned on for the specified
	// broker.
	Pending *AwsAmazonMqBrokerLogsPendingDetails `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about logs to be activated for the specified broker.

func (AwsAmazonMqBrokerLogsDetails) GoString added in v1.42.9

func (s AwsAmazonMqBrokerLogsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAmazonMqBrokerLogsDetails) SetAudit added in v1.42.9

SetAudit sets the Audit field's value.

func (*AwsAmazonMqBrokerLogsDetails) SetAuditLogGroup added in v1.42.9

SetAuditLogGroup sets the AuditLogGroup field's value.

func (*AwsAmazonMqBrokerLogsDetails) SetGeneral added in v1.42.9

SetGeneral sets the General field's value.

func (*AwsAmazonMqBrokerLogsDetails) SetGeneralLogGroup added in v1.42.9

SetGeneralLogGroup sets the GeneralLogGroup field's value.

func (*AwsAmazonMqBrokerLogsDetails) SetPending added in v1.42.9

SetPending sets the Pending field's value.

func (AwsAmazonMqBrokerLogsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAmazonMqBrokerLogsPendingDetails added in v1.42.9

type AwsAmazonMqBrokerLogsPendingDetails struct {

	// Activates audit logging. Every user management action made using JMX or the
	// ActiveMQ Web Console is logged. Doesn't apply to RabbitMQ brokers.
	Audit *bool `type:"boolean"`

	// Activates general logging.
	General *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Provides information about logs to be activated for the specified broker.

func (AwsAmazonMqBrokerLogsPendingDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAmazonMqBrokerLogsPendingDetails) SetAudit added in v1.42.9

SetAudit sets the Audit field's value.

func (*AwsAmazonMqBrokerLogsPendingDetails) SetGeneral added in v1.42.9

SetGeneral sets the General field's value.

func (AwsAmazonMqBrokerLogsPendingDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails added in v1.42.9

type AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails struct {

	// The day of the week on which the maintenance window falls.
	DayOfWeek *string `type:"string"`

	// The time, in 24-hour format, on which the maintenance window falls.
	TimeOfDay *string `type:"string"`

	// The time zone in either the Country/City format or the UTC offset format.
	// UTC is the default format.
	TimeZone *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails) SetDayOfWeek added in v1.42.9

SetDayOfWeek sets the DayOfWeek field's value.

func (*AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails) SetTimeOfDay added in v1.42.9

SetTimeOfDay sets the TimeOfDay field's value.

func (*AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails) SetTimeZone added in v1.42.9

SetTimeZone sets the TimeZone field's value.

func (AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAmazonMqBrokerUsersDetails added in v1.42.9

type AwsAmazonMqBrokerUsersDetails struct {

	// The type of change pending for the broker user.
	PendingChange *string `type:"string"`

	// The username of the broker user.
	Username *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.

func (AwsAmazonMqBrokerUsersDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAmazonMqBrokerUsersDetails) SetPendingChange added in v1.42.9

SetPendingChange sets the PendingChange field's value.

func (*AwsAmazonMqBrokerUsersDetails) SetUsername added in v1.42.9

SetUsername sets the Username field's value.

func (AwsAmazonMqBrokerUsersDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsApiCallAction

type AwsApiCallAction struct {

	// Identifies the resources that were affected by the API call.
	AffectedResources map[string]*string `type:"map"`

	// The name of the API method that was issued.
	Api *string `type:"string"`

	// Indicates whether the API call originated from a remote IP address (remoteip)
	// or from a DNS domain (domain).
	CallerType *string `type:"string"`

	// Provided if CallerType is domain. Provides information about the DNS domain
	// that the API call originated from.
	DomainDetails *AwsApiCallActionDomainDetails `type:"structure"`

	// An ISO8601-formatted timestamp that indicates when the API call was first
	// observed.
	//
	// A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot
	// contain spaces, and date and time should be separated by T. For more information,
	// see RFC 3339 section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6).
	FirstSeen *string `type:"string"`

	// An ISO8601-formatted timestamp that indicates when the API call was most
	// recently observed.
	//
	// A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot
	// contain spaces, and date and time should be separated by T. For more information,
	// see RFC 3339 section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6).
	LastSeen *string `type:"string"`

	// Provided if CallerType is remoteIp. Provides information about the remote
	// IP address that the API call originated from.
	RemoteIpDetails *ActionRemoteIpDetails `type:"structure"`

	// The name of the Amazon Web Services service that the API method belongs to.
	ServiceName *string `type:"string"`
	// contains filtered or unexported fields
}

Provided if ActionType is AWS_API_CALL. It provides details about the API call that was detected.

func (AwsApiCallAction) GoString

func (s AwsApiCallAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsApiCallAction) SetAffectedResources

func (s *AwsApiCallAction) SetAffectedResources(v map[string]*string) *AwsApiCallAction

SetAffectedResources sets the AffectedResources field's value.

func (*AwsApiCallAction) SetApi

SetApi sets the Api field's value.

func (*AwsApiCallAction) SetCallerType

func (s *AwsApiCallAction) SetCallerType(v string) *AwsApiCallAction

SetCallerType sets the CallerType field's value.

func (*AwsApiCallAction) SetDomainDetails

SetDomainDetails sets the DomainDetails field's value.

func (*AwsApiCallAction) SetFirstSeen

func (s *AwsApiCallAction) SetFirstSeen(v string) *AwsApiCallAction

SetFirstSeen sets the FirstSeen field's value.

func (*AwsApiCallAction) SetLastSeen

func (s *AwsApiCallAction) SetLastSeen(v string) *AwsApiCallAction

SetLastSeen sets the LastSeen field's value.

func (*AwsApiCallAction) SetRemoteIpDetails

func (s *AwsApiCallAction) SetRemoteIpDetails(v *ActionRemoteIpDetails) *AwsApiCallAction

SetRemoteIpDetails sets the RemoteIpDetails field's value.

func (*AwsApiCallAction) SetServiceName

func (s *AwsApiCallAction) SetServiceName(v string) *AwsApiCallAction

SetServiceName sets the ServiceName field's value.

func (AwsApiCallAction) String

func (s AwsApiCallAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsApiCallActionDomainDetails

type AwsApiCallActionDomainDetails struct {

	// The name of the DNS domain that issued the API call.
	Domain *string `type:"string"`
	// contains filtered or unexported fields
}

Provided if CallerType is domain. It provides information about the DNS domain that issued the API call.

func (AwsApiCallActionDomainDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsApiCallActionDomainDetails) SetDomain

SetDomain sets the Domain field's value.

func (AwsApiCallActionDomainDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsApiGatewayAccessLogSettings

type AwsApiGatewayAccessLogSettings struct {

	// The ARN of the CloudWatch Logs log group that receives the access logs.
	DestinationArn *string `type:"string"`

	// A single-line format of the access logs of data, as specified by selected
	// $context variables. The format must include at least $context.requestId.
	Format *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about settings for logging access for the stage.

func (AwsApiGatewayAccessLogSettings) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsApiGatewayAccessLogSettings) SetDestinationArn

SetDestinationArn sets the DestinationArn field's value.

func (*AwsApiGatewayAccessLogSettings) SetFormat

SetFormat sets the Format field's value.

func (AwsApiGatewayAccessLogSettings) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsApiGatewayCanarySettings

type AwsApiGatewayCanarySettings struct {

	// The deployment identifier for the canary deployment.
	DeploymentId *string `type:"string"`

	// The percentage of traffic that is diverted to a canary deployment.
	PercentTraffic *float64 `type:"double"`

	// Stage variables that are overridden in the canary release deployment. The
	// variables include new stage variables that are introduced in the canary.
	//
	// Each variable is represented as a string-to-string map between the stage
	// variable name and the variable value.
	StageVariableOverrides map[string]*string `type:"map"`

	// Indicates whether the canary deployment uses the stage cache.
	UseStageCache *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Contains information about settings for canary deployment in the stage.

func (AwsApiGatewayCanarySettings) GoString

func (s AwsApiGatewayCanarySettings) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsApiGatewayCanarySettings) SetDeploymentId

SetDeploymentId sets the DeploymentId field's value.

func (*AwsApiGatewayCanarySettings) SetPercentTraffic

SetPercentTraffic sets the PercentTraffic field's value.

func (*AwsApiGatewayCanarySettings) SetStageVariableOverrides

func (s *AwsApiGatewayCanarySettings) SetStageVariableOverrides(v map[string]*string) *AwsApiGatewayCanarySettings

SetStageVariableOverrides sets the StageVariableOverrides field's value.

func (*AwsApiGatewayCanarySettings) SetUseStageCache

SetUseStageCache sets the UseStageCache field's value.

func (AwsApiGatewayCanarySettings) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsApiGatewayEndpointConfiguration

type AwsApiGatewayEndpointConfiguration struct {

	// A list of endpoint types for the REST API.
	//
	// For an edge-optimized API, the endpoint type is EDGE. For a Regional API,
	// the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.
	Types []*string `type:"list"`
	// contains filtered or unexported fields
}

Contains information about the endpoints for the API.

func (AwsApiGatewayEndpointConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsApiGatewayEndpointConfiguration) SetTypes

SetTypes sets the Types field's value.

func (AwsApiGatewayEndpointConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsApiGatewayMethodSettings

type AwsApiGatewayMethodSettings struct {

	// Indicates whether the cached responses are encrypted.
	CacheDataEncrypted *bool `type:"boolean"`

	// Specifies the time to live (TTL), in seconds, for cached responses. The higher
	// the TTL, the longer the response is cached.
	CacheTtlInSeconds *int64 `type:"integer"`

	// Indicates whether responses are cached and returned for requests. For responses
	// to be cached, a cache cluster must be enabled on the stage.
	CachingEnabled *bool `type:"boolean"`

	// Indicates whether data trace logging is enabled for the method. Data trace
	// logging affects the log entries that are pushed to CloudWatch Logs.
	DataTraceEnabled *bool `type:"boolean"`

	// The HTTP method. You can use an asterisk (*) as a wildcard to apply method
	// settings to multiple methods.
	HttpMethod *string `type:"string"`

	// The logging level for this method. The logging level affects the log entries
	// that are pushed to CloudWatch Logs.
	//
	// If the logging level is ERROR, then the logs only include error-level entries.
	//
	// If the logging level is INFO, then the logs include both ERROR events and
	// extra informational events.
	//
	// Valid values: OFF | ERROR | INFO
	LoggingLevel *string `type:"string"`

	// Indicates whether CloudWatch metrics are enabled for the method.
	MetricsEnabled *bool `type:"boolean"`

	// Indicates whether authorization is required for a cache invalidation request.
	RequireAuthorizationForCacheControl *bool `type:"boolean"`

	// The resource path for this method. Forward slashes (/) are encoded as ~1
	// . The initial slash must include a forward slash.
	//
	// For example, the path value /resource/subresource must be encoded as /~1resource~1subresource.
	//
	// To specify the root path, use only a slash (/). You can use an asterisk (*)
	// as a wildcard to apply method settings to multiple methods.
	ResourcePath *string `type:"string"`

	// The throttling burst limit for the method.
	ThrottlingBurstLimit *int64 `type:"integer"`

	// The throttling rate limit for the method.
	ThrottlingRateLimit *float64 `type:"double"`

	// Indicates how to handle unauthorized requests for cache invalidation.
	//
	// Valid values: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER | SUCCEED_WITHOUT_RESPONSE_HEADER
	UnauthorizedCacheControlHeaderStrategy *string `type:"string"`
	// contains filtered or unexported fields
}

Defines settings for a method for the stage.

func (AwsApiGatewayMethodSettings) GoString

func (s AwsApiGatewayMethodSettings) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsApiGatewayMethodSettings) SetCacheDataEncrypted

func (s *AwsApiGatewayMethodSettings) SetCacheDataEncrypted(v bool) *AwsApiGatewayMethodSettings

SetCacheDataEncrypted sets the CacheDataEncrypted field's value.

func (*AwsApiGatewayMethodSettings) SetCacheTtlInSeconds

SetCacheTtlInSeconds sets the CacheTtlInSeconds field's value.

func (*AwsApiGatewayMethodSettings) SetCachingEnabled

SetCachingEnabled sets the CachingEnabled field's value.

func (*AwsApiGatewayMethodSettings) SetDataTraceEnabled

SetDataTraceEnabled sets the DataTraceEnabled field's value.

func (*AwsApiGatewayMethodSettings) SetHttpMethod

SetHttpMethod sets the HttpMethod field's value.

func (*AwsApiGatewayMethodSettings) SetLoggingLevel

SetLoggingLevel sets the LoggingLevel field's value.

func (*AwsApiGatewayMethodSettings) SetMetricsEnabled

SetMetricsEnabled sets the MetricsEnabled field's value.

func (*AwsApiGatewayMethodSettings) SetRequireAuthorizationForCacheControl

func (s *AwsApiGatewayMethodSettings) SetRequireAuthorizationForCacheControl(v bool) *AwsApiGatewayMethodSettings

SetRequireAuthorizationForCacheControl sets the RequireAuthorizationForCacheControl field's value.

func (*AwsApiGatewayMethodSettings) SetResourcePath

SetResourcePath sets the ResourcePath field's value.

func (*AwsApiGatewayMethodSettings) SetThrottlingBurstLimit

func (s *AwsApiGatewayMethodSettings) SetThrottlingBurstLimit(v int64) *AwsApiGatewayMethodSettings

SetThrottlingBurstLimit sets the ThrottlingBurstLimit field's value.

func (*AwsApiGatewayMethodSettings) SetThrottlingRateLimit

func (s *AwsApiGatewayMethodSettings) SetThrottlingRateLimit(v float64) *AwsApiGatewayMethodSettings

SetThrottlingRateLimit sets the ThrottlingRateLimit field's value.

func (*AwsApiGatewayMethodSettings) SetUnauthorizedCacheControlHeaderStrategy

func (s *AwsApiGatewayMethodSettings) SetUnauthorizedCacheControlHeaderStrategy(v string) *AwsApiGatewayMethodSettings

SetUnauthorizedCacheControlHeaderStrategy sets the UnauthorizedCacheControlHeaderStrategy field's value.

func (AwsApiGatewayMethodSettings) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsApiGatewayRestApiDetails

type AwsApiGatewayRestApiDetails struct {

	// The source of the API key for metering requests according to a usage plan.
	//
	// HEADER indicates whether to read the API key from the X-API-Key header of
	// a request.
	//
	// AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey
	// from a custom authorizer.
	ApiKeySource *string `type:"string"`

	// The list of binary media types supported by the REST API.
	BinaryMediaTypes []*string `type:"list"`

	// Indicates when the API was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreatedDate *string `type:"string"`

	// A description of the REST API.
	Description *string `type:"string"`

	// The endpoint configuration of the REST API.
	EndpointConfiguration *AwsApiGatewayEndpointConfiguration `type:"structure"`

	// The identifier of the REST API.
	Id *string `type:"string"`

	// The minimum size in bytes of a payload before compression is enabled.
	//
	// If null, then compression is disabled.
	//
	// If 0, then all payloads are compressed.
	MinimumCompressionSize *int64 `type:"integer"`

	// The name of the REST API.
	Name *string `type:"string"`

	// The version identifier for the REST API.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about a REST API in version 1 of Amazon API Gateway.

func (AwsApiGatewayRestApiDetails) GoString

func (s AwsApiGatewayRestApiDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsApiGatewayRestApiDetails) SetApiKeySource

SetApiKeySource sets the ApiKeySource field's value.

func (*AwsApiGatewayRestApiDetails) SetBinaryMediaTypes

func (s *AwsApiGatewayRestApiDetails) SetBinaryMediaTypes(v []*string) *AwsApiGatewayRestApiDetails

SetBinaryMediaTypes sets the BinaryMediaTypes field's value.

func (*AwsApiGatewayRestApiDetails) SetCreatedDate

SetCreatedDate sets the CreatedDate field's value.

func (*AwsApiGatewayRestApiDetails) SetDescription

SetDescription sets the Description field's value.

func (*AwsApiGatewayRestApiDetails) SetEndpointConfiguration

SetEndpointConfiguration sets the EndpointConfiguration field's value.

func (*AwsApiGatewayRestApiDetails) SetId

SetId sets the Id field's value.

func (*AwsApiGatewayRestApiDetails) SetMinimumCompressionSize

func (s *AwsApiGatewayRestApiDetails) SetMinimumCompressionSize(v int64) *AwsApiGatewayRestApiDetails

SetMinimumCompressionSize sets the MinimumCompressionSize field's value.

func (*AwsApiGatewayRestApiDetails) SetName

SetName sets the Name field's value.

func (*AwsApiGatewayRestApiDetails) SetVersion

SetVersion sets the Version field's value.

func (AwsApiGatewayRestApiDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsApiGatewayStageDetails

type AwsApiGatewayStageDetails struct {

	// Settings for logging access for the stage.
	AccessLogSettings *AwsApiGatewayAccessLogSettings `type:"structure"`

	// Indicates whether a cache cluster is enabled for the stage.
	CacheClusterEnabled *bool `type:"boolean"`

	// If a cache cluster is enabled, the size of the cache cluster.
	CacheClusterSize *string `type:"string"`

	// If a cache cluster is enabled, the status of the cache cluster.
	CacheClusterStatus *string `type:"string"`

	// Information about settings for canary deployment in the stage.
	CanarySettings *AwsApiGatewayCanarySettings `type:"structure"`

	// The identifier of the client certificate for the stage.
	ClientCertificateId *string `type:"string"`

	// Indicates when the stage was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreatedDate *string `type:"string"`

	// The identifier of the deployment that the stage points to.
	DeploymentId *string `type:"string"`

	// A description of the stage.
	Description *string `type:"string"`

	// The version of the API documentation that is associated with the stage.
	DocumentationVersion *string `type:"string"`

	// Indicates when the stage was most recently updated.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	LastUpdatedDate *string `type:"string"`

	// Defines the method settings for the stage.
	MethodSettings []*AwsApiGatewayMethodSettings `type:"list"`

	// The name of the stage.
	StageName *string `type:"string"`

	// Indicates whether active tracing with X-Ray is enabled for the stage.
	TracingEnabled *bool `type:"boolean"`

	// A map that defines the stage variables for the stage.
	//
	// Variable names can have alphanumeric and underscore characters.
	//
	// Variable values can contain the following characters:
	//
	//    * Uppercase and lowercase letters
	//
	//    * Numbers
	//
	//    * Special characters -._~:/?#&=,
	Variables map[string]*string `type:"map"`

	// The ARN of the web ACL associated with the stage.
	WebAclArn *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a version 1 Amazon API Gateway stage.

func (AwsApiGatewayStageDetails) GoString

func (s AwsApiGatewayStageDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsApiGatewayStageDetails) SetAccessLogSettings

SetAccessLogSettings sets the AccessLogSettings field's value.

func (*AwsApiGatewayStageDetails) SetCacheClusterEnabled

func (s *AwsApiGatewayStageDetails) SetCacheClusterEnabled(v bool) *AwsApiGatewayStageDetails

SetCacheClusterEnabled sets the CacheClusterEnabled field's value.

func (*AwsApiGatewayStageDetails) SetCacheClusterSize

func (s *AwsApiGatewayStageDetails) SetCacheClusterSize(v string) *AwsApiGatewayStageDetails

SetCacheClusterSize sets the CacheClusterSize field's value.

func (*AwsApiGatewayStageDetails) SetCacheClusterStatus

func (s *AwsApiGatewayStageDetails) SetCacheClusterStatus(v string) *AwsApiGatewayStageDetails

SetCacheClusterStatus sets the CacheClusterStatus field's value.

func (*AwsApiGatewayStageDetails) SetCanarySettings

SetCanarySettings sets the CanarySettings field's value.

func (*AwsApiGatewayStageDetails) SetClientCertificateId

func (s *AwsApiGatewayStageDetails) SetClientCertificateId(v string) *AwsApiGatewayStageDetails

SetClientCertificateId sets the ClientCertificateId field's value.

func (*AwsApiGatewayStageDetails) SetCreatedDate

SetCreatedDate sets the CreatedDate field's value.

func (*AwsApiGatewayStageDetails) SetDeploymentId

SetDeploymentId sets the DeploymentId field's value.

func (*AwsApiGatewayStageDetails) SetDescription

SetDescription sets the Description field's value.

func (*AwsApiGatewayStageDetails) SetDocumentationVersion

func (s *AwsApiGatewayStageDetails) SetDocumentationVersion(v string) *AwsApiGatewayStageDetails

SetDocumentationVersion sets the DocumentationVersion field's value.

func (*AwsApiGatewayStageDetails) SetLastUpdatedDate

SetLastUpdatedDate sets the LastUpdatedDate field's value.

func (*AwsApiGatewayStageDetails) SetMethodSettings

SetMethodSettings sets the MethodSettings field's value.

func (*AwsApiGatewayStageDetails) SetStageName

SetStageName sets the StageName field's value.

func (*AwsApiGatewayStageDetails) SetTracingEnabled

func (s *AwsApiGatewayStageDetails) SetTracingEnabled(v bool) *AwsApiGatewayStageDetails

SetTracingEnabled sets the TracingEnabled field's value.

func (*AwsApiGatewayStageDetails) SetVariables

SetVariables sets the Variables field's value.

func (*AwsApiGatewayStageDetails) SetWebAclArn

SetWebAclArn sets the WebAclArn field's value.

func (AwsApiGatewayStageDetails) String

func (s AwsApiGatewayStageDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsApiGatewayV2ApiDetails

type AwsApiGatewayV2ApiDetails struct {

	// The URI of the API.
	//
	// Uses the format <api-id>.execute-api.<region>.amazonaws.com
	//
	// The stage name is typically appended to the URI to form a complete path to
	// a deployed API stage.
	ApiEndpoint *string `type:"string"`

	// The identifier of the API.
	ApiId *string `type:"string"`

	// An API key selection expression. Supported only for WebSocket APIs.
	ApiKeySelectionExpression *string `type:"string"`

	// A cross-origin resource sharing (CORS) configuration. Supported only for
	// HTTP APIs.
	CorsConfiguration *AwsCorsConfiguration `type:"structure"`

	// Indicates when the API was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreatedDate *string `type:"string"`

	// A description of the API.
	Description *string `type:"string"`

	// The name of the API.
	Name *string `type:"string"`

	// The API protocol for the API.
	//
	// Valid values: WEBSOCKET | HTTP
	ProtocolType *string `type:"string"`

	// The route selection expression for the API.
	//
	// For HTTP APIs, must be ${request.method} ${request.path}. This is the default
	// value for HTTP APIs.
	//
	// For WebSocket APIs, there is no default value.
	RouteSelectionExpression *string `type:"string"`

	// The version identifier for the API.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about a version 2 API in Amazon API Gateway.

func (AwsApiGatewayV2ApiDetails) GoString

func (s AwsApiGatewayV2ApiDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsApiGatewayV2ApiDetails) SetApiEndpoint

SetApiEndpoint sets the ApiEndpoint field's value.

func (*AwsApiGatewayV2ApiDetails) SetApiId

SetApiId sets the ApiId field's value.

func (*AwsApiGatewayV2ApiDetails) SetApiKeySelectionExpression

func (s *AwsApiGatewayV2ApiDetails) SetApiKeySelectionExpression(v string) *AwsApiGatewayV2ApiDetails

SetApiKeySelectionExpression sets the ApiKeySelectionExpression field's value.

func (*AwsApiGatewayV2ApiDetails) SetCorsConfiguration

SetCorsConfiguration sets the CorsConfiguration field's value.

func (*AwsApiGatewayV2ApiDetails) SetCreatedDate

SetCreatedDate sets the CreatedDate field's value.

func (*AwsApiGatewayV2ApiDetails) SetDescription

SetDescription sets the Description field's value.

func (*AwsApiGatewayV2ApiDetails) SetName

SetName sets the Name field's value.

func (*AwsApiGatewayV2ApiDetails) SetProtocolType

SetProtocolType sets the ProtocolType field's value.

func (*AwsApiGatewayV2ApiDetails) SetRouteSelectionExpression

func (s *AwsApiGatewayV2ApiDetails) SetRouteSelectionExpression(v string) *AwsApiGatewayV2ApiDetails

SetRouteSelectionExpression sets the RouteSelectionExpression field's value.

func (*AwsApiGatewayV2ApiDetails) SetVersion

SetVersion sets the Version field's value.

func (AwsApiGatewayV2ApiDetails) String

func (s AwsApiGatewayV2ApiDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsApiGatewayV2RouteSettings

type AwsApiGatewayV2RouteSettings struct {

	// Indicates whether data trace logging is enabled. Data trace logging affects
	// the log entries that are pushed to CloudWatch Logs. Supported only for WebSocket
	// APIs.
	DataTraceEnabled *bool `type:"boolean"`

	// Indicates whether detailed metrics are enabled.
	DetailedMetricsEnabled *bool `type:"boolean"`

	// The logging level. The logging level affects the log entries that are pushed
	// to CloudWatch Logs. Supported only for WebSocket APIs.
	//
	// If the logging level is ERROR, then the logs only include error-level entries.
	//
	// If the logging level is INFO, then the logs include both ERROR events and
	// extra informational events.
	//
	// Valid values: OFF | ERROR | INFO
	LoggingLevel *string `type:"string"`

	// The throttling burst limit.
	ThrottlingBurstLimit *int64 `type:"integer"`

	// The throttling rate limit.
	ThrottlingRateLimit *float64 `type:"double"`
	// contains filtered or unexported fields
}

Contains route settings for a stage.

func (AwsApiGatewayV2RouteSettings) GoString

func (s AwsApiGatewayV2RouteSettings) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsApiGatewayV2RouteSettings) SetDataTraceEnabled

SetDataTraceEnabled sets the DataTraceEnabled field's value.

func (*AwsApiGatewayV2RouteSettings) SetDetailedMetricsEnabled

func (s *AwsApiGatewayV2RouteSettings) SetDetailedMetricsEnabled(v bool) *AwsApiGatewayV2RouteSettings

SetDetailedMetricsEnabled sets the DetailedMetricsEnabled field's value.

func (*AwsApiGatewayV2RouteSettings) SetLoggingLevel

SetLoggingLevel sets the LoggingLevel field's value.

func (*AwsApiGatewayV2RouteSettings) SetThrottlingBurstLimit

func (s *AwsApiGatewayV2RouteSettings) SetThrottlingBurstLimit(v int64) *AwsApiGatewayV2RouteSettings

SetThrottlingBurstLimit sets the ThrottlingBurstLimit field's value.

func (*AwsApiGatewayV2RouteSettings) SetThrottlingRateLimit

SetThrottlingRateLimit sets the ThrottlingRateLimit field's value.

func (AwsApiGatewayV2RouteSettings) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsApiGatewayV2StageDetails

type AwsApiGatewayV2StageDetails struct {

	// Information about settings for logging access for the stage.
	AccessLogSettings *AwsApiGatewayAccessLogSettings `type:"structure"`

	// Indicates whether the stage is managed by API Gateway.
	ApiGatewayManaged *bool `type:"boolean"`

	// Indicates whether updates to an API automatically trigger a new deployment.
	AutoDeploy *bool `type:"boolean"`

	// The identifier of a client certificate for a stage. Supported only for WebSocket
	// API calls.
	ClientCertificateId *string `type:"string"`

	// Indicates when the stage was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreatedDate *string `type:"string"`

	// Default route settings for the stage.
	DefaultRouteSettings *AwsApiGatewayV2RouteSettings `type:"structure"`

	// The identifier of the deployment that the stage is associated with.
	DeploymentId *string `type:"string"`

	// The description of the stage.
	Description *string `type:"string"`

	// The status of the last deployment of a stage. Supported only if the stage
	// has automatic deployment enabled.
	LastDeploymentStatusMessage *string `type:"string"`

	// Indicates when the stage was most recently updated.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	LastUpdatedDate *string `type:"string"`

	// The route settings for the stage.
	RouteSettings *AwsApiGatewayV2RouteSettings `type:"structure"`

	// The name of the stage.
	StageName *string `type:"string"`

	// A map that defines the stage variables for the stage.
	//
	// Variable names can have alphanumeric and underscore characters.
	//
	// Variable values can contain the following characters:
	//
	//    * Uppercase and lowercase letters
	//
	//    * Numbers
	//
	//    * Special characters -._~:/?#&=,
	StageVariables map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

Contains information about a version 2 stage for Amazon API Gateway.

func (AwsApiGatewayV2StageDetails) GoString

func (s AwsApiGatewayV2StageDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsApiGatewayV2StageDetails) SetAccessLogSettings

SetAccessLogSettings sets the AccessLogSettings field's value.

func (*AwsApiGatewayV2StageDetails) SetApiGatewayManaged

func (s *AwsApiGatewayV2StageDetails) SetApiGatewayManaged(v bool) *AwsApiGatewayV2StageDetails

SetApiGatewayManaged sets the ApiGatewayManaged field's value.

func (*AwsApiGatewayV2StageDetails) SetAutoDeploy

SetAutoDeploy sets the AutoDeploy field's value.

func (*AwsApiGatewayV2StageDetails) SetClientCertificateId

func (s *AwsApiGatewayV2StageDetails) SetClientCertificateId(v string) *AwsApiGatewayV2StageDetails

SetClientCertificateId sets the ClientCertificateId field's value.

func (*AwsApiGatewayV2StageDetails) SetCreatedDate

SetCreatedDate sets the CreatedDate field's value.

func (*AwsApiGatewayV2StageDetails) SetDefaultRouteSettings

SetDefaultRouteSettings sets the DefaultRouteSettings field's value.

func (*AwsApiGatewayV2StageDetails) SetDeploymentId

SetDeploymentId sets the DeploymentId field's value.

func (*AwsApiGatewayV2StageDetails) SetDescription

SetDescription sets the Description field's value.

func (*AwsApiGatewayV2StageDetails) SetLastDeploymentStatusMessage

func (s *AwsApiGatewayV2StageDetails) SetLastDeploymentStatusMessage(v string) *AwsApiGatewayV2StageDetails

SetLastDeploymentStatusMessage sets the LastDeploymentStatusMessage field's value.

func (*AwsApiGatewayV2StageDetails) SetLastUpdatedDate

SetLastUpdatedDate sets the LastUpdatedDate field's value.

func (*AwsApiGatewayV2StageDetails) SetRouteSettings

SetRouteSettings sets the RouteSettings field's value.

func (*AwsApiGatewayV2StageDetails) SetStageName

SetStageName sets the StageName field's value.

func (*AwsApiGatewayV2StageDetails) SetStageVariables

SetStageVariables sets the StageVariables field's value.

func (AwsApiGatewayV2StageDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails added in v1.42.9

type AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails struct {

	// The type of security configuration for your GraphQL API: API key, Identity
	// and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools,
	// or Lambda.
	AuthenticationType *string `type:"string"`

	// The configuration for Lambda function authorization.
	LambdaAuthorizerConfig *AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails `type:"structure"`

	// The OpenID Connect configuration.
	OpenIdConnectConfig *AwsAppSyncGraphQlApiOpenIdConnectConfigDetails `type:"structure"`

	// The Amazon Cognito user pools configuration.
	UserPoolConfig *AwsAppSyncGraphQlApiUserPoolConfigDetails `type:"structure"`
	// contains filtered or unexported fields
}

A list of additional authentication providers for the GraphqlApi API.

func (AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails) SetAuthenticationType added in v1.42.9

SetAuthenticationType sets the AuthenticationType field's value.

func (*AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails) SetLambdaAuthorizerConfig added in v1.42.9

SetLambdaAuthorizerConfig sets the LambdaAuthorizerConfig field's value.

func (*AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails) SetOpenIdConnectConfig added in v1.42.9

SetOpenIdConnectConfig sets the OpenIdConnectConfig field's value.

func (*AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails) SetUserPoolConfig added in v1.42.9

SetUserPoolConfig sets the UserPoolConfig field's value.

func (AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAppSyncGraphQlApiDetails added in v1.42.9

type AwsAppSyncGraphQlApiDetails struct {

	// A list of additional authentication providers for the GraphQL API.
	AdditionalAuthenticationProviders []*AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails `type:"list"`

	// The unique identifier for the API.
	ApiId *string `type:"string"`

	// The Amazon Resource Name (ARN) of the API.
	Arn *string `type:"string"`

	// The type of security configuration for your GraphQL API: API key, Identity
	// and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools,
	// or Lambda.
	AuthenticationType *string `type:"string"`

	// The unique identifier for the API.
	Id *string `type:"string"`

	// Specifies the configuration for Lambda function authorization.
	LambdaAuthorizerConfig *AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails `type:"structure"`

	// The Amazon CloudWatch Logs configuration.
	LogConfig *AwsAppSyncGraphQlApiLogConfigDetails `type:"structure"`

	// The API name.
	Name *string `type:"string"`

	// Specifies the authorization configuration for using an OpenID Connect compliant
	// service with an AppSync GraphQL API endpoint.
	OpenIdConnectConfig *AwsAppSyncGraphQlApiOpenIdConnectConfigDetails `type:"structure"`

	// The Amazon Cognito user pools configuration.
	UserPoolConfig *AwsAppSyncGraphQlApiUserPoolConfigDetails `type:"structure"`

	// The Amazon Resource Name (ARN) of the WAF web access control list (web ACL)
	// associated with this GraphQL API, if one exists.
	WafWebAclArn *string `type:"string"`

	// Indicates whether to use X-Ray tracing for the GraphQL API.
	XrayEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Provides details about an AppSync Graph QL API, which lets you query multiple databases, microservices, and APIs from a single GraphQL endpoint.

func (AwsAppSyncGraphQlApiDetails) GoString added in v1.42.9

func (s AwsAppSyncGraphQlApiDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAppSyncGraphQlApiDetails) SetAdditionalAuthenticationProviders added in v1.42.9

SetAdditionalAuthenticationProviders sets the AdditionalAuthenticationProviders field's value.

func (*AwsAppSyncGraphQlApiDetails) SetApiId added in v1.42.9

SetApiId sets the ApiId field's value.

func (*AwsAppSyncGraphQlApiDetails) SetArn added in v1.42.9

SetArn sets the Arn field's value.

func (*AwsAppSyncGraphQlApiDetails) SetAuthenticationType added in v1.42.9

func (s *AwsAppSyncGraphQlApiDetails) SetAuthenticationType(v string) *AwsAppSyncGraphQlApiDetails

SetAuthenticationType sets the AuthenticationType field's value.

func (*AwsAppSyncGraphQlApiDetails) SetId added in v1.42.9

SetId sets the Id field's value.

func (*AwsAppSyncGraphQlApiDetails) SetLambdaAuthorizerConfig added in v1.42.9

SetLambdaAuthorizerConfig sets the LambdaAuthorizerConfig field's value.

func (*AwsAppSyncGraphQlApiDetails) SetLogConfig added in v1.42.9

SetLogConfig sets the LogConfig field's value.

func (*AwsAppSyncGraphQlApiDetails) SetName added in v1.42.9

SetName sets the Name field's value.

func (*AwsAppSyncGraphQlApiDetails) SetOpenIdConnectConfig added in v1.42.9

SetOpenIdConnectConfig sets the OpenIdConnectConfig field's value.

func (*AwsAppSyncGraphQlApiDetails) SetUserPoolConfig added in v1.42.9

SetUserPoolConfig sets the UserPoolConfig field's value.

func (*AwsAppSyncGraphQlApiDetails) SetWafWebAclArn added in v1.42.9

SetWafWebAclArn sets the WafWebAclArn field's value.

func (*AwsAppSyncGraphQlApiDetails) SetXrayEnabled added in v1.42.9

SetXrayEnabled sets the XrayEnabled field's value.

func (AwsAppSyncGraphQlApiDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails added in v1.42.9

type AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails struct {

	// The number of seconds a response should be cached for. The default is 5 minutes
	// (300 seconds).
	AuthorizerResultTtlInSeconds *int64 `type:"integer"`

	// The Amazon Resource Name (ARN) of the Lambda function to be called for authorization.
	// This can be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.
	AuthorizerUri *string `type:"string"`

	// A regular expression for validation of tokens before the Lambda function
	// is called.
	IdentityValidationExpression *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the authorization configuration for using an Lambda function with your AppSync GraphQL API endpoint.

func (AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails) SetAuthorizerResultTtlInSeconds added in v1.42.9

SetAuthorizerResultTtlInSeconds sets the AuthorizerResultTtlInSeconds field's value.

func (*AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails) SetAuthorizerUri added in v1.42.9

SetAuthorizerUri sets the AuthorizerUri field's value.

func (*AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails) SetIdentityValidationExpression added in v1.42.9

SetIdentityValidationExpression sets the IdentityValidationExpression field's value.

func (AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAppSyncGraphQlApiLogConfigDetails added in v1.42.9

type AwsAppSyncGraphQlApiLogConfigDetails struct {

	// The Amazon Resource Name (ARN) of the service role that AppSync assumes to
	// publish to CloudWatch Logs in your account.
	CloudWatchLogsRoleArn *string `type:"string"`

	// Set to TRUE to exclude sections that contain information such as headers,
	// context, and evaluated mapping templates, regardless of logging level.
	ExcludeVerboseContent *bool `type:"boolean"`

	// The field logging level.
	FieldLogLevel *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the logging configuration when writing GraphQL operations and tracing to Amazon CloudWatch for an AppSync GraphQL API.

func (AwsAppSyncGraphQlApiLogConfigDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAppSyncGraphQlApiLogConfigDetails) SetCloudWatchLogsRoleArn added in v1.42.9

SetCloudWatchLogsRoleArn sets the CloudWatchLogsRoleArn field's value.

func (*AwsAppSyncGraphQlApiLogConfigDetails) SetExcludeVerboseContent added in v1.42.9

SetExcludeVerboseContent sets the ExcludeVerboseContent field's value.

func (*AwsAppSyncGraphQlApiLogConfigDetails) SetFieldLogLevel added in v1.42.9

SetFieldLogLevel sets the FieldLogLevel field's value.

func (AwsAppSyncGraphQlApiLogConfigDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAppSyncGraphQlApiOpenIdConnectConfigDetails added in v1.42.9

type AwsAppSyncGraphQlApiOpenIdConnectConfigDetails struct {

	// The number of milliseconds that a token is valid after being authenticated.
	AuthTtL *int64 `type:"long"`

	// The client identifier of the relying party at the OpenID identity provider.
	// This identifier is typically obtained when the relying party is registered
	// with the OpenID identity provider. You can specify a regular expression so
	// that AppSync can validate against multiple client identifiers at a time.
	ClientId *string `type:"string"`

	// The number of milliseconds that a token is valid after it's issued to a user.
	IatTtL *int64 `type:"long"`

	// The issuer for the OIDC configuration. The issuer returned by discovery must
	// exactly match the value of iss in the ID token.
	Issuer *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the authorization configuration for using an OpenID Connect compliant service with your AppSync GraphQL API endpoint.

func (AwsAppSyncGraphQlApiOpenIdConnectConfigDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAppSyncGraphQlApiOpenIdConnectConfigDetails) SetAuthTtL added in v1.42.9

SetAuthTtL sets the AuthTtL field's value.

func (*AwsAppSyncGraphQlApiOpenIdConnectConfigDetails) SetClientId added in v1.42.9

SetClientId sets the ClientId field's value.

func (*AwsAppSyncGraphQlApiOpenIdConnectConfigDetails) SetIatTtL added in v1.42.9

SetIatTtL sets the IatTtL field's value.

func (*AwsAppSyncGraphQlApiOpenIdConnectConfigDetails) SetIssuer added in v1.42.9

SetIssuer sets the Issuer field's value.

func (AwsAppSyncGraphQlApiOpenIdConnectConfigDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAppSyncGraphQlApiUserPoolConfigDetails added in v1.42.9

type AwsAppSyncGraphQlApiUserPoolConfigDetails struct {

	// A regular expression for validating the incoming Amazon Cognito user pools
	// app client ID. If this value isn't set, no filtering is applied.
	AppIdClientRegex *string `type:"string"`

	// The Amazon Web Services Region in which the user pool was created.
	AwsRegion *string `type:"string"`

	// The action that you want your GraphQL API to take when a request that uses
	// Amazon Cognito user pools authentication doesn't match the Amazon Cognito
	// user pools configuration.
	DefaultAction *string `type:"string"`

	// The user pool ID.
	UserPoolId *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the authorization configuration for using Amazon Cognito user pools with your AppSync GraphQL API endpoint.

func (AwsAppSyncGraphQlApiUserPoolConfigDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAppSyncGraphQlApiUserPoolConfigDetails) SetAppIdClientRegex added in v1.42.9

SetAppIdClientRegex sets the AppIdClientRegex field's value.

func (*AwsAppSyncGraphQlApiUserPoolConfigDetails) SetAwsRegion added in v1.42.9

SetAwsRegion sets the AwsRegion field's value.

func (*AwsAppSyncGraphQlApiUserPoolConfigDetails) SetDefaultAction added in v1.42.9

SetDefaultAction sets the DefaultAction field's value.

func (*AwsAppSyncGraphQlApiUserPoolConfigDetails) SetUserPoolId added in v1.42.9

SetUserPoolId sets the UserPoolId field's value.

func (AwsAppSyncGraphQlApiUserPoolConfigDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAthenaWorkGroupConfigurationDetails added in v1.42.9

type AwsAthenaWorkGroupConfigurationDetails struct {

	// The location in Amazon S3 where query and calculation results are stored
	// and the encryption option, if any, used for query and calculation results.
	// These are known as client-side settings. If workgroup settings override client-side
	// settings, then the query uses the workgroup settings.
	ResultConfiguration *AwsAthenaWorkGroupConfigurationResultConfigurationDetails `type:"structure"`
	// contains filtered or unexported fields
}

The configuration of the workgroup, which includes the location in Amazon Simple Storage Service (Amazon S3) where query results are stored, the encryption option, if any, used for query results, whether Amazon CloudWatch metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified.

func (AwsAthenaWorkGroupConfigurationDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAthenaWorkGroupConfigurationDetails) SetResultConfiguration added in v1.42.9

SetResultConfiguration sets the ResultConfiguration field's value.

func (AwsAthenaWorkGroupConfigurationDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAthenaWorkGroupConfigurationResultConfigurationDetails added in v1.42.9

type AwsAthenaWorkGroupConfigurationResultConfigurationDetails struct {

	// Specifies the method used to encrypt the user’s data stores in the Athena
	// workgroup.
	EncryptionConfiguration *AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails `type:"structure"`
	// contains filtered or unexported fields
}

The location in Amazon Simple Storage Service (Amazon S3) where query and calculation results are stored and the encryption option, if any, used for query and calculation results. These are known as client-side settings. If workgroup settings override client-side settings, then the query uses the workgroup settings.

func (AwsAthenaWorkGroupConfigurationResultConfigurationDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAthenaWorkGroupConfigurationResultConfigurationDetails) SetEncryptionConfiguration added in v1.42.9

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (AwsAthenaWorkGroupConfigurationResultConfigurationDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails added in v1.42.9

type AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails struct {

	// Indicates whether Amazon Simple Storage Service (Amazon S3) server-side encryption
	// with Amazon S3 managed keys (SSE_S3), server-side encryption with KMS keys
	// (SSE_KMS), or client-side encryption with KMS customer managed keys (CSE_KMS)
	// is used.
	EncryptionOption *string `type:"string"`

	// For SSE_KMS and CSE_KMS, this is the KMS key Amazon Resource Name (ARN) or
	// ID.
	KmsKey *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the method used to encrypt the user’s data stores in the Athena workgroup.

func (AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails) SetEncryptionOption added in v1.42.9

SetEncryptionOption sets the EncryptionOption field's value.

func (*AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails) SetKmsKey added in v1.42.9

SetKmsKey sets the KmsKey field's value.

func (AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAthenaWorkGroupDetails added in v1.42.9

type AwsAthenaWorkGroupDetails struct {

	// The configuration of the workgroup, which includes the location in Amazon
	// Simple Storage Service (Amazon S3) where query results are stored, the encryption
	// option, if any, used for query results, whether Amazon CloudWatch metrics
	// are enabled for the workgroup, and the limit for the amount of bytes scanned
	// (cutoff) per query, if it is specified.
	Configuration *AwsAthenaWorkGroupConfigurationDetails `type:"structure"`

	// The workgroup description.
	Description *string `type:"string"`

	// The workgroup name.
	Name *string `type:"string"`

	// Whether the workgroup is enabled or disabled.
	State *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about an Amazon Athena workgroup.

func (AwsAthenaWorkGroupDetails) GoString added in v1.42.9

func (s AwsAthenaWorkGroupDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAthenaWorkGroupDetails) SetConfiguration added in v1.42.9

SetConfiguration sets the Configuration field's value.

func (*AwsAthenaWorkGroupDetails) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*AwsAthenaWorkGroupDetails) SetName added in v1.42.9

SetName sets the Name field's value.

func (*AwsAthenaWorkGroupDetails) SetState added in v1.42.9

SetState sets the State field's value.

func (AwsAthenaWorkGroupDetails) String added in v1.42.9

func (s AwsAthenaWorkGroupDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails added in v1.42.9

type AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails struct {

	// The name of the Availability Zone.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

An Availability Zone for the automatic scaling group.

func (AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails) SetValue added in v1.42.9

SetValue sets the Value field's value.

func (AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAutoScalingAutoScalingGroupDetails

type AwsAutoScalingAutoScalingGroupDetails struct {

	// The list of Availability Zones for the automatic scaling group.
	AvailabilityZones []*AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails `type:"list"`

	// Indicates whether capacity rebalancing is enabled.
	CapacityRebalance *bool `type:"boolean"`

	// Indicates when the auto scaling group was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreatedTime *string `type:"string"`

	// The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before
	// it checks the health status of an EC2 instance that has come into service.
	HealthCheckGracePeriod *int64 `type:"integer"`

	// The service to use for the health checks. Valid values are EC2 or ELB.
	HealthCheckType *string `type:"string"`

	// The name of the launch configuration.
	LaunchConfigurationName *string `type:"string"`

	// The launch template to use.
	LaunchTemplate *AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification `type:"structure"`

	// The list of load balancers associated with the group.
	LoadBalancerNames []*string `type:"list"`

	// The mixed instances policy for the automatic scaling group.
	MixedInstancesPolicy *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails `type:"structure"`
	// contains filtered or unexported fields
}

Provides details about an auto scaling group.

func (AwsAutoScalingAutoScalingGroupDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAutoScalingAutoScalingGroupDetails) SetAvailabilityZones added in v1.42.9

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*AwsAutoScalingAutoScalingGroupDetails) SetCapacityRebalance added in v1.42.9

SetCapacityRebalance sets the CapacityRebalance field's value.

func (*AwsAutoScalingAutoScalingGroupDetails) SetCreatedTime

SetCreatedTime sets the CreatedTime field's value.

func (*AwsAutoScalingAutoScalingGroupDetails) SetHealthCheckGracePeriod

SetHealthCheckGracePeriod sets the HealthCheckGracePeriod field's value.

func (*AwsAutoScalingAutoScalingGroupDetails) SetHealthCheckType

SetHealthCheckType sets the HealthCheckType field's value.

func (*AwsAutoScalingAutoScalingGroupDetails) SetLaunchConfigurationName

SetLaunchConfigurationName sets the LaunchConfigurationName field's value.

func (*AwsAutoScalingAutoScalingGroupDetails) SetLaunchTemplate added in v1.42.9

SetLaunchTemplate sets the LaunchTemplate field's value.

func (*AwsAutoScalingAutoScalingGroupDetails) SetLoadBalancerNames

SetLoadBalancerNames sets the LoadBalancerNames field's value.

func (*AwsAutoScalingAutoScalingGroupDetails) SetMixedInstancesPolicy added in v1.42.9

SetMixedInstancesPolicy sets the MixedInstancesPolicy field's value.

func (AwsAutoScalingAutoScalingGroupDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification added in v1.42.9

type AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification struct {

	// The identifier of the launch template. You must specify either LaunchTemplateId
	// or LaunchTemplateName.
	LaunchTemplateId *string `type:"string"`

	// The name of the launch template. You must specify either LaunchTemplateId
	// or LaunchTemplateName.
	LaunchTemplateName *string `type:"string"`

	// Identifies the version of the launch template. You can specify a version
	// identifier, or use the values $Latest or $Default.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Details about the launch template to use.

func (AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification) SetLaunchTemplateId added in v1.42.9

SetLaunchTemplateId sets the LaunchTemplateId field's value.

func (*AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification) SetLaunchTemplateName added in v1.42.9

SetLaunchTemplateName sets the LaunchTemplateName field's value.

func (*AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification) SetVersion added in v1.42.9

SetVersion sets the Version field's value.

func (AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails added in v1.42.9

type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails struct {

	// The instances distribution. The instances distribution specifies the distribution
	// of On-Demand Instances and Spot Instances, the maximum price to pay for Spot
	// Instances, and how the Auto Scaling group allocates instance types to fulfill
	// On-Demand and Spot capacity.
	InstancesDistribution *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails `type:"structure"`

	// The launch template to use and the instance types (overrides) to use to provision
	// EC2 instances to fulfill On-Demand and Spot capacities.
	LaunchTemplate *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails `type:"structure"`
	// contains filtered or unexported fields
}

The mixed instances policy for the automatic scaling group.

func (AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails) SetInstancesDistribution added in v1.42.9

SetInstancesDistribution sets the InstancesDistribution field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails) SetLaunchTemplate added in v1.42.9

SetLaunchTemplate sets the LaunchTemplate field's value.

func (AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails added in v1.42.9

type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails struct {

	// How to allocate instance types to fulfill On-Demand capacity. The valid value
	// is prioritized.
	OnDemandAllocationStrategy *string `type:"string"`

	// The minimum amount of the Auto Scaling group's capacity that must be fulfilled
	// by On-Demand Instances.
	OnDemandBaseCapacity *int64 `type:"integer"`

	// The percentage of On-Demand Instances and Spot Instances for additional capacity
	// beyond OnDemandBaseCapacity.
	OnDemandPercentageAboveBaseCapacity *int64 `type:"integer"`

	// How to allocate instances across Spot Instance pools. Valid values are as
	// follows:
	//
	//    * lowest-price
	//
	//    * capacity-optimized
	//
	//    * capacity-optimized-prioritized
	SpotAllocationStrategy *string `type:"string"`

	// The number of Spot Instance pools across which to allocate your Spot Instances.
	SpotInstancePools *int64 `type:"integer"`

	// The maximum price per unit hour that you are willing to pay for a Spot Instance.
	SpotMaxPrice *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the instances distribution.

func (AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) SetOnDemandAllocationStrategy added in v1.42.9

SetOnDemandAllocationStrategy sets the OnDemandAllocationStrategy field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) SetOnDemandBaseCapacity added in v1.42.9

SetOnDemandBaseCapacity sets the OnDemandBaseCapacity field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) SetOnDemandPercentageAboveBaseCapacity added in v1.42.9

SetOnDemandPercentageAboveBaseCapacity sets the OnDemandPercentageAboveBaseCapacity field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) SetSpotAllocationStrategy added in v1.42.9

SetSpotAllocationStrategy sets the SpotAllocationStrategy field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) SetSpotInstancePools added in v1.42.9

SetSpotInstancePools sets the SpotInstancePools field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) SetSpotMaxPrice added in v1.42.9

SetSpotMaxPrice sets the SpotMaxPrice field's value.

func (AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails added in v1.42.9

type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails struct {

	// The launch template to use for a mixed instances policy.
	LaunchTemplateSpecification *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification `type:"structure"`

	// Property values to use to override the values in the launch template.
	Overrides []*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails `type:"list"`
	// contains filtered or unexported fields
}

Describes a launch template and overrides for a mixed instances policy.

func (AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails) SetLaunchTemplateSpecification added in v1.42.9

SetLaunchTemplateSpecification sets the LaunchTemplateSpecification field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails) SetOverrides added in v1.42.9

SetOverrides sets the Overrides field's value.

func (AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification added in v1.42.9

type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification struct {

	// The identifier of the launch template. You must specify either LaunchTemplateId
	// or LaunchTemplateName.
	LaunchTemplateId *string `type:"string"`

	// The name of the launch template. You must specify either LaunchTemplateId
	// or LaunchTemplateName.
	LaunchTemplateName *string `type:"string"`

	// Identifies the version of the launch template. You can specify a version
	// identifier, or use the values $Latest or $Default.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Details about the launch template to use for a mixed instances policy.

func (AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification) SetLaunchTemplateId added in v1.42.9

SetLaunchTemplateId sets the LaunchTemplateId field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification) SetLaunchTemplateName added in v1.42.9

SetLaunchTemplateName sets the LaunchTemplateName field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification) SetVersion added in v1.42.9

SetVersion sets the Version field's value.

func (AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails added in v1.42.9

type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails struct {

	// The instance type. For example, m3.xlarge.
	InstanceType *string `type:"string"`

	// The number of capacity units provided by the specified instance type in terms
	// of virtual CPUs, memory, storage, throughput, or other relative performance
	// characteristic.
	WeightedCapacity *string `type:"string"`
	// contains filtered or unexported fields
}

Property values to use to override the values in the launch template.

func (AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails) SetInstanceType added in v1.42.9

SetInstanceType sets the InstanceType field's value.

func (*AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails) SetWeightedCapacity added in v1.42.9

SetWeightedCapacity sets the WeightedCapacity field's value.

func (AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails

type AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails struct {

	// The device name that is exposed to the EC2 instance. For example, /dev/sdh
	// or xvdh.
	DeviceName *string `type:"string"`

	// Parameters that are used to automatically set up Amazon EBS volumes when
	// an instance is launched.
	Ebs *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails `type:"structure"`

	// Whether to suppress the device that is included in the block device mapping
	// of the Amazon Machine Image (AMI).
	//
	// If NoDevice is true, then you cannot specify Ebs.>
	NoDevice *bool `type:"boolean"`

	// The name of the virtual device (for example, ephemeral0).
	//
	// You can provide either VirtualName or Ebs, but not both.
	VirtualName *string `type:"string"`
	// contains filtered or unexported fields
}

A block device for the instance.

func (AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails) SetDeviceName

SetDeviceName sets the DeviceName field's value.

func (*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails) SetEbs

SetEbs sets the Ebs field's value.

func (*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails) SetNoDevice

SetNoDevice sets the NoDevice field's value.

func (*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails) SetVirtualName

SetVirtualName sets the VirtualName field's value.

func (AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails

type AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails struct {

	// Whether to delete the volume when the instance is terminated.
	DeleteOnTermination *bool `type:"boolean"`

	// Whether to encrypt the volume.
	Encrypted *bool `type:"boolean"`

	// The number of input/output (I/O) operations per second (IOPS) to provision
	// for the volume.
	//
	// Only supported for gp3 or io1 volumes. Required for io1 volumes. Not used
	// with standard, gp2, st1, or sc1 volumes.
	Iops *int64 `type:"integer"`

	// The snapshot ID of the volume to use.
	//
	// You must specify either VolumeSize or SnapshotId.
	SnapshotId *string `type:"string"`

	// The volume size, in GiBs. The following are the supported volumes sizes for
	// each volume type:
	//
	//    * gp2 and gp3: 1-16,384
	//
	//    * io1: 4-16,384
	//
	//    * st1 and sc1: 125-16,384
	//
	//    * standard: 1-1,024
	//
	// You must specify either SnapshotId or VolumeSize. If you specify both SnapshotId
	// and VolumeSize, the volume size must be equal or greater than the size of
	// the snapshot.
	VolumeSize *int64 `type:"integer"`

	// The volume type. Valid values are as follows:
	//
	//    * gp2
	//
	//    * gp3
	//
	//    * io1
	//
	//    * sc1
	//
	//    * st1
	//
	//    * standard
	VolumeType *string `type:"string"`
	// contains filtered or unexported fields
}

Parameters that are used to automatically set up EBS volumes when an instance is launched.

func (AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) SetDeleteOnTermination

SetDeleteOnTermination sets the DeleteOnTermination field's value.

func (*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) SetEncrypted

SetEncrypted sets the Encrypted field's value.

func (*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) SetIops

SetIops sets the Iops field's value.

func (*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) SetSnapshotId

SetSnapshotId sets the SnapshotId field's value.

func (*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) SetVolumeSize

SetVolumeSize sets the VolumeSize field's value.

func (*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) SetVolumeType

SetVolumeType sets the VolumeType field's value.

func (AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAutoScalingLaunchConfigurationDetails

type AwsAutoScalingLaunchConfigurationDetails struct {

	// For Auto Scaling groups that run in a VPC, specifies whether to assign a
	// public IP address to the group's instances.
	AssociatePublicIpAddress *bool `type:"boolean"`

	// Specifies the block devices for the instance.
	BlockDeviceMappings []*AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails `type:"list"`

	// The identifier of a ClassicLink-enabled VPC that EC2-Classic instances are
	// linked to.
	ClassicLinkVpcId *string `type:"string"`

	// The identifiers of one or more security groups for the VPC that is specified
	// in ClassicLinkVPCId.
	ClassicLinkVpcSecurityGroups []*string `type:"list"`

	// The creation date and time for the launch configuration.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreatedTime *string `type:"string"`

	// Whether the launch configuration is optimized for Amazon EBS I/O.
	EbsOptimized *bool `type:"boolean"`

	// The name or the ARN of the instance profile associated with the IAM role
	// for the instance. The instance profile contains the IAM role.
	IamInstanceProfile *string `type:"string"`

	// The identifier of the Amazon Machine Image (AMI) that is used to launch EC2
	// instances.
	ImageId *string `type:"string"`

	// Indicates the type of monitoring for instances in the group.
	InstanceMonitoring *AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails `type:"structure"`

	// The instance type for the instances.
	InstanceType *string `type:"string"`

	// The identifier of the kernel associated with the AMI.
	KernelId *string `type:"string"`

	// The name of the key pair.
	KeyName *string `type:"string"`

	// The name of the launch configuration.
	LaunchConfigurationName *string `type:"string"`

	// The metadata options for the instances.
	MetadataOptions *AwsAutoScalingLaunchConfigurationMetadataOptions `type:"structure"`

	// The tenancy of the instance. An instance with dedicated tenancy runs on isolated,
	// single-tenant hardware and can only be launched into a VPC.
	PlacementTenancy *string `type:"string"`

	// The identifier of the RAM disk associated with the AMI.
	RamdiskId *string `type:"string"`

	// The security groups to assign to the instances in the Auto Scaling group.
	SecurityGroups []*string `type:"list"`

	// The maximum hourly price to be paid for any Spot Instance that is launched
	// to fulfill the request.
	SpotPrice *string `type:"string"`

	// The user data to make available to the launched EC2 instances. Must be base64-encoded
	// text.
	UserData *string `type:"string"`
	// contains filtered or unexported fields
}

Details about a launch configuration.

func (AwsAutoScalingLaunchConfigurationDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAutoScalingLaunchConfigurationDetails) SetAssociatePublicIpAddress

SetAssociatePublicIpAddress sets the AssociatePublicIpAddress field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetBlockDeviceMappings

SetBlockDeviceMappings sets the BlockDeviceMappings field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetClassicLinkVpcId

SetClassicLinkVpcId sets the ClassicLinkVpcId field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetClassicLinkVpcSecurityGroups

SetClassicLinkVpcSecurityGroups sets the ClassicLinkVpcSecurityGroups field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetCreatedTime

SetCreatedTime sets the CreatedTime field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetEbsOptimized

SetEbsOptimized sets the EbsOptimized field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetIamInstanceProfile

SetIamInstanceProfile sets the IamInstanceProfile field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetImageId

SetImageId sets the ImageId field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetInstanceMonitoring

SetInstanceMonitoring sets the InstanceMonitoring field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetInstanceType

SetInstanceType sets the InstanceType field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetKernelId

SetKernelId sets the KernelId field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetKeyName

SetKeyName sets the KeyName field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetLaunchConfigurationName

SetLaunchConfigurationName sets the LaunchConfigurationName field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetMetadataOptions added in v1.42.9

SetMetadataOptions sets the MetadataOptions field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetPlacementTenancy

SetPlacementTenancy sets the PlacementTenancy field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetRamdiskId

SetRamdiskId sets the RamdiskId field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetSecurityGroups

SetSecurityGroups sets the SecurityGroups field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetSpotPrice

SetSpotPrice sets the SpotPrice field's value.

func (*AwsAutoScalingLaunchConfigurationDetails) SetUserData

SetUserData sets the UserData field's value.

func (AwsAutoScalingLaunchConfigurationDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails

type AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails struct {

	// If set to true, then instances in the group launch with detailed monitoring.
	//
	// If set to false, then instances in the group launch with basic monitoring.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Information about the type of monitoring for instances in the group.

func (AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails) SetEnabled

SetEnabled sets the Enabled field's value.

func (AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsAutoScalingLaunchConfigurationMetadataOptions added in v1.42.9

type AwsAutoScalingLaunchConfigurationMetadataOptions struct {

	// Enables or disables the HTTP metadata endpoint on your instances. By default,
	// the metadata endpoint is enabled.
	HttpEndpoint *string `type:"string"`

	// The HTTP PUT response hop limit for instance metadata requests. The larger
	// the number, the further instance metadata requests can travel.
	HttpPutResponseHopLimit *int64 `type:"integer"`

	// Indicates whether token usage is required or optional for metadata requests.
	// By default, token usage is optional.
	HttpTokens *string `type:"string"`
	// contains filtered or unexported fields
}

The metadata options for the instances.

func (AwsAutoScalingLaunchConfigurationMetadataOptions) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsAutoScalingLaunchConfigurationMetadataOptions) SetHttpEndpoint added in v1.42.9

SetHttpEndpoint sets the HttpEndpoint field's value.

func (*AwsAutoScalingLaunchConfigurationMetadataOptions) SetHttpPutResponseHopLimit added in v1.42.9

SetHttpPutResponseHopLimit sets the HttpPutResponseHopLimit field's value.

func (*AwsAutoScalingLaunchConfigurationMetadataOptions) SetHttpTokens added in v1.42.9

SetHttpTokens sets the HttpTokens field's value.

func (AwsAutoScalingLaunchConfigurationMetadataOptions) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsBackupBackupPlanAdvancedBackupSettingsDetails added in v1.42.9

type AwsBackupBackupPlanAdvancedBackupSettingsDetails struct {

	// Specifies the backup option for a selected resource. This option is only
	// available for Windows Volume Shadow Copy Service (VSS) backup jobs. Valid
	// values are as follows:
	//
	//    * Set to WindowsVSS: enabled to enable the WindowsVSS backup option and
	//    create a Windows VSS backup.
	//
	//    * Set to WindowsVSS: disabled to create a regular backup. The WindowsVSS
	//    option is not enabled by default.
	BackupOptions map[string]*string `type:"map"`

	// The name of a resource type. The only supported resource type is Amazon EC2
	// instances with Windows VSS.
	//
	// The only valid value is EC2.
	ResourceType *string `type:"string"`
	// contains filtered or unexported fields
}

Provides a list of backup options for each resource type.

func (AwsBackupBackupPlanAdvancedBackupSettingsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsBackupBackupPlanAdvancedBackupSettingsDetails) SetBackupOptions added in v1.42.9

SetBackupOptions sets the BackupOptions field's value.

func (*AwsBackupBackupPlanAdvancedBackupSettingsDetails) SetResourceType added in v1.42.9

SetResourceType sets the ResourceType field's value.

func (AwsBackupBackupPlanAdvancedBackupSettingsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsBackupBackupPlanBackupPlanDetails added in v1.42.9

type AwsBackupBackupPlanBackupPlanDetails struct {

	// A list of backup options for each resource type.
	AdvancedBackupSettings []*AwsBackupBackupPlanAdvancedBackupSettingsDetails `type:"list"`

	// The display name of a backup plan.
	BackupPlanName *string `type:"string"`

	// An array of BackupRule objects, each of which specifies a scheduled task
	// that is used to back up a selection of resources.
	BackupPlanRule []*AwsBackupBackupPlanRuleDetails `type:"list"`
	// contains filtered or unexported fields
}

Provides details about an Backup backup plan and an array of BackupRule objects, each of which specifies a backup rule.

func (AwsBackupBackupPlanBackupPlanDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsBackupBackupPlanBackupPlanDetails) SetAdvancedBackupSettings added in v1.42.9

SetAdvancedBackupSettings sets the AdvancedBackupSettings field's value.

func (*AwsBackupBackupPlanBackupPlanDetails) SetBackupPlanName added in v1.42.9

SetBackupPlanName sets the BackupPlanName field's value.

func (*AwsBackupBackupPlanBackupPlanDetails) SetBackupPlanRule added in v1.42.9

SetBackupPlanRule sets the BackupPlanRule field's value.

func (AwsBackupBackupPlanBackupPlanDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsBackupBackupPlanDetails added in v1.42.9

type AwsBackupBackupPlanDetails struct {

	// Uniquely identifies the backup plan to be associated with the selection of
	// resources.
	BackupPlan *AwsBackupBackupPlanBackupPlanDetails `type:"structure"`

	// An Amazon Resource Name (ARN) that uniquely identifies the backup plan.
	BackupPlanArn *string `type:"string"`

	// A unique ID for the backup plan.
	BackupPlanId *string `type:"string"`

	// Unique, randomly generated, Unicode, UTF-8 encoded strings. Version IDs cannot
	// be edited.
	VersionId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about an Backup backup plan and an array of BackupRule objects, each of which specifies a backup rule.

func (AwsBackupBackupPlanDetails) GoString added in v1.42.9

func (s AwsBackupBackupPlanDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsBackupBackupPlanDetails) SetBackupPlan added in v1.42.9

SetBackupPlan sets the BackupPlan field's value.

func (*AwsBackupBackupPlanDetails) SetBackupPlanArn added in v1.42.9

SetBackupPlanArn sets the BackupPlanArn field's value.

func (*AwsBackupBackupPlanDetails) SetBackupPlanId added in v1.42.9

SetBackupPlanId sets the BackupPlanId field's value.

func (*AwsBackupBackupPlanDetails) SetVersionId added in v1.42.9

SetVersionId sets the VersionId field's value.

func (AwsBackupBackupPlanDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsBackupBackupPlanLifecycleDetails added in v1.42.9

type AwsBackupBackupPlanLifecycleDetails struct {

	// Specifies the number of days after creation that a recovery point is deleted.
	// Must be greater than 90 days plus MoveToColdStorageAfterDays.
	DeleteAfterDays *int64 `type:"long"`

	// Specifies the number of days after creation that a recovery point is moved
	// to cold storage.
	MoveToColdStorageAfterDays *int64 `type:"long"`
	// contains filtered or unexported fields
}

Provides lifecycle details for the backup plan. A lifecycle defines when a backup is transitioned to cold storage and when it expires.

func (AwsBackupBackupPlanLifecycleDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsBackupBackupPlanLifecycleDetails) SetDeleteAfterDays added in v1.42.9

SetDeleteAfterDays sets the DeleteAfterDays field's value.

func (*AwsBackupBackupPlanLifecycleDetails) SetMoveToColdStorageAfterDays added in v1.42.9

SetMoveToColdStorageAfterDays sets the MoveToColdStorageAfterDays field's value.

func (AwsBackupBackupPlanLifecycleDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsBackupBackupPlanRuleCopyActionsDetails added in v1.42.9

type AwsBackupBackupPlanRuleCopyActionsDetails struct {

	// An Amazon Resource Name (ARN) that uniquely identifies the destination backup
	// vault for the copied backup.
	DestinationBackupVaultArn *string `type:"string"`

	// Defines when a protected resource is transitioned to cold storage and when
	// it expires. Backup transitions and expires backups automatically according
	// to the lifecycle that you define. If you do not specify a lifecycle, Backup
	// applies the lifecycle policy of the source backup to the destination backup.
	//
	// Backups transitioned to cold storage must be stored in cold storage for a
	// minimum of 90 days.
	Lifecycle *AwsBackupBackupPlanLifecycleDetails `type:"structure"`
	// contains filtered or unexported fields
}

An array of CopyAction objects, each of which contains details of the copy operation.

func (AwsBackupBackupPlanRuleCopyActionsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsBackupBackupPlanRuleCopyActionsDetails) SetDestinationBackupVaultArn added in v1.42.9

SetDestinationBackupVaultArn sets the DestinationBackupVaultArn field's value.

func (*AwsBackupBackupPlanRuleCopyActionsDetails) SetLifecycle added in v1.42.9

SetLifecycle sets the Lifecycle field's value.

func (AwsBackupBackupPlanRuleCopyActionsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsBackupBackupPlanRuleDetails added in v1.42.9

type AwsBackupBackupPlanRuleDetails struct {

	// A value in minutes after a backup job is successfully started before it must
	// be completed, or it is canceled by Backup.
	CompletionWindowMinutes *int64 `type:"long"`

	// An array of CopyAction objects, each of which contains details of the copy
	// operation.
	CopyActions []*AwsBackupBackupPlanRuleCopyActionsDetails `type:"list"`

	// Specifies whether Backup creates continuous backups capable of point-in-time
	// restore (PITR).
	EnableContinuousBackup *bool `type:"boolean"`

	// Defines when a protected resource is transitioned to cold storage and when
	// it expires. Backup transitions and expires backups automatically according
	// to the lifecycle that you define. If you do not specify a lifecycle, Backup
	// applies the lifecycle policy of the source backup to the destination backup.
	//
	// Backups transitioned to cold storage must be stored in cold storage for a
	// minimum of 90 days.
	Lifecycle *AwsBackupBackupPlanLifecycleDetails `type:"structure"`

	// Uniquely identifies a rule that is used to schedule the backup of a selection
	// of resources.
	RuleId *string `type:"string"`

	// A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.'
	// characters.
	RuleName *string `type:"string"`

	// A cron expression in UTC specifying when Backup initiates a backup job.
	ScheduleExpression *string `type:"string"`

	// A value in minutes after a backup is scheduled before a job will be canceled
	// if it doesn't start successfully.
	StartWindowMinutes *int64 `type:"long"`

	// The name of a logical container where backups are stored. Backup vaults are
	// identified by names that are unique to the Amazon Web Services account used
	// to create them and the Amazon Web Services Region where they are created.
	// They consist of letters, numbers, and hyphens.
	TargetBackupVault *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about an array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

func (AwsBackupBackupPlanRuleDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsBackupBackupPlanRuleDetails) SetCompletionWindowMinutes added in v1.42.9

func (s *AwsBackupBackupPlanRuleDetails) SetCompletionWindowMinutes(v int64) *AwsBackupBackupPlanRuleDetails

SetCompletionWindowMinutes sets the CompletionWindowMinutes field's value.

func (*AwsBackupBackupPlanRuleDetails) SetCopyActions added in v1.42.9

SetCopyActions sets the CopyActions field's value.

func (*AwsBackupBackupPlanRuleDetails) SetEnableContinuousBackup added in v1.42.9

func (s *AwsBackupBackupPlanRuleDetails) SetEnableContinuousBackup(v bool) *AwsBackupBackupPlanRuleDetails

SetEnableContinuousBackup sets the EnableContinuousBackup field's value.

func (*AwsBackupBackupPlanRuleDetails) SetLifecycle added in v1.42.9

SetLifecycle sets the Lifecycle field's value.

func (*AwsBackupBackupPlanRuleDetails) SetRuleId added in v1.42.9

SetRuleId sets the RuleId field's value.

func (*AwsBackupBackupPlanRuleDetails) SetRuleName added in v1.42.9

SetRuleName sets the RuleName field's value.

func (*AwsBackupBackupPlanRuleDetails) SetScheduleExpression added in v1.42.9

SetScheduleExpression sets the ScheduleExpression field's value.

func (*AwsBackupBackupPlanRuleDetails) SetStartWindowMinutes added in v1.42.9

SetStartWindowMinutes sets the StartWindowMinutes field's value.

func (*AwsBackupBackupPlanRuleDetails) SetTargetBackupVault added in v1.42.9

SetTargetBackupVault sets the TargetBackupVault field's value.

func (AwsBackupBackupPlanRuleDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsBackupBackupVaultDetails added in v1.42.9

type AwsBackupBackupVaultDetails struct {

	// A resource-based policy that is used to manage access permissions on the
	// target backup vault.
	AccessPolicy *string `type:"string"`

	// An Amazon Resource Name (ARN) that uniquely identifies a backup vault.
	BackupVaultArn *string `type:"string"`

	// The name of a logical container where backups are stored. Backup vaults are
	// identified by names that are unique to the Amazon Web Services account used
	// to create them and the Amazon Web Services Region where they are created.
	// They consist of lowercase letters, numbers, and hyphens.
	BackupVaultName *string `type:"string"`

	// The unique ARN associated with the server-side encryption key. You can specify
	// a key to encrypt your backups from services that support full Backup management.
	// If you do not specify a key, Backup creates an KMS key for you by default.
	EncryptionKeyArn *string `type:"string"`

	// The Amazon SNS event notifications for the specified backup vault.
	Notifications *AwsBackupBackupVaultNotificationsDetails `type:"structure"`
	// contains filtered or unexported fields
}

Provides details about an Backup backup vault. In Backup, a backup vault is a container that stores and organizes your backups.

func (AwsBackupBackupVaultDetails) GoString added in v1.42.9

func (s AwsBackupBackupVaultDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsBackupBackupVaultDetails) SetAccessPolicy added in v1.42.9

SetAccessPolicy sets the AccessPolicy field's value.

func (*AwsBackupBackupVaultDetails) SetBackupVaultArn added in v1.42.9

SetBackupVaultArn sets the BackupVaultArn field's value.

func (*AwsBackupBackupVaultDetails) SetBackupVaultName added in v1.42.9

SetBackupVaultName sets the BackupVaultName field's value.

func (*AwsBackupBackupVaultDetails) SetEncryptionKeyArn added in v1.42.9

SetEncryptionKeyArn sets the EncryptionKeyArn field's value.

func (*AwsBackupBackupVaultDetails) SetNotifications added in v1.42.9

SetNotifications sets the Notifications field's value.

func (AwsBackupBackupVaultDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsBackupBackupVaultNotificationsDetails added in v1.42.9

type AwsBackupBackupVaultNotificationsDetails struct {

	// An array of events that indicate the status of jobs to back up resources
	// to the backup vault. The following events are supported:
	//
	//    * BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED
	//
	//    * COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED
	//
	//    * RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED
	//
	//    * S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED
	BackupVaultEvents []*string `type:"list"`

	// The Amazon Resource Name (ARN) that uniquely identifies the Amazon SNS topic
	// for a backup vault's events.
	SnsTopicArn *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the Amazon SNS event notifications for the specified backup vault.

func (AwsBackupBackupVaultNotificationsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsBackupBackupVaultNotificationsDetails) SetBackupVaultEvents added in v1.42.9

SetBackupVaultEvents sets the BackupVaultEvents field's value.

func (*AwsBackupBackupVaultNotificationsDetails) SetSnsTopicArn added in v1.42.9

SetSnsTopicArn sets the SnsTopicArn field's value.

func (AwsBackupBackupVaultNotificationsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsBackupRecoveryPointCalculatedLifecycleDetails added in v1.42.9

type AwsBackupRecoveryPointCalculatedLifecycleDetails struct {

	// Specifies the number of days after creation that a recovery point is deleted.
	// Must be greater than 90 days plus MoveToColdStorageAfterDays.
	DeleteAt *string `type:"string"`

	// Specifies the number of days after creation that a recovery point is moved
	// to cold storage.
	MoveToColdStorageAt *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies how long in days before a recovery point transitions to cold storage or is deleted.

func (AwsBackupRecoveryPointCalculatedLifecycleDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsBackupRecoveryPointCalculatedLifecycleDetails) SetDeleteAt added in v1.42.9

SetDeleteAt sets the DeleteAt field's value.

func (*AwsBackupRecoveryPointCalculatedLifecycleDetails) SetMoveToColdStorageAt added in v1.42.9

SetMoveToColdStorageAt sets the MoveToColdStorageAt field's value.

func (AwsBackupRecoveryPointCalculatedLifecycleDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsBackupRecoveryPointCreatedByDetails added in v1.42.9

type AwsBackupRecoveryPointCreatedByDetails struct {

	// An Amazon Resource Name (ARN) that uniquely identifies a backup plan.
	BackupPlanArn *string `type:"string"`

	// Uniquely identifies a backup plan.
	BackupPlanId *string `type:"string"`

	// Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most
	// 1,024 bytes long. Version IDs cannot be edited.
	BackupPlanVersion *string `type:"string"`

	// Uniquely identifies a rule used to schedule the backup of a selection of
	// resources.
	BackupRuleId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.

func (AwsBackupRecoveryPointCreatedByDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsBackupRecoveryPointCreatedByDetails) SetBackupPlanArn added in v1.42.9

SetBackupPlanArn sets the BackupPlanArn field's value.

func (*AwsBackupRecoveryPointCreatedByDetails) SetBackupPlanId added in v1.42.9

SetBackupPlanId sets the BackupPlanId field's value.

func (*AwsBackupRecoveryPointCreatedByDetails) SetBackupPlanVersion added in v1.42.9

SetBackupPlanVersion sets the BackupPlanVersion field's value.

func (*AwsBackupRecoveryPointCreatedByDetails) SetBackupRuleId added in v1.42.9

SetBackupRuleId sets the BackupRuleId field's value.

func (AwsBackupRecoveryPointCreatedByDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsBackupRecoveryPointDetails added in v1.42.9

type AwsBackupRecoveryPointDetails struct {

	// The size, in bytes, of a backup.
	BackupSizeInBytes *int64 `type:"long"`

	// An Amazon Resource Name (ARN) that uniquely identifies a backup vault.
	BackupVaultArn *string `type:"string"`

	// The name of a logical container where backups are stored. Backup vaults are
	// identified by names that are unique to the Amazon Web Services account used
	// to create them and the Amazon Web Services Region where they are created.
	// They consist of lowercase letters, numbers, and hyphens.
	BackupVaultName *string `type:"string"`

	// A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt
	// timestamps.
	CalculatedLifecycle *AwsBackupRecoveryPointCalculatedLifecycleDetails `type:"structure"`

	// The date and time that a job to create a recovery point is completed, in
	// Unix format and UTC. The value of CompletionDate is accurate to milliseconds.
	// For example, the value 1516925490.087 represents Friday, January 26, 2018
	// 12:11:30.087 AM.
	CompletionDate *string `type:"string"`

	// Contains identifying information about the creation of a recovery point,
	// including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId
	// of the backup plan that is used to create it.
	CreatedBy *AwsBackupRecoveryPointCreatedByDetails `type:"structure"`

	// The date and time a recovery point is created, in Unix format and UTC. The
	// value of CreationDate is accurate to milliseconds. For example, the value
	// 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
	CreationDate *string `type:"string"`

	// The ARN for the server-side encryption key that is used to protect your backups.
	EncryptionKeyArn *string `type:"string"`

	// Specifies the IAM role ARN used to create the target recovery point
	IamRoleArn *string `type:"string"`

	// A Boolean value that is returned as TRUE if the specified recovery point
	// is encrypted, or FALSE if the recovery point is not encrypted.
	IsEncrypted *bool `type:"boolean"`

	// The date and time that a recovery point was last restored, in Unix format
	// and UTC. The value of LastRestoreTime is accurate to milliseconds. For example,
	// the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
	// AM.
	LastRestoreTime *string `type:"string"`

	// The lifecycle defines when a protected resource is transitioned to cold storage
	// and when it expires. Backup transitions and expires backups automatically
	// according to the lifecycle that you define
	Lifecycle *AwsBackupRecoveryPointLifecycleDetails `type:"structure"`

	// An ARN that uniquely identifies a recovery point.
	RecoveryPointArn *string `type:"string"`

	// An ARN that uniquely identifies a resource. The format of the ARN depends
	// on the resource type.
	ResourceArn *string `type:"string"`

	// The type of Amazon Web Services resource saved as a recovery point, such
	// as an Amazon EBS volume or an Amazon RDS database.
	ResourceType *string `type:"string"`

	// The ARN for the backup vault where the recovery point was originally copied
	// from. If the recovery point is restored to the same account, this value will
	// be null.
	SourceBackupVaultArn *string `type:"string"`

	// A status code specifying the state of the recovery point. Valid values are
	// as follows:
	//
	//    * COMPLETED
	//
	//    * DELETING
	//
	//    * EXPIRED
	//
	//    * PARTIAL
	Status *string `type:"string"`

	// A message explaining the reason of the recovery point deletion failure.
	StatusMessage *string `type:"string"`

	// Specifies the storage class of the recovery point. Valid values are as follows:
	//
	//    * COLD
	//
	//    * DELETED
	//
	//    * WARM
	StorageClass *string `type:"string"`
	// contains filtered or unexported fields
}

Contains detailed information about the recovery points stored in an Backup backup vault. A backup, or recovery point, represents the content of a resource at a specified time.

func (AwsBackupRecoveryPointDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsBackupRecoveryPointDetails) SetBackupSizeInBytes added in v1.42.9

SetBackupSizeInBytes sets the BackupSizeInBytes field's value.

func (*AwsBackupRecoveryPointDetails) SetBackupVaultArn added in v1.42.9

SetBackupVaultArn sets the BackupVaultArn field's value.

func (*AwsBackupRecoveryPointDetails) SetBackupVaultName added in v1.42.9

SetBackupVaultName sets the BackupVaultName field's value.

func (*AwsBackupRecoveryPointDetails) SetCalculatedLifecycle added in v1.42.9

SetCalculatedLifecycle sets the CalculatedLifecycle field's value.

func (*AwsBackupRecoveryPointDetails) SetCompletionDate added in v1.42.9

SetCompletionDate sets the CompletionDate field's value.

func (*AwsBackupRecoveryPointDetails) SetCreatedBy added in v1.42.9

SetCreatedBy sets the CreatedBy field's value.

func (*AwsBackupRecoveryPointDetails) SetCreationDate added in v1.42.9

SetCreationDate sets the CreationDate field's value.

func (*AwsBackupRecoveryPointDetails) SetEncryptionKeyArn added in v1.42.9

SetEncryptionKeyArn sets the EncryptionKeyArn field's value.

func (*AwsBackupRecoveryPointDetails) SetIamRoleArn added in v1.42.9

SetIamRoleArn sets the IamRoleArn field's value.

func (*AwsBackupRecoveryPointDetails) SetIsEncrypted added in v1.42.9

SetIsEncrypted sets the IsEncrypted field's value.

func (*AwsBackupRecoveryPointDetails) SetLastRestoreTime added in v1.42.9

SetLastRestoreTime sets the LastRestoreTime field's value.

func (*AwsBackupRecoveryPointDetails) SetLifecycle added in v1.42.9

SetLifecycle sets the Lifecycle field's value.

func (*AwsBackupRecoveryPointDetails) SetRecoveryPointArn added in v1.42.9

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (*AwsBackupRecoveryPointDetails) SetResourceArn added in v1.42.9

SetResourceArn sets the ResourceArn field's value.

func (*AwsBackupRecoveryPointDetails) SetResourceType added in v1.42.9

SetResourceType sets the ResourceType field's value.

func (*AwsBackupRecoveryPointDetails) SetSourceBackupVaultArn added in v1.42.9

SetSourceBackupVaultArn sets the SourceBackupVaultArn field's value.

func (*AwsBackupRecoveryPointDetails) SetStatus added in v1.42.9

SetStatus sets the Status field's value.

func (*AwsBackupRecoveryPointDetails) SetStatusMessage added in v1.42.9

SetStatusMessage sets the StatusMessage field's value.

func (*AwsBackupRecoveryPointDetails) SetStorageClass added in v1.42.9

SetStorageClass sets the StorageClass field's value.

func (AwsBackupRecoveryPointDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsBackupRecoveryPointLifecycleDetails added in v1.42.9

type AwsBackupRecoveryPointLifecycleDetails struct {

	// Specifies the number of days after creation that a recovery point is deleted.
	// Must be greater than 90 days plus MoveToColdStorageAfterDays.
	DeleteAfterDays *int64 `type:"long"`

	// Specifies the number of days after creation that a recovery point is moved
	// to cold storage.
	MoveToColdStorageAfterDays *int64 `type:"long"`
	// contains filtered or unexported fields
}

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

func (AwsBackupRecoveryPointLifecycleDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsBackupRecoveryPointLifecycleDetails) SetDeleteAfterDays added in v1.42.9

SetDeleteAfterDays sets the DeleteAfterDays field's value.

func (*AwsBackupRecoveryPointLifecycleDetails) SetMoveToColdStorageAfterDays added in v1.42.9

SetMoveToColdStorageAfterDays sets the MoveToColdStorageAfterDays field's value.

func (AwsBackupRecoveryPointLifecycleDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCertificateManagerCertificateDetails

type AwsCertificateManagerCertificateDetails struct {

	// The ARN of the private certificate authority (CA) that will be used to issue
	// the certificate.
	CertificateAuthorityArn *string `type:"string"`

	// Indicates when the certificate was requested.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreatedAt *string `type:"string"`

	// The fully qualified domain name (FQDN), such as www.example.com, that is
	// secured by the certificate.
	DomainName *string `type:"string"`

	// Contains information about the initial validation of each domain name that
	// occurs as a result of the RequestCertificate request.
	//
	// Only provided if the certificate type is AMAZON_ISSUED.
	DomainValidationOptions []*AwsCertificateManagerCertificateDomainValidationOption `type:"list"`

	// Contains a list of Extended Key Usage X.509 v3 extension objects. Each object
	// specifies a purpose for which the certificate public key can be used and
	// consists of a name and an object identifier (OID).
	ExtendedKeyUsages []*AwsCertificateManagerCertificateExtendedKeyUsage `type:"list"`

	// For a failed certificate request, the reason for the failure.
	//
	// Valid values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED |
	// DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED | CAA_ERROR
	// | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN | PCA_INVALID_STATE | PCA_REQUEST_FAILED
	// | PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS
	// | PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER
	FailureReason *string `type:"string"`

	// Indicates when the certificate was imported. Provided if the certificate
	// type is IMPORTED.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	ImportedAt *string `type:"string"`

	// The list of ARNs for the Amazon Web Services resources that use the certificate.
	InUseBy []*string `type:"list"`

	// Indicates when the certificate was issued. Provided if the certificate type
	// is AMAZON_ISSUED.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	IssuedAt *string `type:"string"`

	// The name of the certificate authority that issued and signed the certificate.
	Issuer *string `type:"string"`

	// The algorithm that was used to generate the public-private key pair.
	//
	// Valid values: RSA_2048 | RSA_1024 |RSA_4096 | EC_prime256v1 | EC_secp384r1
	// | EC_secp521r1
	KeyAlgorithm *string `type:"string"`

	// A list of key usage X.509 v3 extension objects.
	KeyUsages []*AwsCertificateManagerCertificateKeyUsage `type:"list"`

	// The time after which the certificate becomes invalid.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	NotAfter *string `type:"string"`

	// The time before which the certificate is not valid.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	NotBefore *string `type:"string"`

	// Provides a value that specifies whether to add the certificate to a transparency
	// log.
	Options *AwsCertificateManagerCertificateOptions `type:"structure"`

	// Whether the certificate is eligible for renewal.
	//
	// Valid values: ELIGIBLE | INELIGIBLE
	RenewalEligibility *string `type:"string"`

	// Information about the status of the Certificate Manager managed renewal for
	// the certificate. Provided only when the certificate type is AMAZON_ISSUED.
	RenewalSummary *AwsCertificateManagerCertificateRenewalSummary `type:"structure"`

	// The serial number of the certificate.
	Serial *string `type:"string"`

	// The algorithm that was used to sign the certificate.
	SignatureAlgorithm *string `type:"string"`

	// The status of the certificate.
	//
	// Valid values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT
	// | REVOKED | FAILED
	Status *string `type:"string"`

	// The name of the entity that is associated with the public key contained in
	// the certificate.
	Subject *string `type:"string"`

	// One or more domain names (subject alternative names) included in the certificate.
	// This list contains the domain names that are bound to the public key that
	// is contained in the certificate.
	//
	// The subject alternative names include the canonical domain name (CN) of the
	// certificate and additional domain names that can be used to connect to the
	// website.
	SubjectAlternativeNames []*string `type:"list"`

	// The source of the certificate. For certificates that Certificate Manager
	// provides, Type is AMAZON_ISSUED. For certificates that are imported with
	// ImportCertificate, Type is IMPORTED.
	//
	// Valid values: IMPORTED | AMAZON_ISSUED | PRIVATE
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about an Certificate Manager certificate.

func (AwsCertificateManagerCertificateDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCertificateManagerCertificateDetails) SetCertificateAuthorityArn

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (*AwsCertificateManagerCertificateDetails) SetCreatedAt

SetCreatedAt sets the CreatedAt field's value.

func (*AwsCertificateManagerCertificateDetails) SetDomainName

SetDomainName sets the DomainName field's value.

func (*AwsCertificateManagerCertificateDetails) SetDomainValidationOptions

SetDomainValidationOptions sets the DomainValidationOptions field's value.

func (*AwsCertificateManagerCertificateDetails) SetExtendedKeyUsages

SetExtendedKeyUsages sets the ExtendedKeyUsages field's value.

func (*AwsCertificateManagerCertificateDetails) SetFailureReason

SetFailureReason sets the FailureReason field's value.

func (*AwsCertificateManagerCertificateDetails) SetImportedAt

SetImportedAt sets the ImportedAt field's value.

func (*AwsCertificateManagerCertificateDetails) SetInUseBy

SetInUseBy sets the InUseBy field's value.

func (*AwsCertificateManagerCertificateDetails) SetIssuedAt

SetIssuedAt sets the IssuedAt field's value.

func (*AwsCertificateManagerCertificateDetails) SetIssuer

SetIssuer sets the Issuer field's value.

func (*AwsCertificateManagerCertificateDetails) SetKeyAlgorithm

SetKeyAlgorithm sets the KeyAlgorithm field's value.

func (*AwsCertificateManagerCertificateDetails) SetKeyUsages

SetKeyUsages sets the KeyUsages field's value.

func (*AwsCertificateManagerCertificateDetails) SetNotAfter

SetNotAfter sets the NotAfter field's value.

func (*AwsCertificateManagerCertificateDetails) SetNotBefore

SetNotBefore sets the NotBefore field's value.

func (*AwsCertificateManagerCertificateDetails) SetOptions

SetOptions sets the Options field's value.

func (*AwsCertificateManagerCertificateDetails) SetRenewalEligibility

SetRenewalEligibility sets the RenewalEligibility field's value.

func (*AwsCertificateManagerCertificateDetails) SetRenewalSummary

SetRenewalSummary sets the RenewalSummary field's value.

func (*AwsCertificateManagerCertificateDetails) SetSerial

SetSerial sets the Serial field's value.

func (*AwsCertificateManagerCertificateDetails) SetSignatureAlgorithm

SetSignatureAlgorithm sets the SignatureAlgorithm field's value.

func (*AwsCertificateManagerCertificateDetails) SetStatus

SetStatus sets the Status field's value.

func (*AwsCertificateManagerCertificateDetails) SetSubject

SetSubject sets the Subject field's value.

func (*AwsCertificateManagerCertificateDetails) SetSubjectAlternativeNames

SetSubjectAlternativeNames sets the SubjectAlternativeNames field's value.

func (*AwsCertificateManagerCertificateDetails) SetType

SetType sets the Type field's value.

func (AwsCertificateManagerCertificateDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCertificateManagerCertificateDomainValidationOption

type AwsCertificateManagerCertificateDomainValidationOption struct {

	// A fully qualified domain name (FQDN) in the certificate.
	DomainName *string `type:"string"`

	// The CNAME record that is added to the DNS database for domain validation.
	ResourceRecord *AwsCertificateManagerCertificateResourceRecord `type:"structure"`

	// The domain name that Certificate Manager uses to send domain validation emails.
	ValidationDomain *string `type:"string"`

	// A list of email addresses that Certificate Manager uses to send domain validation
	// emails.
	ValidationEmails []*string `type:"list"`

	// The method used to validate the domain name.
	ValidationMethod *string `type:"string"`

	// The validation status of the domain name.
	ValidationStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about one of the following:

  • The initial validation of each domain name that occurs as a result of the RequestCertificate request

  • The validation of each domain name in the certificate, as it pertains to Certificate Manager managed renewal

func (AwsCertificateManagerCertificateDomainValidationOption) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCertificateManagerCertificateDomainValidationOption) SetDomainName

SetDomainName sets the DomainName field's value.

func (*AwsCertificateManagerCertificateDomainValidationOption) SetResourceRecord

SetResourceRecord sets the ResourceRecord field's value.

func (*AwsCertificateManagerCertificateDomainValidationOption) SetValidationDomain

SetValidationDomain sets the ValidationDomain field's value.

func (*AwsCertificateManagerCertificateDomainValidationOption) SetValidationEmails

SetValidationEmails sets the ValidationEmails field's value.

func (*AwsCertificateManagerCertificateDomainValidationOption) SetValidationMethod

SetValidationMethod sets the ValidationMethod field's value.

func (*AwsCertificateManagerCertificateDomainValidationOption) SetValidationStatus

SetValidationStatus sets the ValidationStatus field's value.

func (AwsCertificateManagerCertificateDomainValidationOption) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCertificateManagerCertificateExtendedKeyUsage

type AwsCertificateManagerCertificateExtendedKeyUsage struct {

	// The name of an extension value. Indicates the purpose for which the certificate
	// public key can be used.
	Name *string `type:"string"`

	// An object identifier (OID) for the extension value.
	//
	// The format is numbers separated by periods.
	OId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about an extended key usage X.509 v3 extension object.

func (AwsCertificateManagerCertificateExtendedKeyUsage) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCertificateManagerCertificateExtendedKeyUsage) SetName

SetName sets the Name field's value.

func (*AwsCertificateManagerCertificateExtendedKeyUsage) SetOId

SetOId sets the OId field's value.

func (AwsCertificateManagerCertificateExtendedKeyUsage) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCertificateManagerCertificateKeyUsage

type AwsCertificateManagerCertificateKeyUsage struct {

	// The key usage extension name.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about a key usage X.509 v3 extension object.

func (AwsCertificateManagerCertificateKeyUsage) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCertificateManagerCertificateKeyUsage) SetName

SetName sets the Name field's value.

func (AwsCertificateManagerCertificateKeyUsage) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCertificateManagerCertificateOptions

type AwsCertificateManagerCertificateOptions struct {

	// Whether to add the certificate to a transparency log.
	//
	// Valid values: DISABLED | ENABLED
	CertificateTransparencyLoggingPreference *string `type:"string"`
	// contains filtered or unexported fields
}

Contains other options for the certificate.

func (AwsCertificateManagerCertificateOptions) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCertificateManagerCertificateOptions) SetCertificateTransparencyLoggingPreference

func (s *AwsCertificateManagerCertificateOptions) SetCertificateTransparencyLoggingPreference(v string) *AwsCertificateManagerCertificateOptions

SetCertificateTransparencyLoggingPreference sets the CertificateTransparencyLoggingPreference field's value.

func (AwsCertificateManagerCertificateOptions) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCertificateManagerCertificateRenewalSummary

type AwsCertificateManagerCertificateRenewalSummary struct {

	// Information about the validation of each domain name in the certificate,
	// as it pertains to Certificate Manager managed renewal. Provided only when
	// the certificate type is AMAZON_ISSUED.
	DomainValidationOptions []*AwsCertificateManagerCertificateDomainValidationOption `type:"list"`

	// The status of the Certificate Manager managed renewal of the certificate.
	//
	// Valid values: PENDING_AUTO_RENEWAL | PENDING_VALIDATION | SUCCESS | FAILED
	RenewalStatus *string `type:"string"`

	// The reason that a renewal request was unsuccessful. This attribute is used
	// only when RenewalStatus is FAILED.
	//
	// Valid values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED |
	// DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED | CAA_ERROR
	// | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN | PCA_INVALID_STATE | PCA_REQUEST_FAILED
	// | PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS
	// | PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER
	RenewalStatusReason *string `type:"string"`

	// Indicates when the renewal summary was last updated.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	UpdatedAt *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about the Certificate Manager managed renewal for an AMAZON_ISSUED certificate.

func (AwsCertificateManagerCertificateRenewalSummary) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCertificateManagerCertificateRenewalSummary) SetDomainValidationOptions

SetDomainValidationOptions sets the DomainValidationOptions field's value.

func (*AwsCertificateManagerCertificateRenewalSummary) SetRenewalStatus

SetRenewalStatus sets the RenewalStatus field's value.

func (*AwsCertificateManagerCertificateRenewalSummary) SetRenewalStatusReason

SetRenewalStatusReason sets the RenewalStatusReason field's value.

func (*AwsCertificateManagerCertificateRenewalSummary) SetUpdatedAt

SetUpdatedAt sets the UpdatedAt field's value.

func (AwsCertificateManagerCertificateRenewalSummary) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCertificateManagerCertificateResourceRecord

type AwsCertificateManagerCertificateResourceRecord struct {

	// The name of the resource.
	Name *string `type:"string"`

	// The type of resource.
	Type *string `type:"string"`

	// The value of the resource.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the CNAME record that is added to the DNS database for domain validation.

func (AwsCertificateManagerCertificateResourceRecord) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCertificateManagerCertificateResourceRecord) SetName

SetName sets the Name field's value.

func (*AwsCertificateManagerCertificateResourceRecord) SetType

SetType sets the Type field's value.

func (*AwsCertificateManagerCertificateResourceRecord) SetValue

SetValue sets the Value field's value.

func (AwsCertificateManagerCertificateResourceRecord) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudFormationStackDetails added in v1.42.9

type AwsCloudFormationStackDetails struct {

	// The capabilities allowed in the stack.
	Capabilities []*string `type:"list"`

	// The time at which the stack was created.
	CreationTime *string `type:"string"`

	// A user-defined description associated with the stack.
	Description *string `type:"string"`

	// Boolean to enable or disable rollback on stack creation failures.
	DisableRollback *bool `type:"boolean"`

	// Information about whether a stack's actual configuration differs, or has
	// drifted, from its expected configuration, as defined in the stack template
	// and any values specified as template parameters.
	DriftInformation *AwsCloudFormationStackDriftInformationDetails `type:"structure"`

	// Whether termination protection is enabled for the stack.
	EnableTerminationProtection *bool `type:"boolean"`

	// The time the nested stack was last updated. This field will only be returned
	// if the stack has been updated at least once.
	LastUpdatedTime *string `type:"string"`

	// The Amazon Resource Names (ARNs) of the Amazon SNS topic to which stack-related
	// events are published.
	NotificationArns []*string `type:"list"`

	// A list of output structures.
	Outputs []*AwsCloudFormationStackOutputsDetails `type:"list"`

	// The ARN of an IAM role that's associated with the stack.
	RoleArn *string `type:"string"`

	// Unique identifier of the stack.
	StackId *string `type:"string"`

	// The name associated with the stack.
	StackName *string `type:"string"`

	// Current status of the stack.
	StackStatus *string `type:"string"`

	// Success or failure message associated with the stack status.
	StackStatusReason *string `type:"string"`

	// The length of time, in minutes, that CloudFormation waits for the nested
	// stack to reach the CREATE_COMPLETE state.
	TimeoutInMinutes *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Nests a stack as a resource in a top-level template. Nested stacks are stacks created as resources for another stack.

func (AwsCloudFormationStackDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudFormationStackDetails) SetCapabilities added in v1.42.9

SetCapabilities sets the Capabilities field's value.

func (*AwsCloudFormationStackDetails) SetCreationTime added in v1.42.9

SetCreationTime sets the CreationTime field's value.

func (*AwsCloudFormationStackDetails) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*AwsCloudFormationStackDetails) SetDisableRollback added in v1.42.9

SetDisableRollback sets the DisableRollback field's value.

func (*AwsCloudFormationStackDetails) SetDriftInformation added in v1.42.9

SetDriftInformation sets the DriftInformation field's value.

func (*AwsCloudFormationStackDetails) SetEnableTerminationProtection added in v1.42.9

func (s *AwsCloudFormationStackDetails) SetEnableTerminationProtection(v bool) *AwsCloudFormationStackDetails

SetEnableTerminationProtection sets the EnableTerminationProtection field's value.

func (*AwsCloudFormationStackDetails) SetLastUpdatedTime added in v1.42.9

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*AwsCloudFormationStackDetails) SetNotificationArns added in v1.42.9

SetNotificationArns sets the NotificationArns field's value.

func (*AwsCloudFormationStackDetails) SetOutputs added in v1.42.9

SetOutputs sets the Outputs field's value.

func (*AwsCloudFormationStackDetails) SetRoleArn added in v1.42.9

SetRoleArn sets the RoleArn field's value.

func (*AwsCloudFormationStackDetails) SetStackId added in v1.42.9

SetStackId sets the StackId field's value.

func (*AwsCloudFormationStackDetails) SetStackName added in v1.42.9

SetStackName sets the StackName field's value.

func (*AwsCloudFormationStackDetails) SetStackStatus added in v1.42.9

SetStackStatus sets the StackStatus field's value.

func (*AwsCloudFormationStackDetails) SetStackStatusReason added in v1.42.9

SetStackStatusReason sets the StackStatusReason field's value.

func (*AwsCloudFormationStackDetails) SetTimeoutInMinutes added in v1.42.9

SetTimeoutInMinutes sets the TimeoutInMinutes field's value.

func (AwsCloudFormationStackDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudFormationStackDriftInformationDetails added in v1.42.9

type AwsCloudFormationStackDriftInformationDetails struct {

	// Status of the stack's actual configuration compared to its expected template
	// configuration.
	StackDriftStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the stack's conformity to its expected template configuration.

func (AwsCloudFormationStackDriftInformationDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudFormationStackDriftInformationDetails) SetStackDriftStatus added in v1.42.9

SetStackDriftStatus sets the StackDriftStatus field's value.

func (AwsCloudFormationStackDriftInformationDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudFormationStackOutputsDetails added in v1.42.9

type AwsCloudFormationStackOutputsDetails struct {

	// A user-defined description associated with the output.
	Description *string `type:"string"`

	// The key associated with the output.
	OutputKey *string `type:"string"`

	// The value associated with the output.
	OutputValue *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the CloudFormation stack output.

func (AwsCloudFormationStackOutputsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudFormationStackOutputsDetails) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*AwsCloudFormationStackOutputsDetails) SetOutputKey added in v1.42.9

SetOutputKey sets the OutputKey field's value.

func (*AwsCloudFormationStackOutputsDetails) SetOutputValue added in v1.42.9

SetOutputValue sets the OutputValue field's value.

func (AwsCloudFormationStackOutputsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudFrontDistributionCacheBehavior

type AwsCloudFrontDistributionCacheBehavior struct {

	// The protocol that viewers can use to access the files in an origin. You can
	// specify the following options:
	//
	//    * allow-all - Viewers can use HTTP or HTTPS.
	//
	//    * redirect-to-https - CloudFront responds to HTTP requests with an HTTP
	//    status code of 301 (Moved Permanently) and the HTTPS URL. The viewer then
	//    uses the new URL to resubmit.
	//
	//    * https-only - CloudFront responds to HTTP request with an HTTP status
	//    code of 403 (Forbidden).
	ViewerProtocolPolicy *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a cache behavior for the distribution.

func (AwsCloudFrontDistributionCacheBehavior) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudFrontDistributionCacheBehavior) SetViewerProtocolPolicy

SetViewerProtocolPolicy sets the ViewerProtocolPolicy field's value.

func (AwsCloudFrontDistributionCacheBehavior) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudFrontDistributionCacheBehaviors

type AwsCloudFrontDistributionCacheBehaviors struct {

	// The cache behaviors for the distribution.
	Items []*AwsCloudFrontDistributionCacheBehavior `type:"list"`
	// contains filtered or unexported fields
}

Provides information about caching for the CloudFront distribution.

func (AwsCloudFrontDistributionCacheBehaviors) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudFrontDistributionCacheBehaviors) SetItems

SetItems sets the Items field's value.

func (AwsCloudFrontDistributionCacheBehaviors) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudFrontDistributionDefaultCacheBehavior

type AwsCloudFrontDistributionDefaultCacheBehavior struct {

	// The protocol that viewers can use to access the files in an origin. You can
	// specify the following options:
	//
	//    * allow-all - Viewers can use HTTP or HTTPS.
	//
	//    * redirect-to-https - CloudFront responds to HTTP requests with an HTTP
	//    status code of 301 (Moved Permanently) and the HTTPS URL. The viewer then
	//    uses the new URL to resubmit.
	//
	//    * https-only - CloudFront responds to HTTP request with an HTTP status
	//    code of 403 (Forbidden).
	ViewerProtocolPolicy *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about the default cache configuration for the CloudFront distribution.

func (AwsCloudFrontDistributionDefaultCacheBehavior) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudFrontDistributionDefaultCacheBehavior) SetViewerProtocolPolicy

SetViewerProtocolPolicy sets the ViewerProtocolPolicy field's value.

func (AwsCloudFrontDistributionDefaultCacheBehavior) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudFrontDistributionDetails

type AwsCloudFrontDistributionDetails struct {

	// Provides information about the cache configuration for the distribution.
	CacheBehaviors *AwsCloudFrontDistributionCacheBehaviors `type:"structure"`

	// The default cache behavior for the configuration.
	DefaultCacheBehavior *AwsCloudFrontDistributionDefaultCacheBehavior `type:"structure"`

	// The object that CloudFront sends in response to requests from the origin
	// (for example, index.html) when a viewer requests the root URL for the distribution
	// (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html).
	DefaultRootObject *string `type:"string"`

	// The domain name corresponding to the distribution.
	DomainName *string `type:"string"`

	// The entity tag is a hash of the object.
	ETag *string `type:"string"`

	// Indicates when that the distribution was last modified.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	LastModifiedTime *string `type:"string"`

	// A complex type that controls whether access logs are written for the distribution.
	Logging *AwsCloudFrontDistributionLogging `type:"structure"`

	// Provides information about the origin groups in the distribution.
	OriginGroups *AwsCloudFrontDistributionOriginGroups `type:"structure"`

	// A complex type that contains information about origins for this distribution.
	Origins *AwsCloudFrontDistributionOrigins `type:"structure"`

	// Indicates the current status of the distribution.
	Status *string `type:"string"`

	// Provides information about the TLS/SSL configuration that the distribution
	// uses to communicate with viewers.
	ViewerCertificate *AwsCloudFrontDistributionViewerCertificate `type:"structure"`

	// A unique identifier that specifies the WAF web ACL, if any, to associate
	// with this distribution.
	WebAclId *string `type:"string"`
	// contains filtered or unexported fields
}

A CloudFront distribution configuration.

func (AwsCloudFrontDistributionDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudFrontDistributionDetails) SetCacheBehaviors

SetCacheBehaviors sets the CacheBehaviors field's value.

func (*AwsCloudFrontDistributionDetails) SetDefaultCacheBehavior

SetDefaultCacheBehavior sets the DefaultCacheBehavior field's value.

func (*AwsCloudFrontDistributionDetails) SetDefaultRootObject

SetDefaultRootObject sets the DefaultRootObject field's value.

func (*AwsCloudFrontDistributionDetails) SetDomainName

SetDomainName sets the DomainName field's value.

func (*AwsCloudFrontDistributionDetails) SetETag

SetETag sets the ETag field's value.

func (*AwsCloudFrontDistributionDetails) SetLastModifiedTime

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*AwsCloudFrontDistributionDetails) SetLogging

SetLogging sets the Logging field's value.

func (*AwsCloudFrontDistributionDetails) SetOriginGroups

SetOriginGroups sets the OriginGroups field's value.

func (*AwsCloudFrontDistributionDetails) SetOrigins

SetOrigins sets the Origins field's value.

func (*AwsCloudFrontDistributionDetails) SetStatus

SetStatus sets the Status field's value.

func (*AwsCloudFrontDistributionDetails) SetViewerCertificate

SetViewerCertificate sets the ViewerCertificate field's value.

func (*AwsCloudFrontDistributionDetails) SetWebAclId

SetWebAclId sets the WebAclId field's value.

func (AwsCloudFrontDistributionDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudFrontDistributionLogging

type AwsCloudFrontDistributionLogging struct {

	// The S3 bucket to store the access logs in.
	Bucket *string `type:"string"`

	// With this field, you can enable or disable the selected distribution.
	Enabled *bool `type:"boolean"`

	// Specifies whether you want CloudFront to include cookies in access logs.
	IncludeCookies *bool `type:"boolean"`

	// An optional string that you want CloudFront to use as a prefix to the access
	// log filenames for this distribution.
	Prefix *string `type:"string"`
	// contains filtered or unexported fields
}

A complex type that controls whether access logs are written for the CloudFront distribution.

func (AwsCloudFrontDistributionLogging) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudFrontDistributionLogging) SetBucket

SetBucket sets the Bucket field's value.

func (*AwsCloudFrontDistributionLogging) SetEnabled

SetEnabled sets the Enabled field's value.

func (*AwsCloudFrontDistributionLogging) SetIncludeCookies

SetIncludeCookies sets the IncludeCookies field's value.

func (*AwsCloudFrontDistributionLogging) SetPrefix

SetPrefix sets the Prefix field's value.

func (AwsCloudFrontDistributionLogging) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudFrontDistributionOriginCustomOriginConfig added in v1.42.9

type AwsCloudFrontDistributionOriginCustomOriginConfig struct {

	// The HTTP port that CloudFront uses to connect to the origin.
	HttpPort *int64 `type:"integer"`

	// The HTTPS port that CloudFront uses to connect to the origin.
	HttpsPort *int64 `type:"integer"`

	// Specifies how long, in seconds, CloudFront persists its connection to the
	// origin.
	OriginKeepaliveTimeout *int64 `type:"integer"`

	// Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to
	// the origin.
	OriginProtocolPolicy *string `type:"string"`

	// Specifies how long, in seconds, CloudFront waits for a response from the
	// origin.
	OriginReadTimeout *int64 `type:"integer"`

	// Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting
	// to your origin over HTTPS.
	OriginSslProtocols *AwsCloudFrontDistributionOriginSslProtocols `type:"structure"`
	// contains filtered or unexported fields
}

A custom origin. A custom origin is any origin that is not an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with static website hosting (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) is a custom origin.

func (AwsCloudFrontDistributionOriginCustomOriginConfig) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudFrontDistributionOriginCustomOriginConfig) SetHttpPort added in v1.42.9

SetHttpPort sets the HttpPort field's value.

func (*AwsCloudFrontDistributionOriginCustomOriginConfig) SetHttpsPort added in v1.42.9

SetHttpsPort sets the HttpsPort field's value.

func (*AwsCloudFrontDistributionOriginCustomOriginConfig) SetOriginKeepaliveTimeout added in v1.42.9

SetOriginKeepaliveTimeout sets the OriginKeepaliveTimeout field's value.

func (*AwsCloudFrontDistributionOriginCustomOriginConfig) SetOriginProtocolPolicy added in v1.42.9

SetOriginProtocolPolicy sets the OriginProtocolPolicy field's value.

func (*AwsCloudFrontDistributionOriginCustomOriginConfig) SetOriginReadTimeout added in v1.42.9

SetOriginReadTimeout sets the OriginReadTimeout field's value.

func (*AwsCloudFrontDistributionOriginCustomOriginConfig) SetOriginSslProtocols added in v1.42.9

SetOriginSslProtocols sets the OriginSslProtocols field's value.

func (AwsCloudFrontDistributionOriginCustomOriginConfig) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudFrontDistributionOriginGroup

type AwsCloudFrontDistributionOriginGroup struct {

	// Provides the criteria for an origin group to fail over.
	FailoverCriteria *AwsCloudFrontDistributionOriginGroupFailover `type:"structure"`
	// contains filtered or unexported fields
}

Information about an origin group for the CloudFront distribution.

func (AwsCloudFrontDistributionOriginGroup) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudFrontDistributionOriginGroup) SetFailoverCriteria

SetFailoverCriteria sets the FailoverCriteria field's value.

func (AwsCloudFrontDistributionOriginGroup) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudFrontDistributionOriginGroupFailover

type AwsCloudFrontDistributionOriginGroupFailover struct {

	// Information about the status codes that cause an origin group to fail over.
	StatusCodes *AwsCloudFrontDistributionOriginGroupFailoverStatusCodes `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about when an origin group fails over.

func (AwsCloudFrontDistributionOriginGroupFailover) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudFrontDistributionOriginGroupFailover) SetStatusCodes

SetStatusCodes sets the StatusCodes field's value.

func (AwsCloudFrontDistributionOriginGroupFailover) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudFrontDistributionOriginGroupFailoverStatusCodes

type AwsCloudFrontDistributionOriginGroupFailoverStatusCodes struct {

	// The list of status code values that can cause a failover to the next origin.
	Items []*int64 `type:"list"`

	// The number of status codes that can cause a failover.
	Quantity *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The status codes that cause an origin group to fail over.

func (AwsCloudFrontDistributionOriginGroupFailoverStatusCodes) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudFrontDistributionOriginGroupFailoverStatusCodes) SetItems

SetItems sets the Items field's value.

func (*AwsCloudFrontDistributionOriginGroupFailoverStatusCodes) SetQuantity

SetQuantity sets the Quantity field's value.

func (AwsCloudFrontDistributionOriginGroupFailoverStatusCodes) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudFrontDistributionOriginGroups

type AwsCloudFrontDistributionOriginGroups struct {

	// The list of origin groups.
	Items []*AwsCloudFrontDistributionOriginGroup `type:"list"`
	// contains filtered or unexported fields
}

Provides information about origin groups that are associated with the CloudFront distribution.

func (AwsCloudFrontDistributionOriginGroups) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudFrontDistributionOriginGroups) SetItems

SetItems sets the Items field's value.

func (AwsCloudFrontDistributionOriginGroups) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudFrontDistributionOriginItem

type AwsCloudFrontDistributionOriginItem struct {

	// An origin that is not an Amazon S3 bucket, with one exception. If the Amazon
	// S3 bucket is configured with static website hosting, use this attribute.
	// If the Amazon S3 bucket is not configured with static website hosting, use
	// the S3OriginConfig type instead.
	CustomOriginConfig *AwsCloudFrontDistributionOriginCustomOriginConfig `type:"structure"`

	// Amazon S3 origins: The DNS name of the S3 bucket from which you want CloudFront
	// to get objects for this origin.
	DomainName *string `type:"string"`

	// A unique identifier for the origin or origin group.
	Id *string `type:"string"`

	// An optional element that causes CloudFront to request your content from a
	// directory in your Amazon S3 bucket or your custom origin.
	OriginPath *string `type:"string"`

	// An origin that is an S3 bucket that is not configured with static website
	// hosting.
	S3OriginConfig *AwsCloudFrontDistributionOriginS3OriginConfig `type:"structure"`
	// contains filtered or unexported fields
}

A complex type that describes the Amazon S3 bucket, HTTP server (for example, a web server), AWS Elemental MediaStore, or other server from which CloudFront gets your files.

func (AwsCloudFrontDistributionOriginItem) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudFrontDistributionOriginItem) SetCustomOriginConfig added in v1.42.9

SetCustomOriginConfig sets the CustomOriginConfig field's value.

func (*AwsCloudFrontDistributionOriginItem) SetDomainName

SetDomainName sets the DomainName field's value.

func (*AwsCloudFrontDistributionOriginItem) SetId

SetId sets the Id field's value.

func (*AwsCloudFrontDistributionOriginItem) SetOriginPath

SetOriginPath sets the OriginPath field's value.

func (*AwsCloudFrontDistributionOriginItem) SetS3OriginConfig

SetS3OriginConfig sets the S3OriginConfig field's value.

func (AwsCloudFrontDistributionOriginItem) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudFrontDistributionOriginS3OriginConfig

type AwsCloudFrontDistributionOriginS3OriginConfig struct {

	// The CloudFront origin access identity to associate with the origin.
	OriginAccessIdentity *string `type:"string"`
	// contains filtered or unexported fields
}

Information about an origin that is an Amazon S3 bucket that is not configured with static website hosting.

func (AwsCloudFrontDistributionOriginS3OriginConfig) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudFrontDistributionOriginS3OriginConfig) SetOriginAccessIdentity

SetOriginAccessIdentity sets the OriginAccessIdentity field's value.

func (AwsCloudFrontDistributionOriginS3OriginConfig) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudFrontDistributionOriginSslProtocols added in v1.42.9

type AwsCloudFrontDistributionOriginSslProtocols struct {

	// A list that contains allowed SSL/TLS protocols for this distribution.
	Items []*string `type:"list"`

	// The number of SSL/TLS protocols that you want to allow CloudFront to use
	// when establishing an HTTPS connection with this origin.
	Quantity *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

func (AwsCloudFrontDistributionOriginSslProtocols) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudFrontDistributionOriginSslProtocols) SetItems added in v1.42.9

SetItems sets the Items field's value.

func (*AwsCloudFrontDistributionOriginSslProtocols) SetQuantity added in v1.42.9

SetQuantity sets the Quantity field's value.

func (AwsCloudFrontDistributionOriginSslProtocols) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudFrontDistributionOrigins

type AwsCloudFrontDistributionOrigins struct {

	// A complex type that contains origins or origin groups for this distribution.
	Items []*AwsCloudFrontDistributionOriginItem `type:"list"`
	// contains filtered or unexported fields
}

A complex type that contains information about origins and origin groups for this CloudFront distribution.

func (AwsCloudFrontDistributionOrigins) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudFrontDistributionOrigins) SetItems

SetItems sets the Items field's value.

func (AwsCloudFrontDistributionOrigins) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudFrontDistributionViewerCertificate

type AwsCloudFrontDistributionViewerCertificate struct {

	// The ARN of the ACM certificate. Used if the certificate is stored in ACM.
	// If you provide an ACM certificate ARN, you must also provide MinimumCertificateVersion
	// and SslSupportMethod.
	AcmCertificateArn *string `type:"string"`

	// The identifier of the certificate. Note that in CloudFront, this attribute
	// is deprecated.
	Certificate *string `type:"string"`

	// The source of the certificate identified by Certificate. Note that in CloudFront,
	// this attribute is deprecated.
	CertificateSource *string `type:"string"`

	// Whether the distribution uses the CloudFront domain name. If set to false,
	// then you provide either AcmCertificateArn or IamCertificateId.
	CloudFrontDefaultCertificate *bool `type:"boolean"`

	// The identifier of the IAM certificate. Used if the certificate is stored
	// in IAM. If you provide IamCertificateId, then you also must provide MinimumProtocolVersion
	// and SslSupportMethod.
	IamCertificateId *string `type:"string"`

	// The security policy that CloudFront uses for HTTPS connections with viewers.
	// If SslSupportMethod is sni-only, then MinimumProtocolVersion must be TLSv1
	// or higher.
	MinimumProtocolVersion *string `type:"string"`

	// The viewers that the distribution accepts HTTPS connections from.
	SslSupportMethod *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the TLS/SSL configuration that the CloudFront distribution uses to communicate with viewers.

func (AwsCloudFrontDistributionViewerCertificate) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudFrontDistributionViewerCertificate) SetAcmCertificateArn

SetAcmCertificateArn sets the AcmCertificateArn field's value.

func (*AwsCloudFrontDistributionViewerCertificate) SetCertificate

SetCertificate sets the Certificate field's value.

func (*AwsCloudFrontDistributionViewerCertificate) SetCertificateSource

SetCertificateSource sets the CertificateSource field's value.

func (*AwsCloudFrontDistributionViewerCertificate) SetCloudFrontDefaultCertificate

SetCloudFrontDefaultCertificate sets the CloudFrontDefaultCertificate field's value.

func (*AwsCloudFrontDistributionViewerCertificate) SetIamCertificateId

SetIamCertificateId sets the IamCertificateId field's value.

func (*AwsCloudFrontDistributionViewerCertificate) SetMinimumProtocolVersion

SetMinimumProtocolVersion sets the MinimumProtocolVersion field's value.

func (*AwsCloudFrontDistributionViewerCertificate) SetSslSupportMethod

SetSslSupportMethod sets the SslSupportMethod field's value.

func (AwsCloudFrontDistributionViewerCertificate) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudTrailTrailDetails

type AwsCloudTrailTrailDetails struct {

	// The ARN of the log group that CloudTrail logs are delivered to.
	CloudWatchLogsLogGroupArn *string `type:"string"`

	// The ARN of the role that the CloudWatch Events endpoint assumes when it writes
	// to the log group.
	CloudWatchLogsRoleArn *string `type:"string"`

	// Indicates whether the trail has custom event selectors.
	HasCustomEventSelectors *bool `type:"boolean"`

	// The Region where the trail was created.
	HomeRegion *string `type:"string"`

	// Indicates whether the trail publishes events from global services such as
	// IAM to the log files.
	IncludeGlobalServiceEvents *bool `type:"boolean"`

	// Indicates whether the trail applies only to the current Region or to all
	// Regions.
	IsMultiRegionTrail *bool `type:"boolean"`

	// Whether the trail is created for all accounts in an organization in Organizations,
	// or only for the current Amazon Web Services account.
	IsOrganizationTrail *bool `type:"boolean"`

	// The KMS key ID to use to encrypt the logs.
	KmsKeyId *string `type:"string"`

	// Indicates whether CloudTrail log file validation is enabled.
	LogFileValidationEnabled *bool `type:"boolean"`

	// The name of the trail.
	Name *string `type:"string"`

	// The name of the S3 bucket where the log files are published.
	S3BucketName *string `type:"string"`

	// The S3 key prefix. The key prefix is added after the name of the S3 bucket
	// where the log files are published.
	S3KeyPrefix *string `type:"string"`

	// The ARN of the SNS topic that is used for notifications of log file delivery.
	SnsTopicArn *string `type:"string"`

	// The name of the SNS topic that is used for notifications of log file delivery.
	SnsTopicName *string `type:"string"`

	// The ARN of the trail.
	TrailArn *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about a CloudTrail trail.

func (AwsCloudTrailTrailDetails) GoString

func (s AwsCloudTrailTrailDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudTrailTrailDetails) SetCloudWatchLogsLogGroupArn

func (s *AwsCloudTrailTrailDetails) SetCloudWatchLogsLogGroupArn(v string) *AwsCloudTrailTrailDetails

SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value.

func (*AwsCloudTrailTrailDetails) SetCloudWatchLogsRoleArn

func (s *AwsCloudTrailTrailDetails) SetCloudWatchLogsRoleArn(v string) *AwsCloudTrailTrailDetails

SetCloudWatchLogsRoleArn sets the CloudWatchLogsRoleArn field's value.

func (*AwsCloudTrailTrailDetails) SetHasCustomEventSelectors

func (s *AwsCloudTrailTrailDetails) SetHasCustomEventSelectors(v bool) *AwsCloudTrailTrailDetails

SetHasCustomEventSelectors sets the HasCustomEventSelectors field's value.

func (*AwsCloudTrailTrailDetails) SetHomeRegion

SetHomeRegion sets the HomeRegion field's value.

func (*AwsCloudTrailTrailDetails) SetIncludeGlobalServiceEvents

func (s *AwsCloudTrailTrailDetails) SetIncludeGlobalServiceEvents(v bool) *AwsCloudTrailTrailDetails

SetIncludeGlobalServiceEvents sets the IncludeGlobalServiceEvents field's value.

func (*AwsCloudTrailTrailDetails) SetIsMultiRegionTrail

func (s *AwsCloudTrailTrailDetails) SetIsMultiRegionTrail(v bool) *AwsCloudTrailTrailDetails

SetIsMultiRegionTrail sets the IsMultiRegionTrail field's value.

func (*AwsCloudTrailTrailDetails) SetIsOrganizationTrail

func (s *AwsCloudTrailTrailDetails) SetIsOrganizationTrail(v bool) *AwsCloudTrailTrailDetails

SetIsOrganizationTrail sets the IsOrganizationTrail field's value.

func (*AwsCloudTrailTrailDetails) SetKmsKeyId

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsCloudTrailTrailDetails) SetLogFileValidationEnabled

func (s *AwsCloudTrailTrailDetails) SetLogFileValidationEnabled(v bool) *AwsCloudTrailTrailDetails

SetLogFileValidationEnabled sets the LogFileValidationEnabled field's value.

func (*AwsCloudTrailTrailDetails) SetName

SetName sets the Name field's value.

func (*AwsCloudTrailTrailDetails) SetS3BucketName

SetS3BucketName sets the S3BucketName field's value.

func (*AwsCloudTrailTrailDetails) SetS3KeyPrefix

SetS3KeyPrefix sets the S3KeyPrefix field's value.

func (*AwsCloudTrailTrailDetails) SetSnsTopicArn

SetSnsTopicArn sets the SnsTopicArn field's value.

func (*AwsCloudTrailTrailDetails) SetSnsTopicName

SetSnsTopicName sets the SnsTopicName field's value.

func (*AwsCloudTrailTrailDetails) SetTrailArn

SetTrailArn sets the TrailArn field's value.

func (AwsCloudTrailTrailDetails) String

func (s AwsCloudTrailTrailDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudWatchAlarmDetails added in v1.42.9

type AwsCloudWatchAlarmDetails struct {

	// Indicates whether actions should be executed during any changes to the alarm
	// state.
	ActionsEnabled *bool `type:"boolean"`

	// The list of actions, specified as Amazon Resource Names (ARNs) to execute
	// when this alarm transitions into an ALARM state from any other state.
	AlarmActions []*string `type:"list"`

	// The ARN of the alarm.
	AlarmArn *string `type:"string"`

	// The time stamp of the last update to the alarm configuration.
	AlarmConfigurationUpdatedTimestamp *string `type:"string"`

	// The description of the alarm.
	AlarmDescription *string `type:"string"`

	// The name of the alarm. If you don't specify a name, CloudFront generates
	// a unique physical ID and uses that ID for the alarm name.
	AlarmName *string `type:"string"`

	// The arithmetic operation to use when comparing the specified statistic and
	// threshold. The specified statistic value is used as the first operand.
	ComparisonOperator *string `type:"string"`

	// The number of datapoints that must be breaching to trigger the alarm.
	DatapointsToAlarm *int64 `type:"integer"`

	// The dimensions for the metric associated with the alarm.
	Dimensions []*AwsCloudWatchAlarmDimensionsDetails `type:"list"`

	// Used only for alarms based on percentiles. If ignore, the alarm state does
	// not change during periods with too few data points to be statistically significant.
	// If evaluate or this parameter is not used, the alarm is always evaluated
	// and possibly changes state no matter how many data points are available.
	EvaluateLowSampleCountPercentile *string `type:"string"`

	// The number of periods over which data is compared to the specified threshold.
	EvaluationPeriods *int64 `type:"integer"`

	// The percentile statistic for the metric associated with the alarm.
	ExtendedStatistic *string `type:"string"`

	// The actions to execute when this alarm transitions to the INSUFFICIENT_DATA
	// state from any other state. Each action is specified as an ARN.
	InsufficientDataActions []*string `type:"list"`

	// The name of the metric associated with the alarm. This is required for an
	// alarm based on a metric. For an alarm based on a math expression, you use
	// Metrics instead and you can't specify MetricName.
	MetricName *string `type:"string"`

	// The namespace of the metric associated with the alarm. This is required for
	// an alarm based on a metric. For an alarm based on a math expression, you
	// can't specify Namespace and you use Metrics instead.
	Namespace *string `type:"string"`

	// The actions to execute when this alarm transitions to the OK state from any
	// other state. Each action is specified as an ARN.
	OkActions []*string `type:"list"`

	// The period, in seconds, over which the statistic is applied. This is required
	// for an alarm based on a metric.
	Period *int64 `type:"integer"`

	// The statistic for the metric associated with the alarm, other than percentile.
	// For percentile statistics, use ExtendedStatistic.
	//
	// For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic
	// but not both.
	//
	// For an alarm based on a math expression, you can't specify Statistic. Instead,
	// you use Metrics.
	Statistic *string `type:"string"`

	// The value to compare with the specified statistic.
	Threshold *float64 `type:"double"`

	// n an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND
	// function used as the threshold for the alarm.
	ThresholdMetricId *string `type:"string"`

	// Sets how this alarm is to handle missing data points.
	TreatMissingData *string `type:"string"`

	// The unit of the metric associated with the alarm.
	Unit *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies an alarm and associates it with the specified metric or metric math expression.

func (AwsCloudWatchAlarmDetails) GoString added in v1.42.9

func (s AwsCloudWatchAlarmDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudWatchAlarmDetails) SetActionsEnabled added in v1.42.9

func (s *AwsCloudWatchAlarmDetails) SetActionsEnabled(v bool) *AwsCloudWatchAlarmDetails

SetActionsEnabled sets the ActionsEnabled field's value.

func (*AwsCloudWatchAlarmDetails) SetAlarmActions added in v1.42.9

SetAlarmActions sets the AlarmActions field's value.

func (*AwsCloudWatchAlarmDetails) SetAlarmArn added in v1.42.9

SetAlarmArn sets the AlarmArn field's value.

func (*AwsCloudWatchAlarmDetails) SetAlarmConfigurationUpdatedTimestamp added in v1.42.9

func (s *AwsCloudWatchAlarmDetails) SetAlarmConfigurationUpdatedTimestamp(v string) *AwsCloudWatchAlarmDetails

SetAlarmConfigurationUpdatedTimestamp sets the AlarmConfigurationUpdatedTimestamp field's value.

func (*AwsCloudWatchAlarmDetails) SetAlarmDescription added in v1.42.9

func (s *AwsCloudWatchAlarmDetails) SetAlarmDescription(v string) *AwsCloudWatchAlarmDetails

SetAlarmDescription sets the AlarmDescription field's value.

func (*AwsCloudWatchAlarmDetails) SetAlarmName added in v1.42.9

SetAlarmName sets the AlarmName field's value.

func (*AwsCloudWatchAlarmDetails) SetComparisonOperator added in v1.42.9

func (s *AwsCloudWatchAlarmDetails) SetComparisonOperator(v string) *AwsCloudWatchAlarmDetails

SetComparisonOperator sets the ComparisonOperator field's value.

func (*AwsCloudWatchAlarmDetails) SetDatapointsToAlarm added in v1.42.9

func (s *AwsCloudWatchAlarmDetails) SetDatapointsToAlarm(v int64) *AwsCloudWatchAlarmDetails

SetDatapointsToAlarm sets the DatapointsToAlarm field's value.

func (*AwsCloudWatchAlarmDetails) SetDimensions added in v1.42.9

SetDimensions sets the Dimensions field's value.

func (*AwsCloudWatchAlarmDetails) SetEvaluateLowSampleCountPercentile added in v1.42.9

func (s *AwsCloudWatchAlarmDetails) SetEvaluateLowSampleCountPercentile(v string) *AwsCloudWatchAlarmDetails

SetEvaluateLowSampleCountPercentile sets the EvaluateLowSampleCountPercentile field's value.

func (*AwsCloudWatchAlarmDetails) SetEvaluationPeriods added in v1.42.9

func (s *AwsCloudWatchAlarmDetails) SetEvaluationPeriods(v int64) *AwsCloudWatchAlarmDetails

SetEvaluationPeriods sets the EvaluationPeriods field's value.

func (*AwsCloudWatchAlarmDetails) SetExtendedStatistic added in v1.42.9

func (s *AwsCloudWatchAlarmDetails) SetExtendedStatistic(v string) *AwsCloudWatchAlarmDetails

SetExtendedStatistic sets the ExtendedStatistic field's value.

func (*AwsCloudWatchAlarmDetails) SetInsufficientDataActions added in v1.42.9

func (s *AwsCloudWatchAlarmDetails) SetInsufficientDataActions(v []*string) *AwsCloudWatchAlarmDetails

SetInsufficientDataActions sets the InsufficientDataActions field's value.

func (*AwsCloudWatchAlarmDetails) SetMetricName added in v1.42.9

SetMetricName sets the MetricName field's value.

func (*AwsCloudWatchAlarmDetails) SetNamespace added in v1.42.9

SetNamespace sets the Namespace field's value.

func (*AwsCloudWatchAlarmDetails) SetOkActions added in v1.42.9

SetOkActions sets the OkActions field's value.

func (*AwsCloudWatchAlarmDetails) SetPeriod added in v1.42.9

SetPeriod sets the Period field's value.

func (*AwsCloudWatchAlarmDetails) SetStatistic added in v1.42.9

SetStatistic sets the Statistic field's value.

func (*AwsCloudWatchAlarmDetails) SetThreshold added in v1.42.9

SetThreshold sets the Threshold field's value.

func (*AwsCloudWatchAlarmDetails) SetThresholdMetricId added in v1.42.9

func (s *AwsCloudWatchAlarmDetails) SetThresholdMetricId(v string) *AwsCloudWatchAlarmDetails

SetThresholdMetricId sets the ThresholdMetricId field's value.

func (*AwsCloudWatchAlarmDetails) SetTreatMissingData added in v1.42.9

func (s *AwsCloudWatchAlarmDetails) SetTreatMissingData(v string) *AwsCloudWatchAlarmDetails

SetTreatMissingData sets the TreatMissingData field's value.

func (*AwsCloudWatchAlarmDetails) SetUnit added in v1.42.9

SetUnit sets the Unit field's value.

func (AwsCloudWatchAlarmDetails) String added in v1.42.9

func (s AwsCloudWatchAlarmDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCloudWatchAlarmDimensionsDetails added in v1.42.9

type AwsCloudWatchAlarmDimensionsDetails struct {

	// The name of a dimension.
	Name *string `type:"string"`

	// The value of a dimension.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Details about the dimensions for the metric associated with the alarm.

func (AwsCloudWatchAlarmDimensionsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCloudWatchAlarmDimensionsDetails) SetName added in v1.42.9

SetName sets the Name field's value.

func (*AwsCloudWatchAlarmDimensionsDetails) SetValue added in v1.42.9

SetValue sets the Value field's value.

func (AwsCloudWatchAlarmDimensionsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCodeBuildProjectArtifactsDetails

type AwsCodeBuildProjectArtifactsDetails struct {

	// An identifier for the artifact definition.
	ArtifactIdentifier *string `type:"string"`

	// Indicates whether to disable encryption on the artifact. Only valid when
	// Type is S3.
	EncryptionDisabled *bool `type:"boolean"`

	// Only used when Type is S3. The name of the S3 bucket where the artifact is
	// located.
	Location *string `type:"string"`

	// Only used when Type is S3. The name of the artifact. Used with NamepaceType
	// and Path to determine the pattern for storing the artifact.
	Name *string `type:"string"`

	// Only used when Type is S3. The value to use for the namespace. Used with
	// Name and Path to determine the pattern for storing the artifact.
	NamespaceType *string `type:"string"`

	// Whether the name specified in the buildspec file overrides the artifact name.
	OverrideArtifactName *bool `type:"boolean"`

	// Only used when Type is S3. The type of output artifact to create.
	Packaging *string `type:"string"`

	// Only used when Type is S3. The path to the artifact. Used with Name and NamespaceType
	// to determine the pattern for storing the artifact.
	Path *string `type:"string"`

	// The type of build artifact.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the build artifacts for the CodeBuild project.

func (AwsCodeBuildProjectArtifactsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCodeBuildProjectArtifactsDetails) SetArtifactIdentifier

SetArtifactIdentifier sets the ArtifactIdentifier field's value.

func (*AwsCodeBuildProjectArtifactsDetails) SetEncryptionDisabled

SetEncryptionDisabled sets the EncryptionDisabled field's value.

func (*AwsCodeBuildProjectArtifactsDetails) SetLocation

SetLocation sets the Location field's value.

func (*AwsCodeBuildProjectArtifactsDetails) SetName

SetName sets the Name field's value.

func (*AwsCodeBuildProjectArtifactsDetails) SetNamespaceType

SetNamespaceType sets the NamespaceType field's value.

func (*AwsCodeBuildProjectArtifactsDetails) SetOverrideArtifactName

SetOverrideArtifactName sets the OverrideArtifactName field's value.

func (*AwsCodeBuildProjectArtifactsDetails) SetPackaging

SetPackaging sets the Packaging field's value.

func (*AwsCodeBuildProjectArtifactsDetails) SetPath

SetPath sets the Path field's value.

func (*AwsCodeBuildProjectArtifactsDetails) SetType

SetType sets the Type field's value.

func (AwsCodeBuildProjectArtifactsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCodeBuildProjectDetails

type AwsCodeBuildProjectDetails struct {

	// Information about the build artifacts for the CodeBuild project.
	Artifacts []*AwsCodeBuildProjectArtifactsDetails `type:"list"`

	// The KMS key used to encrypt the build output artifacts.
	//
	// You can specify either the ARN of the KMS key or, if available, the KMS key
	// alias (using the format alias/alias-name).
	EncryptionKey *string `type:"string"`

	// Information about the build environment for this build project.
	Environment *AwsCodeBuildProjectEnvironment `type:"structure"`

	// Information about logs for the build project.
	LogsConfig *AwsCodeBuildProjectLogsConfigDetails `type:"structure"`

	// The name of the build project.
	Name *string `type:"string"`

	// Information about the secondary artifacts for the CodeBuild project.
	SecondaryArtifacts []*AwsCodeBuildProjectArtifactsDetails `type:"list"`

	// The ARN of the IAM role that enables CodeBuild to interact with dependent
	// Amazon Web Services services on behalf of the Amazon Web Services account.
	ServiceRole *string `type:"string"`

	// Information about the build input source code for this build project.
	Source *AwsCodeBuildProjectSource `type:"structure"`

	// Information about the VPC configuration that CodeBuild accesses.
	VpcConfig *AwsCodeBuildProjectVpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Information about an CodeBuild project.

func (AwsCodeBuildProjectDetails) GoString

func (s AwsCodeBuildProjectDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCodeBuildProjectDetails) SetArtifacts

SetArtifacts sets the Artifacts field's value.

func (*AwsCodeBuildProjectDetails) SetEncryptionKey

SetEncryptionKey sets the EncryptionKey field's value.

func (*AwsCodeBuildProjectDetails) SetEnvironment

SetEnvironment sets the Environment field's value.

func (*AwsCodeBuildProjectDetails) SetLogsConfig

SetLogsConfig sets the LogsConfig field's value.

func (*AwsCodeBuildProjectDetails) SetName

SetName sets the Name field's value.

func (*AwsCodeBuildProjectDetails) SetSecondaryArtifacts added in v1.42.9

SetSecondaryArtifacts sets the SecondaryArtifacts field's value.

func (*AwsCodeBuildProjectDetails) SetServiceRole

SetServiceRole sets the ServiceRole field's value.

func (*AwsCodeBuildProjectDetails) SetSource

SetSource sets the Source field's value.

func (*AwsCodeBuildProjectDetails) SetVpcConfig

SetVpcConfig sets the VpcConfig field's value.

func (AwsCodeBuildProjectDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCodeBuildProjectEnvironment

type AwsCodeBuildProjectEnvironment struct {

	// The certificate to use with this build project.
	Certificate *string `type:"string"`

	// A set of environment variables to make available to builds for the build
	// project.
	EnvironmentVariables []*AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails `type:"list"`

	// The type of credentials CodeBuild uses to pull images in your build.
	//
	// Valid values:
	//
	//    * CODEBUILD specifies that CodeBuild uses its own credentials. This requires
	//    that you modify your ECR repository policy to trust the CodeBuild service
	//    principal.
	//
	//    * SERVICE_ROLE specifies that CodeBuild uses your build project's service
	//    role.
	//
	// When you use a cross-account or private registry image, you must use SERVICE_ROLE
	// credentials. When you use an CodeBuild curated image, you must use CODEBUILD
	// credentials.
	ImagePullCredentialsType *string `type:"string"`

	// Whether to allow the Docker daemon to run inside a Docker container. Set
	// to true if the build project is used to build Docker images.
	PrivilegedMode *bool `type:"boolean"`

	// The credentials for access to a private registry.
	RegistryCredential *AwsCodeBuildProjectEnvironmentRegistryCredential `type:"structure"`

	// The type of build environment to use for related builds.
	//
	// The environment type ARM_CONTAINER is available only in Regions US East (N.
	// Virginia), US East (Ohio), US West (Oregon), Europe (Ireland), Asia Pacific
	// (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).
	//
	// The environment type LINUX_CONTAINER with compute type build.general1.2xlarge
	// is available only in Regions US East (N. Virginia), US East (N. Virginia),
	// US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe
	// (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore),
	// Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
	//
	// The environment type LINUX_GPU_CONTAINER is available only in Regions US
	// East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central),
	// Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo),
	// Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China
	// (Beijing), and China (Ningxia).
	//
	// Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER |
	// ARM_CONTAINER
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the build environment for this build project.

func (AwsCodeBuildProjectEnvironment) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCodeBuildProjectEnvironment) SetCertificate

SetCertificate sets the Certificate field's value.

func (*AwsCodeBuildProjectEnvironment) SetEnvironmentVariables

SetEnvironmentVariables sets the EnvironmentVariables field's value.

func (*AwsCodeBuildProjectEnvironment) SetImagePullCredentialsType

func (s *AwsCodeBuildProjectEnvironment) SetImagePullCredentialsType(v string) *AwsCodeBuildProjectEnvironment

SetImagePullCredentialsType sets the ImagePullCredentialsType field's value.

func (*AwsCodeBuildProjectEnvironment) SetPrivilegedMode

SetPrivilegedMode sets the PrivilegedMode field's value.

func (*AwsCodeBuildProjectEnvironment) SetRegistryCredential

SetRegistryCredential sets the RegistryCredential field's value.

func (*AwsCodeBuildProjectEnvironment) SetType

SetType sets the Type field's value.

func (AwsCodeBuildProjectEnvironment) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails

type AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails struct {

	// The name of the environment variable.
	Name *string `type:"string"`

	// The type of environment variable.
	Type *string `type:"string"`

	// The value of the environment variable.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Information about an environment variable that is available to builds for the build project.

func (AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails) SetName

SetName sets the Name field's value.

func (*AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails) SetType

SetType sets the Type field's value.

func (*AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails) SetValue

SetValue sets the Value field's value.

func (AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCodeBuildProjectEnvironmentRegistryCredential

type AwsCodeBuildProjectEnvironmentRegistryCredential struct {

	// The ARN or name of credentials created using Secrets Manager.
	//
	// The credential can use the name of the credentials only if they exist in
	// your current Amazon Web Services Region.
	Credential *string `type:"string"`

	// The service that created the credentials to access a private Docker registry.
	//
	// The valid value,SECRETS_MANAGER, is for Secrets Manager.
	CredentialProvider *string `type:"string"`
	// contains filtered or unexported fields
}

The credentials for access to a private registry.

func (AwsCodeBuildProjectEnvironmentRegistryCredential) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCodeBuildProjectEnvironmentRegistryCredential) SetCredential

SetCredential sets the Credential field's value.

func (*AwsCodeBuildProjectEnvironmentRegistryCredential) SetCredentialProvider

SetCredentialProvider sets the CredentialProvider field's value.

func (AwsCodeBuildProjectEnvironmentRegistryCredential) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails

type AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails struct {

	// The group name of the logs in CloudWatch Logs.
	GroupName *string `type:"string"`

	// The current status of the logs in CloudWatch Logs for a build project.
	Status *string `type:"string"`

	// The prefix of the stream name of the CloudWatch Logs.
	StreamName *string `type:"string"`
	// contains filtered or unexported fields
}

Information about CloudWatch Logs for the build project.

func (AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails) SetGroupName

SetGroupName sets the GroupName field's value.

func (*AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails) SetStatus

SetStatus sets the Status field's value.

func (*AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails) SetStreamName

SetStreamName sets the StreamName field's value.

func (AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCodeBuildProjectLogsConfigDetails

type AwsCodeBuildProjectLogsConfigDetails struct {

	// Information about CloudWatch Logs for the build project.
	CloudWatchLogs *AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails `type:"structure"`

	// Information about logs built to an S3 bucket for a build project.
	S3Logs *AwsCodeBuildProjectLogsConfigS3LogsDetails `type:"structure"`
	// contains filtered or unexported fields
}

Information about logs for the build project.

func (AwsCodeBuildProjectLogsConfigDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCodeBuildProjectLogsConfigDetails) SetCloudWatchLogs

SetCloudWatchLogs sets the CloudWatchLogs field's value.

func (*AwsCodeBuildProjectLogsConfigDetails) SetS3Logs

SetS3Logs sets the S3Logs field's value.

func (AwsCodeBuildProjectLogsConfigDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCodeBuildProjectLogsConfigS3LogsDetails

type AwsCodeBuildProjectLogsConfigS3LogsDetails struct {

	// Whether to disable encryption of the S3 build log output.
	EncryptionDisabled *bool `type:"boolean"`

	// The ARN of the S3 bucket and the path prefix for S3 logs.
	Location *string `type:"string"`

	// The current status of the S3 build logs.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Information about logs built to an S3 bucket for a build project.

func (AwsCodeBuildProjectLogsConfigS3LogsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCodeBuildProjectLogsConfigS3LogsDetails) SetEncryptionDisabled

SetEncryptionDisabled sets the EncryptionDisabled field's value.

func (*AwsCodeBuildProjectLogsConfigS3LogsDetails) SetLocation

SetLocation sets the Location field's value.

func (*AwsCodeBuildProjectLogsConfigS3LogsDetails) SetStatus

SetStatus sets the Status field's value.

func (AwsCodeBuildProjectLogsConfigS3LogsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCodeBuildProjectSource

type AwsCodeBuildProjectSource struct {

	// Information about the Git clone depth for the build project.
	GitCloneDepth *int64 `type:"integer"`

	// Whether to ignore SSL warnings while connecting to the project source code.
	InsecureSsl *bool `type:"boolean"`

	// Information about the location of the source code to be built.
	//
	// Valid values include:
	//
	//    * For source code settings that are specified in the source action of
	//    a pipeline in CodePipeline, location should not be specified. If it is
	//    specified, CodePipeline ignores it. This is because CodePipeline uses
	//    the settings in a pipeline's source action instead of this value.
	//
	//    * For source code in an CodeCommit repository, the HTTPS clone URL to
	//    the repository that contains the source code and the build spec file (for
	//    example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name
	//    ).
	//
	//    * For source code in an S3 input bucket, one of the following. The path
	//    to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip).
	//    The path to the folder that contains the source code (for example, bucket-name/path/to/source-code/folder/).
	//
	//    * For source code in a GitHub repository, the HTTPS clone URL to the repository
	//    that contains the source and the build spec file.
	//
	//    * For source code in a Bitbucket repository, the HTTPS clone URL to the
	//    repository that contains the source and the build spec file.
	Location *string `type:"string"`

	// The type of repository that contains the source code to be built. Valid values
	// are:
	//
	//    * BITBUCKET - The source code is in a Bitbucket repository.
	//
	//    * CODECOMMIT - The source code is in an CodeCommit repository.
	//
	//    * CODEPIPELINE - The source code settings are specified in the source
	//    action of a pipeline in CodePipeline.
	//
	//    * GITHUB - The source code is in a GitHub repository.
	//
	//    * GITHUB_ENTERPRISE - The source code is in a GitHub Enterprise repository.
	//
	//    * NO_SOURCE - The project does not have input source code.
	//
	//    * S3 - The source code is in an S3 input bucket.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the build input source code for this build project.

func (AwsCodeBuildProjectSource) GoString

func (s AwsCodeBuildProjectSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCodeBuildProjectSource) SetGitCloneDepth

SetGitCloneDepth sets the GitCloneDepth field's value.

func (*AwsCodeBuildProjectSource) SetInsecureSsl

SetInsecureSsl sets the InsecureSsl field's value.

func (*AwsCodeBuildProjectSource) SetLocation

SetLocation sets the Location field's value.

func (*AwsCodeBuildProjectSource) SetType

SetType sets the Type field's value.

func (AwsCodeBuildProjectSource) String

func (s AwsCodeBuildProjectSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCodeBuildProjectVpcConfig

type AwsCodeBuildProjectVpcConfig struct {

	// A list of one or more security group IDs in your VPC.
	SecurityGroupIds []*string `type:"list"`

	// A list of one or more subnet IDs in your VPC.
	Subnets []*string `type:"list"`

	// The ID of the VPC.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the VPC configuration that CodeBuild accesses.

func (AwsCodeBuildProjectVpcConfig) GoString

func (s AwsCodeBuildProjectVpcConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCodeBuildProjectVpcConfig) SetSecurityGroupIds

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*AwsCodeBuildProjectVpcConfig) SetSubnets

SetSubnets sets the Subnets field's value.

func (*AwsCodeBuildProjectVpcConfig) SetVpcId

SetVpcId sets the VpcId field's value.

func (AwsCodeBuildProjectVpcConfig) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsCorsConfiguration

type AwsCorsConfiguration struct {

	// Indicates whether the CORS request includes credentials.
	AllowCredentials *bool `type:"boolean"`

	// The allowed headers for CORS requests.
	AllowHeaders []*string `type:"list"`

	// The allowed methods for CORS requests.
	AllowMethods []*string `type:"list"`

	// The allowed origins for CORS requests.
	AllowOrigins []*string `type:"list"`

	// The exposed headers for CORS requests.
	ExposeHeaders []*string `type:"list"`

	// The number of seconds for which the browser caches preflight request results.
	MaxAge *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Contains the cross-origin resource sharing (CORS) configuration for the API. CORS is only supported for HTTP APIs.

func (AwsCorsConfiguration) GoString

func (s AwsCorsConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsCorsConfiguration) SetAllowCredentials

func (s *AwsCorsConfiguration) SetAllowCredentials(v bool) *AwsCorsConfiguration

SetAllowCredentials sets the AllowCredentials field's value.

func (*AwsCorsConfiguration) SetAllowHeaders

func (s *AwsCorsConfiguration) SetAllowHeaders(v []*string) *AwsCorsConfiguration

SetAllowHeaders sets the AllowHeaders field's value.

func (*AwsCorsConfiguration) SetAllowMethods

func (s *AwsCorsConfiguration) SetAllowMethods(v []*string) *AwsCorsConfiguration

SetAllowMethods sets the AllowMethods field's value.

func (*AwsCorsConfiguration) SetAllowOrigins

func (s *AwsCorsConfiguration) SetAllowOrigins(v []*string) *AwsCorsConfiguration

SetAllowOrigins sets the AllowOrigins field's value.

func (*AwsCorsConfiguration) SetExposeHeaders

func (s *AwsCorsConfiguration) SetExposeHeaders(v []*string) *AwsCorsConfiguration

SetExposeHeaders sets the ExposeHeaders field's value.

func (*AwsCorsConfiguration) SetMaxAge

SetMaxAge sets the MaxAge field's value.

func (AwsCorsConfiguration) String

func (s AwsCorsConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsDynamoDbTableAttributeDefinition

type AwsDynamoDbTableAttributeDefinition struct {

	// The name of the attribute.
	AttributeName *string `type:"string"`

	// The type of the attribute.
	AttributeType *string `type:"string"`
	// contains filtered or unexported fields
}

Contains a definition of an attribute for the table.

func (AwsDynamoDbTableAttributeDefinition) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsDynamoDbTableAttributeDefinition) SetAttributeName

SetAttributeName sets the AttributeName field's value.

func (*AwsDynamoDbTableAttributeDefinition) SetAttributeType

SetAttributeType sets the AttributeType field's value.

func (AwsDynamoDbTableAttributeDefinition) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsDynamoDbTableBillingModeSummary

type AwsDynamoDbTableBillingModeSummary struct {

	// The method used to charge for read and write throughput and to manage capacity.
	BillingMode *string `type:"string"`

	// If the billing mode is PAY_PER_REQUEST, indicates when the billing mode was
	// set to that value.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	LastUpdateToPayPerRequestDateTime *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the billing for read/write capacity on the table.

func (AwsDynamoDbTableBillingModeSummary) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsDynamoDbTableBillingModeSummary) SetBillingMode

SetBillingMode sets the BillingMode field's value.

func (*AwsDynamoDbTableBillingModeSummary) SetLastUpdateToPayPerRequestDateTime

func (s *AwsDynamoDbTableBillingModeSummary) SetLastUpdateToPayPerRequestDateTime(v string) *AwsDynamoDbTableBillingModeSummary

SetLastUpdateToPayPerRequestDateTime sets the LastUpdateToPayPerRequestDateTime field's value.

func (AwsDynamoDbTableBillingModeSummary) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsDynamoDbTableDetails

type AwsDynamoDbTableDetails struct {

	// A list of attribute definitions for the table.
	AttributeDefinitions []*AwsDynamoDbTableAttributeDefinition `type:"list"`

	// Information about the billing for read/write capacity on the table.
	BillingModeSummary *AwsDynamoDbTableBillingModeSummary `type:"structure"`

	// Indicates when the table was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreationDateTime *string `type:"string"`

	// List of global secondary indexes for the table.
	GlobalSecondaryIndexes []*AwsDynamoDbTableGlobalSecondaryIndex `type:"list"`

	// The version of global tables being used.
	GlobalTableVersion *string `type:"string"`

	// The number of items in the table.
	ItemCount *int64 `type:"integer"`

	// The primary key structure for the table.
	KeySchema []*AwsDynamoDbTableKeySchema `type:"list"`

	// The ARN of the latest stream for the table.
	LatestStreamArn *string `type:"string"`

	// The label of the latest stream. The label is not a unique identifier.
	LatestStreamLabel *string `type:"string"`

	// The list of local secondary indexes for the table.
	LocalSecondaryIndexes []*AwsDynamoDbTableLocalSecondaryIndex `type:"list"`

	// Information about the provisioned throughput for the table.
	ProvisionedThroughput *AwsDynamoDbTableProvisionedThroughput `type:"structure"`

	// The list of replicas of this table.
	Replicas []*AwsDynamoDbTableReplica `type:"list"`

	// Information about the restore for the table.
	RestoreSummary *AwsDynamoDbTableRestoreSummary `type:"structure"`

	// Information about the server-side encryption for the table.
	SseDescription *AwsDynamoDbTableSseDescription `type:"structure"`

	// The current DynamoDB Streams configuration for the table.
	StreamSpecification *AwsDynamoDbTableStreamSpecification `type:"structure"`

	// The identifier of the table.
	TableId *string `type:"string"`

	// The name of the table.
	TableName *string `type:"string"`

	// The total size of the table in bytes.
	TableSizeBytes *int64 `type:"long"`

	// The current status of the table. Valid values are as follows:
	//
	//    * ACTIVE
	//
	//    * ARCHIVED
	//
	//    * ARCHIVING
	//
	//    * CREATING
	//
	//    * DELETING
	//
	//    * INACCESSIBLE_ENCRYPTION_CREDENTIALS
	//
	//    * UPDATING
	TableStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about a DynamoDB table.

func (AwsDynamoDbTableDetails) GoString

func (s AwsDynamoDbTableDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsDynamoDbTableDetails) SetAttributeDefinitions

SetAttributeDefinitions sets the AttributeDefinitions field's value.

func (*AwsDynamoDbTableDetails) SetBillingModeSummary

SetBillingModeSummary sets the BillingModeSummary field's value.

func (*AwsDynamoDbTableDetails) SetCreationDateTime

func (s *AwsDynamoDbTableDetails) SetCreationDateTime(v string) *AwsDynamoDbTableDetails

SetCreationDateTime sets the CreationDateTime field's value.

func (*AwsDynamoDbTableDetails) SetGlobalSecondaryIndexes

SetGlobalSecondaryIndexes sets the GlobalSecondaryIndexes field's value.

func (*AwsDynamoDbTableDetails) SetGlobalTableVersion

func (s *AwsDynamoDbTableDetails) SetGlobalTableVersion(v string) *AwsDynamoDbTableDetails

SetGlobalTableVersion sets the GlobalTableVersion field's value.

func (*AwsDynamoDbTableDetails) SetItemCount

SetItemCount sets the ItemCount field's value.

func (*AwsDynamoDbTableDetails) SetKeySchema

SetKeySchema sets the KeySchema field's value.

func (*AwsDynamoDbTableDetails) SetLatestStreamArn

func (s *AwsDynamoDbTableDetails) SetLatestStreamArn(v string) *AwsDynamoDbTableDetails

SetLatestStreamArn sets the LatestStreamArn field's value.

func (*AwsDynamoDbTableDetails) SetLatestStreamLabel

func (s *AwsDynamoDbTableDetails) SetLatestStreamLabel(v string) *AwsDynamoDbTableDetails

SetLatestStreamLabel sets the LatestStreamLabel field's value.

func (*AwsDynamoDbTableDetails) SetLocalSecondaryIndexes

SetLocalSecondaryIndexes sets the LocalSecondaryIndexes field's value.

func (*AwsDynamoDbTableDetails) SetProvisionedThroughput

SetProvisionedThroughput sets the ProvisionedThroughput field's value.

func (*AwsDynamoDbTableDetails) SetReplicas

SetReplicas sets the Replicas field's value.

func (*AwsDynamoDbTableDetails) SetRestoreSummary

SetRestoreSummary sets the RestoreSummary field's value.

func (*AwsDynamoDbTableDetails) SetSseDescription

SetSseDescription sets the SseDescription field's value.

func (*AwsDynamoDbTableDetails) SetStreamSpecification

SetStreamSpecification sets the StreamSpecification field's value.

func (*AwsDynamoDbTableDetails) SetTableId

SetTableId sets the TableId field's value.

func (*AwsDynamoDbTableDetails) SetTableName

SetTableName sets the TableName field's value.

func (*AwsDynamoDbTableDetails) SetTableSizeBytes

func (s *AwsDynamoDbTableDetails) SetTableSizeBytes(v int64) *AwsDynamoDbTableDetails

SetTableSizeBytes sets the TableSizeBytes field's value.

func (*AwsDynamoDbTableDetails) SetTableStatus

SetTableStatus sets the TableStatus field's value.

func (AwsDynamoDbTableDetails) String

func (s AwsDynamoDbTableDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsDynamoDbTableGlobalSecondaryIndex

type AwsDynamoDbTableGlobalSecondaryIndex struct {

	// Whether the index is currently backfilling.
	Backfilling *bool `type:"boolean"`

	// The ARN of the index.
	IndexArn *string `type:"string"`

	// The name of the index.
	IndexName *string `type:"string"`

	// The total size in bytes of the index.
	IndexSizeBytes *int64 `type:"long"`

	// The current status of the index.
	//
	//    * ACTIVE
	//
	//    * CREATING
	//
	//    * DELETING
	//
	//    * UPDATING
	IndexStatus *string `type:"string"`

	// The number of items in the index.
	ItemCount *int64 `type:"integer"`

	// The key schema for the index.
	KeySchema []*AwsDynamoDbTableKeySchema `type:"list"`

	// Attributes that are copied from the table into an index.
	Projection *AwsDynamoDbTableProjection `type:"structure"`

	// Information about the provisioned throughput settings for the indexes.
	ProvisionedThroughput *AwsDynamoDbTableProvisionedThroughput `type:"structure"`
	// contains filtered or unexported fields
}

Information abut a global secondary index for the table.

func (AwsDynamoDbTableGlobalSecondaryIndex) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsDynamoDbTableGlobalSecondaryIndex) SetBackfilling

SetBackfilling sets the Backfilling field's value.

func (*AwsDynamoDbTableGlobalSecondaryIndex) SetIndexArn

SetIndexArn sets the IndexArn field's value.

func (*AwsDynamoDbTableGlobalSecondaryIndex) SetIndexName

SetIndexName sets the IndexName field's value.

func (*AwsDynamoDbTableGlobalSecondaryIndex) SetIndexSizeBytes

SetIndexSizeBytes sets the IndexSizeBytes field's value.

func (*AwsDynamoDbTableGlobalSecondaryIndex) SetIndexStatus

SetIndexStatus sets the IndexStatus field's value.

func (*AwsDynamoDbTableGlobalSecondaryIndex) SetItemCount

SetItemCount sets the ItemCount field's value.

func (*AwsDynamoDbTableGlobalSecondaryIndex) SetKeySchema

SetKeySchema sets the KeySchema field's value.

func (*AwsDynamoDbTableGlobalSecondaryIndex) SetProjection

SetProjection sets the Projection field's value.

func (*AwsDynamoDbTableGlobalSecondaryIndex) SetProvisionedThroughput

SetProvisionedThroughput sets the ProvisionedThroughput field's value.

func (AwsDynamoDbTableGlobalSecondaryIndex) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsDynamoDbTableKeySchema

type AwsDynamoDbTableKeySchema struct {

	// The name of the key schema attribute.
	AttributeName *string `type:"string"`

	// The type of key used for the key schema attribute. Valid values are HASH
	// or RANGE.
	KeyType *string `type:"string"`
	// contains filtered or unexported fields
}

A component of the key schema for the DynamoDB table, a global secondary index, or a local secondary index.

func (AwsDynamoDbTableKeySchema) GoString

func (s AwsDynamoDbTableKeySchema) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsDynamoDbTableKeySchema) SetAttributeName

SetAttributeName sets the AttributeName field's value.

func (*AwsDynamoDbTableKeySchema) SetKeyType

SetKeyType sets the KeyType field's value.

func (AwsDynamoDbTableKeySchema) String

func (s AwsDynamoDbTableKeySchema) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsDynamoDbTableLocalSecondaryIndex

type AwsDynamoDbTableLocalSecondaryIndex struct {

	// The ARN of the index.
	IndexArn *string `type:"string"`

	// The name of the index.
	IndexName *string `type:"string"`

	// The complete key schema for the index.
	KeySchema []*AwsDynamoDbTableKeySchema `type:"list"`

	// Attributes that are copied from the table into the index. These are in addition
	// to the primary key attributes and index key attributes, which are automatically
	// projected.
	Projection *AwsDynamoDbTableProjection `type:"structure"`
	// contains filtered or unexported fields
}

Information about a local secondary index for a DynamoDB table.

func (AwsDynamoDbTableLocalSecondaryIndex) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsDynamoDbTableLocalSecondaryIndex) SetIndexArn

SetIndexArn sets the IndexArn field's value.

func (*AwsDynamoDbTableLocalSecondaryIndex) SetIndexName

SetIndexName sets the IndexName field's value.

func (*AwsDynamoDbTableLocalSecondaryIndex) SetKeySchema

SetKeySchema sets the KeySchema field's value.

func (*AwsDynamoDbTableLocalSecondaryIndex) SetProjection

SetProjection sets the Projection field's value.

func (AwsDynamoDbTableLocalSecondaryIndex) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsDynamoDbTableProjection

type AwsDynamoDbTableProjection struct {

	// The nonkey attributes that are projected into the index. For each attribute,
	// provide the attribute name.
	NonKeyAttributes []*string `type:"list"`

	// The types of attributes that are projected into the index. Valid values are
	// as follows:
	//
	//    * ALL
	//
	//    * INCLUDE
	//
	//    * KEYS_ONLY
	ProjectionType *string `type:"string"`
	// contains filtered or unexported fields
}

For global and local secondary indexes, identifies the attributes that are copied from the table into the index.

func (AwsDynamoDbTableProjection) GoString

func (s AwsDynamoDbTableProjection) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsDynamoDbTableProjection) SetNonKeyAttributes

func (s *AwsDynamoDbTableProjection) SetNonKeyAttributes(v []*string) *AwsDynamoDbTableProjection

SetNonKeyAttributes sets the NonKeyAttributes field's value.

func (*AwsDynamoDbTableProjection) SetProjectionType

SetProjectionType sets the ProjectionType field's value.

func (AwsDynamoDbTableProjection) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsDynamoDbTableProvisionedThroughput

type AwsDynamoDbTableProvisionedThroughput struct {

	// Indicates when the provisioned throughput was last decreased.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	LastDecreaseDateTime *string `type:"string"`

	// Indicates when the provisioned throughput was last increased.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	LastIncreaseDateTime *string `type:"string"`

	// The number of times during the current UTC calendar day that the provisioned
	// throughput was decreased.
	NumberOfDecreasesToday *int64 `type:"integer"`

	// The maximum number of strongly consistent reads consumed per second before
	// DynamoDB returns a ThrottlingException.
	ReadCapacityUnits *int64 `type:"integer"`

	// The maximum number of writes consumed per second before DynamoDB returns
	// a ThrottlingException.
	WriteCapacityUnits *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Information about the provisioned throughput for the table or for a global secondary index.

func (AwsDynamoDbTableProvisionedThroughput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsDynamoDbTableProvisionedThroughput) SetLastDecreaseDateTime

SetLastDecreaseDateTime sets the LastDecreaseDateTime field's value.

func (*AwsDynamoDbTableProvisionedThroughput) SetLastIncreaseDateTime

SetLastIncreaseDateTime sets the LastIncreaseDateTime field's value.

func (*AwsDynamoDbTableProvisionedThroughput) SetNumberOfDecreasesToday

SetNumberOfDecreasesToday sets the NumberOfDecreasesToday field's value.

func (*AwsDynamoDbTableProvisionedThroughput) SetReadCapacityUnits

SetReadCapacityUnits sets the ReadCapacityUnits field's value.

func (*AwsDynamoDbTableProvisionedThroughput) SetWriteCapacityUnits

SetWriteCapacityUnits sets the WriteCapacityUnits field's value.

func (AwsDynamoDbTableProvisionedThroughput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsDynamoDbTableProvisionedThroughputOverride

type AwsDynamoDbTableProvisionedThroughputOverride struct {

	// The read capacity units for the replica.
	ReadCapacityUnits *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Replica-specific configuration for the provisioned throughput.

func (AwsDynamoDbTableProvisionedThroughputOverride) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsDynamoDbTableProvisionedThroughputOverride) SetReadCapacityUnits

SetReadCapacityUnits sets the ReadCapacityUnits field's value.

func (AwsDynamoDbTableProvisionedThroughputOverride) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsDynamoDbTableReplica

type AwsDynamoDbTableReplica struct {

	// List of global secondary indexes for the replica.
	GlobalSecondaryIndexes []*AwsDynamoDbTableReplicaGlobalSecondaryIndex `type:"list"`

	// The identifier of the KMS key that will be used for KMS encryption for the
	// replica.
	KmsMasterKeyId *string `type:"string"`

	// Replica-specific configuration for the provisioned throughput.
	ProvisionedThroughputOverride *AwsDynamoDbTableProvisionedThroughputOverride `type:"structure"`

	// The name of the Region where the replica is located.
	RegionName *string `type:"string"`

	// The current status of the replica. Valid values are as follows:
	//
	//    * ACTIVE
	//
	//    * CREATING
	//
	//    * CREATION_FAILED
	//
	//    * DELETING
	//
	//    * UPDATING
	ReplicaStatus *string `type:"string"`

	// Detailed information about the replica status.
	ReplicaStatusDescription *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a replica of a DynamoDB table.

func (AwsDynamoDbTableReplica) GoString

func (s AwsDynamoDbTableReplica) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsDynamoDbTableReplica) SetGlobalSecondaryIndexes

SetGlobalSecondaryIndexes sets the GlobalSecondaryIndexes field's value.

func (*AwsDynamoDbTableReplica) SetKmsMasterKeyId

func (s *AwsDynamoDbTableReplica) SetKmsMasterKeyId(v string) *AwsDynamoDbTableReplica

SetKmsMasterKeyId sets the KmsMasterKeyId field's value.

func (*AwsDynamoDbTableReplica) SetProvisionedThroughputOverride

SetProvisionedThroughputOverride sets the ProvisionedThroughputOverride field's value.

func (*AwsDynamoDbTableReplica) SetRegionName

SetRegionName sets the RegionName field's value.

func (*AwsDynamoDbTableReplica) SetReplicaStatus

func (s *AwsDynamoDbTableReplica) SetReplicaStatus(v string) *AwsDynamoDbTableReplica

SetReplicaStatus sets the ReplicaStatus field's value.

func (*AwsDynamoDbTableReplica) SetReplicaStatusDescription

func (s *AwsDynamoDbTableReplica) SetReplicaStatusDescription(v string) *AwsDynamoDbTableReplica

SetReplicaStatusDescription sets the ReplicaStatusDescription field's value.

func (AwsDynamoDbTableReplica) String

func (s AwsDynamoDbTableReplica) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsDynamoDbTableReplicaGlobalSecondaryIndex

type AwsDynamoDbTableReplicaGlobalSecondaryIndex struct {

	// The name of the index.
	IndexName *string `type:"string"`

	// Replica-specific configuration for the provisioned throughput for the index.
	ProvisionedThroughputOverride *AwsDynamoDbTableProvisionedThroughputOverride `type:"structure"`
	// contains filtered or unexported fields
}

Information about a global secondary index for a DynamoDB table replica.

func (AwsDynamoDbTableReplicaGlobalSecondaryIndex) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsDynamoDbTableReplicaGlobalSecondaryIndex) SetIndexName

SetIndexName sets the IndexName field's value.

func (*AwsDynamoDbTableReplicaGlobalSecondaryIndex) SetProvisionedThroughputOverride

SetProvisionedThroughputOverride sets the ProvisionedThroughputOverride field's value.

func (AwsDynamoDbTableReplicaGlobalSecondaryIndex) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsDynamoDbTableRestoreSummary

type AwsDynamoDbTableRestoreSummary struct {

	// Indicates the point in time that the table was restored to.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	RestoreDateTime *string `type:"string"`

	// Whether a restore is currently in progress.
	RestoreInProgress *bool `type:"boolean"`

	// The ARN of the source backup from which the table was restored.
	SourceBackupArn *string `type:"string"`

	// The ARN of the source table for the backup.
	SourceTableArn *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the restore for the table.

func (AwsDynamoDbTableRestoreSummary) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsDynamoDbTableRestoreSummary) SetRestoreDateTime

SetRestoreDateTime sets the RestoreDateTime field's value.

func (*AwsDynamoDbTableRestoreSummary) SetRestoreInProgress

SetRestoreInProgress sets the RestoreInProgress field's value.

func (*AwsDynamoDbTableRestoreSummary) SetSourceBackupArn

SetSourceBackupArn sets the SourceBackupArn field's value.

func (*AwsDynamoDbTableRestoreSummary) SetSourceTableArn

SetSourceTableArn sets the SourceTableArn field's value.

func (AwsDynamoDbTableRestoreSummary) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsDynamoDbTableSseDescription

type AwsDynamoDbTableSseDescription struct {

	// If the key is inaccessible, the date and time when DynamoDB detected that
	// the key was inaccessible.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	InaccessibleEncryptionDateTime *string `type:"string"`

	// The ARN of the KMS key that is used for the KMS encryption.
	KmsMasterKeyArn *string `type:"string"`

	// The type of server-side encryption.
	SseType *string `type:"string"`

	// The status of the server-side encryption.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the server-side encryption for the table.

func (AwsDynamoDbTableSseDescription) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsDynamoDbTableSseDescription) SetInaccessibleEncryptionDateTime

func (s *AwsDynamoDbTableSseDescription) SetInaccessibleEncryptionDateTime(v string) *AwsDynamoDbTableSseDescription

SetInaccessibleEncryptionDateTime sets the InaccessibleEncryptionDateTime field's value.

func (*AwsDynamoDbTableSseDescription) SetKmsMasterKeyArn

SetKmsMasterKeyArn sets the KmsMasterKeyArn field's value.

func (*AwsDynamoDbTableSseDescription) SetSseType

SetSseType sets the SseType field's value.

func (*AwsDynamoDbTableSseDescription) SetStatus

SetStatus sets the Status field's value.

func (AwsDynamoDbTableSseDescription) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsDynamoDbTableStreamSpecification

type AwsDynamoDbTableStreamSpecification struct {

	// Indicates whether DynamoDB Streams is enabled on the table.
	StreamEnabled *bool `type:"boolean"`

	// Determines the information that is written to the table.
	StreamViewType *string `type:"string"`
	// contains filtered or unexported fields
}

The current DynamoDB Streams configuration for the table.

func (AwsDynamoDbTableStreamSpecification) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsDynamoDbTableStreamSpecification) SetStreamEnabled

SetStreamEnabled sets the StreamEnabled field's value.

func (*AwsDynamoDbTableStreamSpecification) SetStreamViewType

SetStreamViewType sets the StreamViewType field's value.

func (AwsDynamoDbTableStreamSpecification) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2EipDetails

type AwsEc2EipDetails struct {

	// The identifier that Amazon Web Services assigns to represent the allocation
	// of the Elastic IP address for use with Amazon VPC.
	AllocationId *string `type:"string"`

	// The identifier that represents the association of the Elastic IP address
	// with an EC2 instance.
	AssociationId *string `type:"string"`

	// The domain in which to allocate the address.
	//
	// If the address is for use with EC2 instances in a VPC, then Domain is vpc.
	// Otherwise, Domain is standard.
	Domain *string `type:"string"`

	// The identifier of the EC2 instance.
	InstanceId *string `type:"string"`

	// The name of the location from which the Elastic IP address is advertised.
	NetworkBorderGroup *string `type:"string"`

	// The identifier of the network interface.
	NetworkInterfaceId *string `type:"string"`

	// The Amazon Web Services account ID of the owner of the network interface.
	NetworkInterfaceOwnerId *string `type:"string"`

	// The private IP address that is associated with the Elastic IP address.
	PrivateIpAddress *string `type:"string"`

	// A public IP address that is associated with the EC2 instance.
	PublicIp *string `type:"string"`

	// The identifier of an IP address pool. This parameter allows Amazon EC2 to
	// select an IP address from the address pool.
	PublicIpv4Pool *string `type:"string"`
	// contains filtered or unexported fields
}

Information about an Elastic IP address.

func (AwsEc2EipDetails) GoString

func (s AwsEc2EipDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2EipDetails) SetAllocationId

func (s *AwsEc2EipDetails) SetAllocationId(v string) *AwsEc2EipDetails

SetAllocationId sets the AllocationId field's value.

func (*AwsEc2EipDetails) SetAssociationId

func (s *AwsEc2EipDetails) SetAssociationId(v string) *AwsEc2EipDetails

SetAssociationId sets the AssociationId field's value.

func (*AwsEc2EipDetails) SetDomain

func (s *AwsEc2EipDetails) SetDomain(v string) *AwsEc2EipDetails

SetDomain sets the Domain field's value.

func (*AwsEc2EipDetails) SetInstanceId

func (s *AwsEc2EipDetails) SetInstanceId(v string) *AwsEc2EipDetails

SetInstanceId sets the InstanceId field's value.

func (*AwsEc2EipDetails) SetNetworkBorderGroup

func (s *AwsEc2EipDetails) SetNetworkBorderGroup(v string) *AwsEc2EipDetails

SetNetworkBorderGroup sets the NetworkBorderGroup field's value.

func (*AwsEc2EipDetails) SetNetworkInterfaceId

func (s *AwsEc2EipDetails) SetNetworkInterfaceId(v string) *AwsEc2EipDetails

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*AwsEc2EipDetails) SetNetworkInterfaceOwnerId

func (s *AwsEc2EipDetails) SetNetworkInterfaceOwnerId(v string) *AwsEc2EipDetails

SetNetworkInterfaceOwnerId sets the NetworkInterfaceOwnerId field's value.

func (*AwsEc2EipDetails) SetPrivateIpAddress

func (s *AwsEc2EipDetails) SetPrivateIpAddress(v string) *AwsEc2EipDetails

SetPrivateIpAddress sets the PrivateIpAddress field's value.

func (*AwsEc2EipDetails) SetPublicIp

func (s *AwsEc2EipDetails) SetPublicIp(v string) *AwsEc2EipDetails

SetPublicIp sets the PublicIp field's value.

func (*AwsEc2EipDetails) SetPublicIpv4Pool

func (s *AwsEc2EipDetails) SetPublicIpv4Pool(v string) *AwsEc2EipDetails

SetPublicIpv4Pool sets the PublicIpv4Pool field's value.

func (AwsEc2EipDetails) String

func (s AwsEc2EipDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2InstanceDetails

type AwsEc2InstanceDetails struct {

	// The IAM profile ARN of the instance.
	IamInstanceProfileArn *string `type:"string"`

	// The Amazon Machine Image (AMI) ID of the instance.
	ImageId *string `type:"string"`

	// The IPv4 addresses associated with the instance.
	IpV4Addresses []*string `type:"list"`

	// The IPv6 addresses associated with the instance.
	IpV6Addresses []*string `type:"list"`

	// The key name associated with the instance.
	KeyName *string `type:"string"`

	// Indicates when the instance was launched.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	LaunchedAt *string `type:"string"`

	// Details about the metadata options for the Amazon EC2 instance.
	MetadataOptions *AwsEc2InstanceMetadataOptions `type:"structure"`

	// Describes the type of monitoring that’s turned on for an instance.
	Monitoring *AwsEc2InstanceMonitoringDetails `type:"structure"`

	// The identifiers of the network interfaces for the EC2 instance. The details
	// for each network interface are in a corresponding AwsEc2NetworkInterfacesDetails
	// object.
	NetworkInterfaces []*AwsEc2InstanceNetworkInterfacesDetails `type:"list"`

	// The identifier of the subnet that the instance was launched in.
	SubnetId *string `type:"string"`

	// The instance type of the instance.
	Type *string `type:"string"`

	// The virtualization type of the Amazon Machine Image (AMI) required to launch
	// the instance.
	VirtualizationType *string `type:"string"`

	// The identifier of the VPC that the instance was launched in.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

The details of an Amazon EC2 instance.

func (AwsEc2InstanceDetails) GoString

func (s AwsEc2InstanceDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2InstanceDetails) SetIamInstanceProfileArn

func (s *AwsEc2InstanceDetails) SetIamInstanceProfileArn(v string) *AwsEc2InstanceDetails

SetIamInstanceProfileArn sets the IamInstanceProfileArn field's value.

func (*AwsEc2InstanceDetails) SetImageId

SetImageId sets the ImageId field's value.

func (*AwsEc2InstanceDetails) SetIpV4Addresses

func (s *AwsEc2InstanceDetails) SetIpV4Addresses(v []*string) *AwsEc2InstanceDetails

SetIpV4Addresses sets the IpV4Addresses field's value.

func (*AwsEc2InstanceDetails) SetIpV6Addresses

func (s *AwsEc2InstanceDetails) SetIpV6Addresses(v []*string) *AwsEc2InstanceDetails

SetIpV6Addresses sets the IpV6Addresses field's value.

func (*AwsEc2InstanceDetails) SetKeyName

SetKeyName sets the KeyName field's value.

func (*AwsEc2InstanceDetails) SetLaunchedAt

func (s *AwsEc2InstanceDetails) SetLaunchedAt(v string) *AwsEc2InstanceDetails

SetLaunchedAt sets the LaunchedAt field's value.

func (*AwsEc2InstanceDetails) SetMetadataOptions added in v1.42.9

SetMetadataOptions sets the MetadataOptions field's value.

func (*AwsEc2InstanceDetails) SetMonitoring added in v1.42.9

SetMonitoring sets the Monitoring field's value.

func (*AwsEc2InstanceDetails) SetNetworkInterfaces

SetNetworkInterfaces sets the NetworkInterfaces field's value.

func (*AwsEc2InstanceDetails) SetSubnetId

SetSubnetId sets the SubnetId field's value.

func (*AwsEc2InstanceDetails) SetType

SetType sets the Type field's value.

func (*AwsEc2InstanceDetails) SetVirtualizationType added in v1.42.9

func (s *AwsEc2InstanceDetails) SetVirtualizationType(v string) *AwsEc2InstanceDetails

SetVirtualizationType sets the VirtualizationType field's value.

func (*AwsEc2InstanceDetails) SetVpcId

SetVpcId sets the VpcId field's value.

func (AwsEc2InstanceDetails) String

func (s AwsEc2InstanceDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2InstanceMetadataOptions added in v1.42.9

type AwsEc2InstanceMetadataOptions struct {

	// Enables or disables the HTTP metadata endpoint on the instance.
	HttpEndpoint *string `type:"string"`

	// Enables or disables the IPv6 endpoint for the instance metadata service.
	HttpProtocolIpv6 *string `type:"string"`

	// The desired HTTP PUT response hop limit for instance metadata requests. The
	// larger the number, the further instance metadata requests can travel.
	HttpPutResponseHopLimit *int64 `type:"integer"`

	// The state of token usage for your instance metadata requests.
	HttpTokens *string `type:"string"`

	// Specifies whether to allow access to instance tags from the instance metadata.
	InstanceMetadataTags *string `type:"string"`
	// contains filtered or unexported fields
}

Metadata options that allow you to configure and secure the Amazon EC2 instance.

func (AwsEc2InstanceMetadataOptions) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2InstanceMetadataOptions) SetHttpEndpoint added in v1.42.9

SetHttpEndpoint sets the HttpEndpoint field's value.

func (*AwsEc2InstanceMetadataOptions) SetHttpProtocolIpv6 added in v1.42.9

SetHttpProtocolIpv6 sets the HttpProtocolIpv6 field's value.

func (*AwsEc2InstanceMetadataOptions) SetHttpPutResponseHopLimit added in v1.42.9

func (s *AwsEc2InstanceMetadataOptions) SetHttpPutResponseHopLimit(v int64) *AwsEc2InstanceMetadataOptions

SetHttpPutResponseHopLimit sets the HttpPutResponseHopLimit field's value.

func (*AwsEc2InstanceMetadataOptions) SetHttpTokens added in v1.42.9

SetHttpTokens sets the HttpTokens field's value.

func (*AwsEc2InstanceMetadataOptions) SetInstanceMetadataTags added in v1.42.9

SetInstanceMetadataTags sets the InstanceMetadataTags field's value.

func (AwsEc2InstanceMetadataOptions) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2InstanceMonitoringDetails added in v1.42.9

type AwsEc2InstanceMonitoringDetails struct {

	// Indicates whether detailed monitoring is turned on. Otherwise, basic monitoring
	// is turned on.
	State *string `type:"string"`
	// contains filtered or unexported fields
}

The type of monitoring that’s turned on for an Amazon EC2 instance.

func (AwsEc2InstanceMonitoringDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2InstanceMonitoringDetails) SetState added in v1.42.9

SetState sets the State field's value.

func (AwsEc2InstanceMonitoringDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2InstanceNetworkInterfacesDetails

type AwsEc2InstanceNetworkInterfacesDetails struct {

	// The identifier of the network interface. The details are in a corresponding
	// AwsEc2NetworkInterfacesDetails object.
	NetworkInterfaceId *string `type:"string"`
	// contains filtered or unexported fields
}

Identifies a network interface for the Amazon EC2 instance.

func (AwsEc2InstanceNetworkInterfacesDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2InstanceNetworkInterfacesDetails) SetNetworkInterfaceId

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (AwsEc2InstanceNetworkInterfacesDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails added in v1.42.9

type AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails struct {

	// The device name.
	DeviceName *string `type:"string"`

	// Parameters used to automatically set up Amazon EBS volumes when the instance
	// is launched.
	Ebs *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails `type:"structure"`

	// Omits the device from the block device mapping when an empty string is specified.
	NoDevice *string `type:"string"`

	// The virtual device name (ephemeralN). Instance store volumes are numbered
	// starting from 0. An instance type with 2 available instance store volumes
	// can specify mappings for ephemeral0 and ephemeral1. The number of available
	// instance store volumes depends on the instance type.
	VirtualName *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a block device mapping for an Amazon Elastic Compute Cloud (Amazon EC2) launch template.

func (AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails) SetDeviceName added in v1.42.9

SetDeviceName sets the DeviceName field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails) SetEbs added in v1.42.9

SetEbs sets the Ebs field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails) SetNoDevice added in v1.42.9

SetNoDevice sets the NoDevice field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails) SetVirtualName added in v1.42.9

SetVirtualName sets the VirtualName field's value.

func (AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails added in v1.42.9

type AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails struct {

	// Indicates whether the EBS volume is deleted on instance termination.
	DeleteOnTermination *bool `type:"boolean"`

	// Indicates whether the EBS volume is encrypted. Encrypted volumes can only
	// be attached to instances that support Amazon EBS encryption. If you're creating
	// a volume from a snapshot, you can't specify an encryption value.
	Encrypted *bool `type:"boolean"`

	// The number of I/O operations per second (IOPS).
	Iops *int64 `type:"integer"`

	// The Amazon Resource Name (ARN) of the symmetric Key Management Service (KMS)
	// customer managed key used for encryption.
	KmsKeyId *string `type:"string"`

	// The ID of the EBS snapshot.
	SnapshotId *string `type:"string"`

	// The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
	Throughput *int64 `type:"integer"`

	// The size of the volume, in GiBs. You must specify either a snapshot ID or
	// a volume size.
	VolumeSize *int64 `type:"integer"`

	// The volume type.
	VolumeType *string `type:"string"`
	// contains filtered or unexported fields
}

Parameters for a block device for an Amazon Elastic Block Store (Amazon EBS) volume in an Amazon EC2 launch template.

func (AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetDeleteOnTermination added in v1.42.9

SetDeleteOnTermination sets the DeleteOnTermination field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetEncrypted added in v1.42.9

SetEncrypted sets the Encrypted field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetIops added in v1.42.9

SetIops sets the Iops field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetKmsKeyId added in v1.42.9

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetSnapshotId added in v1.42.9

SetSnapshotId sets the SnapshotId field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetThroughput added in v1.42.9

SetThroughput sets the Throughput field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetVolumeSize added in v1.42.9

SetVolumeSize sets the VolumeSize field's value.

func (*AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) SetVolumeType added in v1.42.9

SetVolumeType sets the VolumeType field's value.

func (AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails added in v1.42.9

type AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails struct {

	// The ID of the Capacity Reservation in which to run the instance.
	CapacityReservationId *string `type:"string"`

	// The Amazon Resource Name (ARN) of the Capacity Reservation resource group
	// in which to run the instance.
	CapacityReservationResourceGroupArn *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the target Capacity Reservation or Capacity Reservation group in which to run an Amazon EC2 instance.

func (AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails) SetCapacityReservationId added in v1.42.9

SetCapacityReservationId sets the CapacityReservationId field's value.

func (*AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails) SetCapacityReservationResourceGroupArn added in v1.42.9

SetCapacityReservationResourceGroupArn sets the CapacityReservationResourceGroupArn field's value.

func (AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails added in v1.42.9

type AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails struct {

	// Indicates the instance's Capacity Reservation preferences. If equal to open,
	// the instance can run in any open Capacity Reservation that has matching attributes
	// (instance type, platform, Availability Zone). If equal to none, the instance
	// avoids running in a Capacity Reservation even if one is available. The instance
	// runs in On-Demand capacity.
	CapacityReservationPreference *string `type:"string"`

	// Specifies a target Capacity Reservation.
	CapacityReservationTarget *AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the Capacity Reservation targeting option of an Amazon EC2 instance.

func (AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails) SetCapacityReservationPreference added in v1.42.9

SetCapacityReservationPreference sets the CapacityReservationPreference field's value.

func (*AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails) SetCapacityReservationTarget added in v1.42.9

SetCapacityReservationTarget sets the CapacityReservationTarget field's value.

func (AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataCpuOptionsDetails added in v1.42.9

type AwsEc2LaunchTemplateDataCpuOptionsDetails struct {

	// The number of CPU cores for the instance.
	CoreCount *int64 `type:"integer"`

	// The number of threads per CPU core. A value of 1 disables multithreading
	// for the instance, The default value is 2.
	ThreadsPerCore *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies the CPU options for an Amazon EC2 instance. For more information, see Optimize CPU options (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the Amazon Elastic Compute Cloud User Guide.

func (AwsEc2LaunchTemplateDataCpuOptionsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataCpuOptionsDetails) SetCoreCount added in v1.42.9

SetCoreCount sets the CoreCount field's value.

func (*AwsEc2LaunchTemplateDataCpuOptionsDetails) SetThreadsPerCore added in v1.42.9

SetThreadsPerCore sets the ThreadsPerCore field's value.

func (AwsEc2LaunchTemplateDataCpuOptionsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataCreditSpecificationDetails added in v1.42.9

type AwsEc2LaunchTemplateDataCreditSpecificationDetails struct {

	// The credit option for CPU usage of a T instance.
	CpuCredits *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the credit option for CPU usage of a T2, T3, or T3a Amazon EC2 instance.

func (AwsEc2LaunchTemplateDataCreditSpecificationDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataCreditSpecificationDetails) SetCpuCredits added in v1.42.9

SetCpuCredits sets the CpuCredits field's value.

func (AwsEc2LaunchTemplateDataCreditSpecificationDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataDetails added in v1.42.9

type AwsEc2LaunchTemplateDataDetails struct {

	// Information about a block device mapping for an Amazon EC2 launch template.
	BlockDeviceMappingSet []*AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails `type:"list"`

	// Specifies an instance's Capacity Reservation targeting option. You can specify
	// only one option at a time.
	CapacityReservationSpecification *AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails `type:"structure"`

	// Specifies the CPU options for an instance. For more information, see Optimize
	// CPU options (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html)
	// in the Amazon Elastic Compute Cloud User Guide.
	CpuOptions *AwsEc2LaunchTemplateDataCpuOptionsDetails `type:"structure"`

	// Specifies the credit option for CPU usage of a T2, T3, or T3a instance.
	CreditSpecification *AwsEc2LaunchTemplateDataCreditSpecificationDetails `type:"structure"`

	// Indicates whether to enable the instance for stop protection. For more information,
	// see Enable stop protection (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection)
	// in the Amazon EC2 User Guide.
	DisableApiStop *bool `type:"boolean"`

	// If you set this parameter to true, you can't terminate the instance using
	// the Amazon EC2 console, CLI, or API. If set to true, you can.
	DisableApiTermination *bool `type:"boolean"`

	// Indicates whether the instance is optimized for Amazon EBS I/O.
	EbsOptimized *bool `type:"boolean"`

	// Provides details about Elastic Graphics accelerators to associate with the
	// instance.
	ElasticGpuSpecificationSet []*AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails `type:"list"`

	// The Amazon Elastic Inference accelerator for the instance.
	ElasticInferenceAcceleratorSet []*AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails `type:"list"`

	// Indicates whether the Amazon EC2 instance is enabled for Amazon Web Services
	// Nitro Enclaves.
	EnclaveOptions *AwsEc2LaunchTemplateDataEnclaveOptionsDetails `type:"structure"`

	// Specifies whether your Amazon EC2 instance is configured for hibernation.
	HibernationOptions *AwsEc2LaunchTemplateDataHibernationOptionsDetails `type:"structure"`

	// The name or Amazon Resource Name (ARN) of an IAM instance profile.
	IamInstanceProfile *AwsEc2LaunchTemplateDataIamInstanceProfileDetails `type:"structure"`

	// The ID of the Amazon Machine Image (AMI).
	ImageId *string `type:"string"`

	// Provides the options for specifying the instance initiated shutdown behavior.
	InstanceInitiatedShutdownBehavior *string `type:"string"`

	// Specifies the market (purchasing) option for an instance.
	InstanceMarketOptions *AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails `type:"structure"`

	// The attributes for the instance types. When you specify instance attributes,
	// Amazon EC2 will identify instance types with these attributes. If you specify
	// InstanceRequirements, you can't specify InstanceType.
	InstanceRequirements *AwsEc2LaunchTemplateDataInstanceRequirementsDetails `type:"structure"`

	// The instance type. For more information, see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html)
	// in the Amazon EC2 User Guide. If you specify InstanceType, you can't specify
	// InstanceRequirements.
	InstanceType *string `type:"string"`

	// The ID of the kernel.
	KernelId *string `type:"string"`

	// The name of the key pair that allows users to connect to the instance.
	KeyName *string `type:"string"`

	// Specifies a license configuration for an instance.
	LicenseSet []*AwsEc2LaunchTemplateDataLicenseSetDetails `type:"list"`

	// The maintenance options of your instance.
	MaintenanceOptions *AwsEc2LaunchTemplateDataMaintenanceOptionsDetails `type:"structure"`

	// The metadata options for the instance. For more information, see Instance
	// metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html)
	// in the Amazon EC2 User Guide.
	MetadataOptions *AwsEc2LaunchTemplateDataMetadataOptionsDetails `type:"structure"`

	// The monitoring for the instance.
	Monitoring *AwsEc2LaunchTemplateDataMonitoringDetails `type:"structure"`

	// Specifies the parameters for a network interface that is attached to the
	// instance.
	NetworkInterfaceSet []*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails `type:"list"`

	// Specifies the placement of an instance.
	Placement *AwsEc2LaunchTemplateDataPlacementDetails `type:"structure"`

	// The options for the instance hostname.
	PrivateDnsNameOptions *AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails `type:"structure"`

	// The ID of the RAM disk.
	RamDiskId *string `type:"string"`

	// One or more security group IDs.
	SecurityGroupIdSet []*string `type:"list"`

	// One or more security group names. For a nondefault VPC, you must use security
	// group IDs instead. You cannot specify both a security group ID and security
	// name in the same request.
	SecurityGroupSet []*string `type:"list"`

	// The user data to make available to the instance.
	UserData *string `type:"string"`
	// contains filtered or unexported fields
}

The information to include in an Amazon Elastic Compute Cloud (Amazon EC2) launch template.

func (AwsEc2LaunchTemplateDataDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataDetails) SetBlockDeviceMappingSet added in v1.42.9

SetBlockDeviceMappingSet sets the BlockDeviceMappingSet field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetCapacityReservationSpecification added in v1.42.9

SetCapacityReservationSpecification sets the CapacityReservationSpecification field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetCpuOptions added in v1.42.9

SetCpuOptions sets the CpuOptions field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetCreditSpecification added in v1.42.9

SetCreditSpecification sets the CreditSpecification field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetDisableApiStop added in v1.42.9

SetDisableApiStop sets the DisableApiStop field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetDisableApiTermination added in v1.42.9

SetDisableApiTermination sets the DisableApiTermination field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetEbsOptimized added in v1.42.9

SetEbsOptimized sets the EbsOptimized field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetElasticGpuSpecificationSet added in v1.42.9

SetElasticGpuSpecificationSet sets the ElasticGpuSpecificationSet field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetElasticInferenceAcceleratorSet added in v1.42.9

SetElasticInferenceAcceleratorSet sets the ElasticInferenceAcceleratorSet field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetEnclaveOptions added in v1.42.9

SetEnclaveOptions sets the EnclaveOptions field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetHibernationOptions added in v1.42.9

SetHibernationOptions sets the HibernationOptions field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetIamInstanceProfile added in v1.42.9

SetIamInstanceProfile sets the IamInstanceProfile field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetImageId added in v1.42.9

SetImageId sets the ImageId field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetInstanceInitiatedShutdownBehavior added in v1.42.9

func (s *AwsEc2LaunchTemplateDataDetails) SetInstanceInitiatedShutdownBehavior(v string) *AwsEc2LaunchTemplateDataDetails

SetInstanceInitiatedShutdownBehavior sets the InstanceInitiatedShutdownBehavior field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetInstanceMarketOptions added in v1.42.9

SetInstanceMarketOptions sets the InstanceMarketOptions field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetInstanceRequirements added in v1.42.9

SetInstanceRequirements sets the InstanceRequirements field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetInstanceType added in v1.42.9

SetInstanceType sets the InstanceType field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetKernelId added in v1.42.9

SetKernelId sets the KernelId field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetKeyName added in v1.42.9

SetKeyName sets the KeyName field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetLicenseSet added in v1.42.9

SetLicenseSet sets the LicenseSet field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetMaintenanceOptions added in v1.42.9

SetMaintenanceOptions sets the MaintenanceOptions field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetMetadataOptions added in v1.42.9

SetMetadataOptions sets the MetadataOptions field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetMonitoring added in v1.42.9

SetMonitoring sets the Monitoring field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetNetworkInterfaceSet added in v1.42.9

SetNetworkInterfaceSet sets the NetworkInterfaceSet field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetPlacement added in v1.42.9

SetPlacement sets the Placement field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetPrivateDnsNameOptions added in v1.42.9

SetPrivateDnsNameOptions sets the PrivateDnsNameOptions field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetRamDiskId added in v1.42.9

SetRamDiskId sets the RamDiskId field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetSecurityGroupIdSet added in v1.42.9

SetSecurityGroupIdSet sets the SecurityGroupIdSet field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetSecurityGroupSet added in v1.42.9

SetSecurityGroupSet sets the SecurityGroupSet field's value.

func (*AwsEc2LaunchTemplateDataDetails) SetUserData added in v1.42.9

SetUserData sets the UserData field's value.

func (AwsEc2LaunchTemplateDataDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails added in v1.42.9

type AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails struct {

	// The type of Elastic Graphics accelerator.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about an Elastic Graphics specification for an Amazon EC2 launch template.

func (AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails) SetType added in v1.42.9

SetType sets the Type field's value.

func (AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails added in v1.42.9

type AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails struct {

	// The number of Elastic Inference accelerators to attach to the instance.
	Count *int64 `type:"integer"`

	// The type of Elastic Inference accelerator.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details for an Amazon Elastic Inference accelerator.

func (AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails) SetCount added in v1.42.9

SetCount sets the Count field's value.

func (*AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails) SetType added in v1.42.9

SetType sets the Type field's value.

func (AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataEnclaveOptionsDetails added in v1.42.9

type AwsEc2LaunchTemplateDataEnclaveOptionsDetails struct {

	// If this parameter is set to true, the instance is enabled for Amazon Web
	// Services Nitro Enclaves.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

func (AwsEc2LaunchTemplateDataEnclaveOptionsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataEnclaveOptionsDetails) SetEnabled added in v1.42.9

SetEnabled sets the Enabled field's value.

func (AwsEc2LaunchTemplateDataEnclaveOptionsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataHibernationOptionsDetails added in v1.42.9

type AwsEc2LaunchTemplateDataHibernationOptionsDetails struct {

	// If you set this parameter to true, the instance is enabled for hibernation.
	Configured *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Specifies whether your Amazon EC2 instance is configured for hibernation.

func (AwsEc2LaunchTemplateDataHibernationOptionsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataHibernationOptionsDetails) SetConfigured added in v1.42.9

SetConfigured sets the Configured field's value.

func (AwsEc2LaunchTemplateDataHibernationOptionsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataIamInstanceProfileDetails added in v1.42.9

type AwsEc2LaunchTemplateDataIamInstanceProfileDetails struct {

	// The Amazon Resource Name (ARN) of the instance profile.
	Arn *string `type:"string"`

	// The name of the instance profile.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details for an Identity and Access Management (IAM) instance profile, which is a container for an IAM role for your instance.

func (AwsEc2LaunchTemplateDataIamInstanceProfileDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataIamInstanceProfileDetails) SetArn added in v1.42.9

SetArn sets the Arn field's value.

func (*AwsEc2LaunchTemplateDataIamInstanceProfileDetails) SetName added in v1.42.9

SetName sets the Name field's value.

func (AwsEc2LaunchTemplateDataIamInstanceProfileDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails added in v1.42.9

type AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails struct {

	// The market type.
	MarketType *string `type:"string"`

	// The options for Spot Instances.
	SpotOptions *AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails `type:"structure"`
	// contains filtered or unexported fields
}

Provides details about the market (purchasing) option for an Amazon EC2 instance.

func (AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails) SetMarketType added in v1.42.9

SetMarketType sets the MarketType field's value.

func (*AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails) SetSpotOptions added in v1.42.9

SetSpotOptions sets the SpotOptions field's value.

func (AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails added in v1.42.9

type AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails struct {

	// Deprecated.
	BlockDurationMinutes *int64 `type:"integer"`

	// The behavior when a Spot Instance is interrupted.
	InstanceInterruptionBehavior *string `type:"string"`

	// The maximum hourly price you're willing to pay for the Spot Instances.
	MaxPrice *string `type:"string"`

	// The Spot Instance request type.
	SpotInstanceType *string `type:"string"`

	// The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ), for persistent
	// requests.
	ValidUntil *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the market (purchasing) options for Spot Instances.

func (AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) SetBlockDurationMinutes added in v1.42.9

SetBlockDurationMinutes sets the BlockDurationMinutes field's value.

func (*AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) SetInstanceInterruptionBehavior added in v1.42.9

SetInstanceInterruptionBehavior sets the InstanceInterruptionBehavior field's value.

func (*AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) SetMaxPrice added in v1.42.9

SetMaxPrice sets the MaxPrice field's value.

func (*AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) SetSpotInstanceType added in v1.42.9

SetSpotInstanceType sets the SpotInstanceType field's value.

func (*AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) SetValidUntil added in v1.42.9

SetValidUntil sets the ValidUntil field's value.

func (AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails added in v1.42.9

type AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails struct {

	// The maximum number of accelerators. If this parameter isn't specified, there's
	// no maximum limit. To exclude accelerator-enabled instance types, set Max
	// to 0.
	Max *int64 `type:"integer"`

	// The minimum number of accelerators. If this parameter isn't specified, there's
	// no minimum limit.
	Min *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an Amazon EC2 instance.

func (AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails) SetMax added in v1.42.9

SetMax sets the Max field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails) SetMin added in v1.42.9

SetMin sets the Min field's value.

func (AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails added in v1.42.9

type AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails struct {

	// The maximum amount of memory, in MiB. If this parameter isn't specified,
	// there's no maximum limit.
	Max *int64 `type:"integer"`

	// The minimum amount of memory, in MiB. If 0 is specified, there's no maximum
	// limit.
	Min *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The minimum and maximum amount of memory, in MiB, for the accelerators on an Amazon EC2 instance.

func (AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails) SetMax added in v1.42.9

SetMax sets the Max field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails) SetMin added in v1.42.9

SetMin sets the Min field's value.

func (AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails added in v1.42.9

type AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails struct {

	// The maximum baseline bandwidth, in Mbps. If this parameter is omitted, there's
	// no maximum limit.
	Max *int64 `type:"integer"`

	// The minimum baseline bandwidth, in Mbps. If this parameter is omitted, there's
	// no minimum limit.
	Min *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The minimum and maximum baseline bandwidth to Amazon Elastic Block Store (Amazon EBS), in Mbps. For more information, see Amazon EBS–optimized instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the Amazon EC2 User Guide.

func (AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails) SetMax added in v1.42.9

SetMax sets the Max field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails) SetMin added in v1.42.9

SetMin sets the Min field's value.

func (AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataInstanceRequirementsDetails added in v1.42.9

type AwsEc2LaunchTemplateDataInstanceRequirementsDetails struct {

	// The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web
	// Services Inferentia chips) on an instance.
	AcceleratorCount *AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails `type:"structure"`

	// Indicates whether instance types must have accelerators by specific manufacturers.
	AcceleratorManufacturers []*string `type:"list"`

	// The accelerators that must be on the instance type.
	AcceleratorNames []*string `type:"list"`

	// The minimum and maximum amount of total accelerator memory, in MiB.
	AcceleratorTotalMemoryMiB *AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails `type:"structure"`

	// The accelerator types that must be on the instance type.
	AcceleratorTypes []*string `type:"list"`

	// Indicates whether bare metal instance types must be included, excluded, or
	// required.
	BareMetal *string `type:"string"`

	// The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more
	// information, see Amazon EBS optimized instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html)
	// in the Amazon EC2 User Guide.
	BaselineEbsBandwidthMbps *AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails `type:"structure"`

	// Indicates whether burstable performance T instance types are included, excluded,
	// or required. For more information, Burstable performance instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html)
	// in the Amazon EC2 User Guide.
	BurstablePerformance *string `type:"string"`

	// The CPU manufacturers to include.
	CpuManufacturers []*string `type:"list"`

	// The instance types to exclude.
	ExcludedInstanceTypes []*string `type:"list"`

	// Indicates whether current or previous generation instance types are included.
	InstanceGenerations []*string `type:"list"`

	// Indicates whether instance types with instance store volumes are included,
	// excluded, or required. For more information, see Amazon EC2 instance store
	// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html)
	// in the Amazon EC2 User Guide.
	LocalStorage *string `type:"string"`

	// The type of local storage that is required.
	LocalStorageTypes []*string `type:"list"`

	// The minimum and maximum amount of memory per vCPU, in GiB.
	MemoryGiBPerVCpu *AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails `type:"structure"`

	// The minimum and maximum amount of memory, in MiB.
	MemoryMiB *AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails `type:"structure"`

	// The minimum and maximum number of network interfaces.
	NetworkInterfaceCount *AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails `type:"structure"`

	// The price protection threshold for On-Demand Instances. This is the maximum
	// you'll pay for an On-Demand Instance, expressed as a percentage above the
	// least expensive current generation M, C, or R instance type with your specified
	// attributes. When Amazon EC2 selects instance types with your attributes,
	// it excludes instance types priced above your threshold.
	//
	// The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
	//
	// A high value, such as 999999, turns off price protection.
	OnDemandMaxPricePercentageOverLowestPrice *int64 `type:"integer"`

	// Indicates whether instance types must support hibernation for On-Demand Instances.
	RequireHibernateSupport *bool `type:"boolean"`

	// The price protection threshold for Spot Instances. This is the maximum you'll
	// pay for a Spot Instance, expressed as a percentage above the least expensive
	// current generation M, C, or R instance type with your specified attributes.
	// When Amazon EC2 selects instance types with your attributes, it excludes
	// instance types priced above your threshold.
	//
	// The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
	//
	// A high value, such as 999999, turns off price protection.
	SpotMaxPricePercentageOverLowestPrice *int64 `type:"integer"`

	// The minimum and maximum amount of total local storage, in GB.
	TotalLocalStorageGB *AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails `type:"structure"`

	// The minimum and maximum number of vCPUs.
	VCpuCount *AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails `type:"structure"`
	// contains filtered or unexported fields
}

The attributes for the Amazon EC2 instance types.

func (AwsEc2LaunchTemplateDataInstanceRequirementsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetAcceleratorCount added in v1.42.9

SetAcceleratorCount sets the AcceleratorCount field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetAcceleratorManufacturers added in v1.42.9

SetAcceleratorManufacturers sets the AcceleratorManufacturers field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetAcceleratorNames added in v1.42.9

SetAcceleratorNames sets the AcceleratorNames field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetAcceleratorTotalMemoryMiB added in v1.42.9

SetAcceleratorTotalMemoryMiB sets the AcceleratorTotalMemoryMiB field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetAcceleratorTypes added in v1.42.9

SetAcceleratorTypes sets the AcceleratorTypes field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetBareMetal added in v1.42.9

SetBareMetal sets the BareMetal field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetBaselineEbsBandwidthMbps added in v1.42.9

SetBaselineEbsBandwidthMbps sets the BaselineEbsBandwidthMbps field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetBurstablePerformance added in v1.42.9

SetBurstablePerformance sets the BurstablePerformance field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetCpuManufacturers added in v1.42.9

SetCpuManufacturers sets the CpuManufacturers field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetExcludedInstanceTypes added in v1.42.9

SetExcludedInstanceTypes sets the ExcludedInstanceTypes field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetInstanceGenerations added in v1.42.9

SetInstanceGenerations sets the InstanceGenerations field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetLocalStorage added in v1.42.9

SetLocalStorage sets the LocalStorage field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetLocalStorageTypes added in v1.42.9

SetLocalStorageTypes sets the LocalStorageTypes field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetMemoryGiBPerVCpu added in v1.42.9

SetMemoryGiBPerVCpu sets the MemoryGiBPerVCpu field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetMemoryMiB added in v1.42.9

SetMemoryMiB sets the MemoryMiB field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetNetworkInterfaceCount added in v1.42.9

SetNetworkInterfaceCount sets the NetworkInterfaceCount field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetOnDemandMaxPricePercentageOverLowestPrice added in v1.42.9

SetOnDemandMaxPricePercentageOverLowestPrice sets the OnDemandMaxPricePercentageOverLowestPrice field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetRequireHibernateSupport added in v1.42.9

SetRequireHibernateSupport sets the RequireHibernateSupport field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetSpotMaxPricePercentageOverLowestPrice added in v1.42.9

SetSpotMaxPricePercentageOverLowestPrice sets the SpotMaxPricePercentageOverLowestPrice field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetTotalLocalStorageGB added in v1.42.9

SetTotalLocalStorageGB sets the TotalLocalStorageGB field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsDetails) SetVCpuCount added in v1.42.9

SetVCpuCount sets the VCpuCount field's value.

func (AwsEc2LaunchTemplateDataInstanceRequirementsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails added in v1.42.9

type AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails struct {

	// The maximum amount of memory per vCPU, in GiB. If this parameter is omitted,
	// there's no maximum limit.
	Max *float64 `type:"double"`

	// The minimum amount of memory per vCPU, in GiB. If this parameter is omitted,
	// there's no maximum limit.
	Min *float64 `type:"double"`
	// contains filtered or unexported fields
}

The minimum and maximum amount of memory per vCPU, in GiB.

func (AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails) SetMax added in v1.42.9

SetMax sets the Max field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails) SetMin added in v1.42.9

SetMin sets the Min field's value.

func (AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails added in v1.42.9

type AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails struct {

	// The maximum amount of memory, in MiB.
	Max *int64 `type:"integer"`

	// The minimum amount of memory, in MiB.
	Min *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The minimum and maximum amount of memory, in MiB, for an Amazon EC2 instance.

func (AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails) SetMax added in v1.42.9

SetMax sets the Max field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails) SetMin added in v1.42.9

SetMin sets the Min field's value.

func (AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails added in v1.42.9

type AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails struct {

	// The maximum number of network interfaces.
	Max *int64 `type:"integer"`

	// The minimum number of network interfaces.
	Min *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The minimum and maximum number of network interfaces to be attached to an Amazon EC2 instance.

func (AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails) SetMax added in v1.42.9

SetMax sets the Max field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails) SetMin added in v1.42.9

SetMin sets the Min field's value.

func (AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails added in v1.42.9

type AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails struct {

	// The maximum amount of total local storage, in GB.
	Max *float64 `type:"double"`

	// The minimum amount of total local storage, in GB.
	Min *float64 `type:"double"`
	// contains filtered or unexported fields
}

The minimum and maximum amount of total local storage, in GB, that an Amazon EC2 instance uses.

func (AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails) SetMax added in v1.42.9

SetMax sets the Max field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails) SetMin added in v1.42.9

SetMin sets the Min field's value.

func (AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails added in v1.42.9

type AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails struct {

	// The maximum number of vCPUs.
	Max *int64 `type:"integer"`

	// The minimum number of vCPUs.
	Min *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The minimum and maximum number of vCPUs for an Amazon EC2 instance.

func (AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails) SetMax added in v1.42.9

SetMax sets the Max field's value.

func (*AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails) SetMin added in v1.42.9

SetMin sets the Min field's value.

func (AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataLicenseSetDetails added in v1.42.9

type AwsEc2LaunchTemplateDataLicenseSetDetails struct {

	// The Amazon Resource Name (ARN) of the license configuration.
	LicenseConfigurationArn *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the license configuration for an Amazon EC2 instance.

func (AwsEc2LaunchTemplateDataLicenseSetDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataLicenseSetDetails) SetLicenseConfigurationArn added in v1.42.9

SetLicenseConfigurationArn sets the LicenseConfigurationArn field's value.

func (AwsEc2LaunchTemplateDataLicenseSetDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataMaintenanceOptionsDetails added in v1.42.9

type AwsEc2LaunchTemplateDataMaintenanceOptionsDetails struct {

	// Disables the automatic recovery behavior of your instance or sets it to default.
	AutoRecovery *string `type:"string"`
	// contains filtered or unexported fields
}

The maintenance options of an Amazon EC2 instance.

func (AwsEc2LaunchTemplateDataMaintenanceOptionsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataMaintenanceOptionsDetails) SetAutoRecovery added in v1.42.9

SetAutoRecovery sets the AutoRecovery field's value.

func (AwsEc2LaunchTemplateDataMaintenanceOptionsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataMetadataOptionsDetails added in v1.42.9

type AwsEc2LaunchTemplateDataMetadataOptionsDetails struct {

	// Enables or disables the HTTP metadata endpoint on your instances. If the
	// parameter is not specified, the default state is enabled, and you won't be
	// able to access your instance metadata.
	HttpEndpoint *string `type:"string"`

	// Enables or disables the IPv6 endpoint for the instance metadata service.
	HttpProtocolIpv6 *string `type:"string"`

	// The desired HTTP PUT response hop limit for instance metadata requests. The
	// larger the number, the further instance metadata requests can travel.
	HttpPutResponseHopLimit *int64 `type:"integer"`

	// The state of token usage for your instance metadata requests.
	HttpTokens *string `type:"string"`

	// When set to enabled, this parameter allows access to instance tags from the
	// instance metadata. When set to disabled, it turns off access to instance
	// tags from the instance metadata. For more information, see Work with instance
	// tags in instance metadata (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS)
	// in the Amazon EC2 User Guide.
	InstanceMetadataTags *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the metadata options for an Amazon EC2 instance.

func (AwsEc2LaunchTemplateDataMetadataOptionsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataMetadataOptionsDetails) SetHttpEndpoint added in v1.42.9

SetHttpEndpoint sets the HttpEndpoint field's value.

func (*AwsEc2LaunchTemplateDataMetadataOptionsDetails) SetHttpProtocolIpv6 added in v1.42.9

SetHttpProtocolIpv6 sets the HttpProtocolIpv6 field's value.

func (*AwsEc2LaunchTemplateDataMetadataOptionsDetails) SetHttpPutResponseHopLimit added in v1.42.9

SetHttpPutResponseHopLimit sets the HttpPutResponseHopLimit field's value.

func (*AwsEc2LaunchTemplateDataMetadataOptionsDetails) SetHttpTokens added in v1.42.9

SetHttpTokens sets the HttpTokens field's value.

func (*AwsEc2LaunchTemplateDataMetadataOptionsDetails) SetInstanceMetadataTags added in v1.42.9

SetInstanceMetadataTags sets the InstanceMetadataTags field's value.

func (AwsEc2LaunchTemplateDataMetadataOptionsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataMonitoringDetails added in v1.42.9

type AwsEc2LaunchTemplateDataMonitoringDetails struct {

	// Enables detailed monitoring when true is specified. Otherwise, basic monitoring
	// is enabled. For more information about detailed monitoring, see Enable or
	// turn off detailed monitoring for your instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html)
	// in the Amazon EC2 User Guide.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The monitoring for an Amazon EC2 instance.

func (AwsEc2LaunchTemplateDataMonitoringDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataMonitoringDetails) SetEnabled added in v1.42.9

SetEnabled sets the Enabled field's value.

func (AwsEc2LaunchTemplateDataMonitoringDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails added in v1.42.9

type AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails struct {

	// Indicates whether to associate a Carrier IP address with eth0 for a new network
	// interface. You use this option when you launch an instance in a Wavelength
	// Zone and want to associate a Carrier IP address with the network interface.
	// For more information, see Carrier IP address (https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip)
	// in the Wavelength Developer Guide.
	AssociateCarrierIpAddress *bool `type:"boolean"`

	// Associates a public IPv4 address with eth0 for a new network interface.
	AssociatePublicIpAddress *bool `type:"boolean"`

	// Indicates whether the network interface is deleted when the instance is terminated.
	DeleteOnTermination *bool `type:"boolean"`

	// A description for the network interface.
	Description *string `type:"string"`

	// The device index for the network interface attachment.
	DeviceIndex *int64 `type:"integer"`

	// The IDs of one or more security groups.
	Groups []*string `type:"list"`

	// The type of network interface.
	InterfaceType *string `type:"string"`

	// The number of IPv4 prefixes to be automatically assigned to the network interface.
	// You cannot use this option if you use the Ipv4Prefixes option.
	Ipv4PrefixCount *int64 `type:"integer"`

	// One or more IPv4 prefixes to be assigned to the network interface. You cannot
	// use this option if you use the Ipv4PrefixCount option.
	Ipv4Prefixes []*AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails `type:"list"`

	// The number of IPv6 addresses to assign to a network interface. Amazon EC2
	// automatically selects the IPv6 addresses from the subnet range. You can't
	// use this option if you use Ipv6Addresses.
	Ipv6AddressCount *int64 `type:"integer"`

	// One or more specific IPv6 addresses from the IPv6 CIDR block range of your
	// subnet. You can't use this option if you use Ipv6AddressCount.
	Ipv6Addresses []*AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails `type:"list"`

	// The number of IPv6 prefixes to be automatically assigned to the network interface.
	// You cannot use this option if you use the Ipv6Prefix option.
	Ipv6PrefixCount *int64 `type:"integer"`

	// One or more IPv6 prefixes to be assigned to the network interface. You cannot
	// use this option if you use the Ipv6PrefixCount option.
	Ipv6Prefixes []*AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails `type:"list"`

	// The index of the network card. Some instance types support multiple network
	// cards. The primary network interface must be assigned to network card index
	// 0. The default is network card index 0.
	NetworkCardIndex *int64 `type:"integer"`

	// The ID of the network interface.
	NetworkInterfaceId *string `type:"string"`

	// The primary private IPv4 address of the network interface.
	PrivateIpAddress *string `type:"string"`

	// One or more private IPv4 addresses.
	PrivateIpAddresses []*AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails `type:"list"`

	// The number of secondary private IPv4 addresses to assign to a network interface.
	SecondaryPrivateIpAddressCount *int64 `type:"integer"`

	// The ID of the subnet for the network interface.
	SubnetId *string `type:"string"`
	// contains filtered or unexported fields
}

One or more network interfaces to attach to an Amazon EC2 instance. If you specify a network interface, you must specify security groups and subnets as part of the network interface.

func (AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetAssociateCarrierIpAddress added in v1.42.9

SetAssociateCarrierIpAddress sets the AssociateCarrierIpAddress field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetAssociatePublicIpAddress added in v1.42.9

SetAssociatePublicIpAddress sets the AssociatePublicIpAddress field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetDeleteOnTermination added in v1.42.9

SetDeleteOnTermination sets the DeleteOnTermination field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetDeviceIndex added in v1.42.9

SetDeviceIndex sets the DeviceIndex field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetGroups added in v1.42.9

SetGroups sets the Groups field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetInterfaceType added in v1.42.9

SetInterfaceType sets the InterfaceType field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetIpv4PrefixCount added in v1.42.9

SetIpv4PrefixCount sets the Ipv4PrefixCount field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetIpv4Prefixes added in v1.42.9

SetIpv4Prefixes sets the Ipv4Prefixes field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetIpv6AddressCount added in v1.42.9

SetIpv6AddressCount sets the Ipv6AddressCount field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetIpv6Addresses added in v1.42.9

SetIpv6Addresses sets the Ipv6Addresses field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetIpv6PrefixCount added in v1.42.9

SetIpv6PrefixCount sets the Ipv6PrefixCount field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetIpv6Prefixes added in v1.42.9

SetIpv6Prefixes sets the Ipv6Prefixes field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetNetworkCardIndex added in v1.42.9

SetNetworkCardIndex sets the NetworkCardIndex field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetNetworkInterfaceId added in v1.42.9

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetPrivateIpAddress added in v1.42.9

SetPrivateIpAddress sets the PrivateIpAddress field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetPrivateIpAddresses added in v1.42.9

SetPrivateIpAddresses sets the PrivateIpAddresses field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetSecondaryPrivateIpAddressCount added in v1.42.9

SetSecondaryPrivateIpAddressCount sets the SecondaryPrivateIpAddressCount field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) SetSubnetId added in v1.42.9

SetSubnetId sets the SubnetId field's value.

func (AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails added in v1.42.9

type AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails struct {

	// The IPv4 prefix. For more information, see Assigning prefixes to Amazon EC2
	// network interfaces (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html)
	// in the Amazon Elastic Compute Cloud User Guide.
	Ipv4Prefix *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details on one or more IPv4 prefixes for a network interface.

func (AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails) SetIpv4Prefix added in v1.42.9

SetIpv4Prefix sets the Ipv4Prefix field's value.

func (AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails added in v1.42.9

type AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails struct {

	// One or more specific IPv6 addresses from the IPv6 CIDR block range of your
	// subnet.
	Ipv6Address *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies an IPv6 address in an Amazon EC2 launch template.

func (AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails) SetIpv6Address added in v1.42.9

SetIpv6Address sets the Ipv6Address field's value.

func (AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails added in v1.42.9

type AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails struct {

	// The IPv6 prefix.
	Ipv6Prefix *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details on one or more IPv6 prefixes to be assigned to the network interface.

func (AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails) SetIpv6Prefix added in v1.42.9

SetIpv6Prefix sets the Ipv6Prefix field's value.

func (AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails added in v1.42.9

type AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails struct {

	// Indicates whether the private IPv4 address is the primary private IPv4 address.
	// Only one IPv4 address can be designated as primary.
	Primary *bool `type:"boolean"`

	// The private IPv4 address.
	PrivateIpAddress *string `type:"string"`
	// contains filtered or unexported fields
}

One or more private IPv4 addresses.

func (AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails) SetPrimary added in v1.42.9

SetPrimary sets the Primary field's value.

func (*AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails) SetPrivateIpAddress added in v1.42.9

SetPrivateIpAddress sets the PrivateIpAddress field's value.

func (AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataPlacementDetails added in v1.42.9

type AwsEc2LaunchTemplateDataPlacementDetails struct {

	// The affinity setting for an instance on an EC2 Dedicated Host.
	Affinity *string `type:"string"`

	// The Availability Zone for the instance.
	AvailabilityZone *string `type:"string"`

	// The name of the placement group for the instance.
	GroupName *string `type:"string"`

	// The ID of the Dedicated Host for the instance.
	HostId *string `type:"string"`

	// The Amazon Resource Name (ARN) of the host resource group in which to launch
	// the instances.
	HostResourceGroupArn *string `type:"string"`

	// The number of the partition the instance should launch in.
	PartitionNumber *int64 `type:"integer"`

	// Reserved for future use.
	SpreadDomain *string `type:"string"`

	// The tenancy of the instance (if the instance is running in a VPC). An instance
	// with a tenancy of dedicated runs on single-tenant hardware.
	Tenancy *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the placement of an Amazon EC2 instance.

func (AwsEc2LaunchTemplateDataPlacementDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataPlacementDetails) SetAffinity added in v1.42.9

SetAffinity sets the Affinity field's value.

func (*AwsEc2LaunchTemplateDataPlacementDetails) SetAvailabilityZone added in v1.42.9

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*AwsEc2LaunchTemplateDataPlacementDetails) SetGroupName added in v1.42.9

SetGroupName sets the GroupName field's value.

func (*AwsEc2LaunchTemplateDataPlacementDetails) SetHostId added in v1.42.9

SetHostId sets the HostId field's value.

func (*AwsEc2LaunchTemplateDataPlacementDetails) SetHostResourceGroupArn added in v1.42.9

SetHostResourceGroupArn sets the HostResourceGroupArn field's value.

func (*AwsEc2LaunchTemplateDataPlacementDetails) SetPartitionNumber added in v1.42.9

SetPartitionNumber sets the PartitionNumber field's value.

func (*AwsEc2LaunchTemplateDataPlacementDetails) SetSpreadDomain added in v1.42.9

SetSpreadDomain sets the SpreadDomain field's value.

func (*AwsEc2LaunchTemplateDataPlacementDetails) SetTenancy added in v1.42.9

SetTenancy sets the Tenancy field's value.

func (AwsEc2LaunchTemplateDataPlacementDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails added in v1.42.9

type AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails struct {

	// Indicates whether to respond to DNS queries for instance hostnames with DNS
	// AAAA records.
	EnableResourceNameDnsAAAARecord *bool `type:"boolean"`

	// Indicates whether to respond to DNS queries for instance hostnames with DNS
	// A records.
	EnableResourceNameDnsARecord *bool `type:"boolean"`

	// The type of hostname for EC2 instances.
	HostnameType *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the options for Amazon EC2 instance hostnames.

func (AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails) SetEnableResourceNameDnsAAAARecord added in v1.42.9

SetEnableResourceNameDnsAAAARecord sets the EnableResourceNameDnsAAAARecord field's value.

func (*AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails) SetEnableResourceNameDnsARecord added in v1.42.9

SetEnableResourceNameDnsARecord sets the EnableResourceNameDnsARecord field's value.

func (*AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails) SetHostnameType added in v1.42.9

SetHostnameType sets the HostnameType field's value.

func (AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2LaunchTemplateDetails added in v1.42.9

type AwsEc2LaunchTemplateDetails struct {

	// The default version of the launch template.
	DefaultVersionNumber *int64 `type:"long"`

	// An ID for the launch template.
	Id *string `type:"string"`

	// The latest version of the launch template.
	LatestVersionNumber *int64 `type:"long"`

	// The information to include in the launch template.
	LaunchTemplateData *AwsEc2LaunchTemplateDataDetails `type:"structure"`

	// A name for the launch template.
	LaunchTemplateName *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the properties for creating an Amazon Elastic Compute Cloud (Amazon EC2) launch template.

func (AwsEc2LaunchTemplateDetails) GoString added in v1.42.9

func (s AwsEc2LaunchTemplateDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2LaunchTemplateDetails) SetDefaultVersionNumber added in v1.42.9

func (s *AwsEc2LaunchTemplateDetails) SetDefaultVersionNumber(v int64) *AwsEc2LaunchTemplateDetails

SetDefaultVersionNumber sets the DefaultVersionNumber field's value.

func (*AwsEc2LaunchTemplateDetails) SetId added in v1.42.9

SetId sets the Id field's value.

func (*AwsEc2LaunchTemplateDetails) SetLatestVersionNumber added in v1.42.9

func (s *AwsEc2LaunchTemplateDetails) SetLatestVersionNumber(v int64) *AwsEc2LaunchTemplateDetails

SetLatestVersionNumber sets the LatestVersionNumber field's value.

func (*AwsEc2LaunchTemplateDetails) SetLaunchTemplateData added in v1.42.9

SetLaunchTemplateData sets the LaunchTemplateData field's value.

func (*AwsEc2LaunchTemplateDetails) SetLaunchTemplateName added in v1.42.9

func (s *AwsEc2LaunchTemplateDetails) SetLaunchTemplateName(v string) *AwsEc2LaunchTemplateDetails

SetLaunchTemplateName sets the LaunchTemplateName field's value.

func (AwsEc2LaunchTemplateDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2NetworkAclAssociation

type AwsEc2NetworkAclAssociation struct {

	// The identifier of the association between the network ACL and the subnet.
	NetworkAclAssociationId *string `type:"string"`

	// The identifier of the network ACL.
	NetworkAclId *string `type:"string"`

	// The identifier of the subnet that is associated with the network ACL.
	SubnetId *string `type:"string"`
	// contains filtered or unexported fields
}

An association between the network ACL and a subnet.

func (AwsEc2NetworkAclAssociation) GoString

func (s AwsEc2NetworkAclAssociation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2NetworkAclAssociation) SetNetworkAclAssociationId

func (s *AwsEc2NetworkAclAssociation) SetNetworkAclAssociationId(v string) *AwsEc2NetworkAclAssociation

SetNetworkAclAssociationId sets the NetworkAclAssociationId field's value.

func (*AwsEc2NetworkAclAssociation) SetNetworkAclId

SetNetworkAclId sets the NetworkAclId field's value.

func (*AwsEc2NetworkAclAssociation) SetSubnetId

SetSubnetId sets the SubnetId field's value.

func (AwsEc2NetworkAclAssociation) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2NetworkAclDetails

type AwsEc2NetworkAclDetails struct {

	// Associations between the network ACL and subnets.
	Associations []*AwsEc2NetworkAclAssociation `type:"list"`

	// The set of rules in the network ACL.
	Entries []*AwsEc2NetworkAclEntry `type:"list"`

	// Whether this is the default network ACL for the VPC.
	IsDefault *bool `type:"boolean"`

	// The identifier of the network ACL.
	NetworkAclId *string `type:"string"`

	// The identifier of the Amazon Web Services account that owns the network ACL.
	OwnerId *string `type:"string"`

	// The identifier of the VPC for the network ACL.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains details about an Amazon EC2 network access control list (ACL).

func (AwsEc2NetworkAclDetails) GoString

func (s AwsEc2NetworkAclDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2NetworkAclDetails) SetAssociations

SetAssociations sets the Associations field's value.

func (*AwsEc2NetworkAclDetails) SetEntries

SetEntries sets the Entries field's value.

func (*AwsEc2NetworkAclDetails) SetIsDefault

SetIsDefault sets the IsDefault field's value.

func (*AwsEc2NetworkAclDetails) SetNetworkAclId

SetNetworkAclId sets the NetworkAclId field's value.

func (*AwsEc2NetworkAclDetails) SetOwnerId

SetOwnerId sets the OwnerId field's value.

func (*AwsEc2NetworkAclDetails) SetVpcId

SetVpcId sets the VpcId field's value.

func (AwsEc2NetworkAclDetails) String

func (s AwsEc2NetworkAclDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2NetworkAclEntry

type AwsEc2NetworkAclEntry struct {

	// The IPV4 network range for which to deny or allow access.
	CidrBlock *string `type:"string"`

	// Whether the rule is an egress rule. An egress rule is a rule that applies
	// to traffic that leaves the subnet.
	Egress *bool `type:"boolean"`

	// The Internet Control Message Protocol (ICMP) type and code for which to deny
	// or allow access.
	IcmpTypeCode *IcmpTypeCode `type:"structure"`

	// The IPV6 network range for which to deny or allow access.
	Ipv6CidrBlock *string `type:"string"`

	// For TCP or UDP protocols, the range of ports that the rule applies to.
	PortRange *PortRangeFromTo `type:"structure"`

	// The protocol that the rule applies to. To deny or allow access to all protocols,
	// use the value -1.
	Protocol *string `type:"string"`

	// Whether the rule is used to allow access or deny access.
	RuleAction *string `type:"string"`

	// The rule number. The rules are processed in order by their number.
	RuleNumber *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A rule for the network ACL. Each rule allows or denies access based on the IP address, traffic direction, port, and protocol.

func (AwsEc2NetworkAclEntry) GoString

func (s AwsEc2NetworkAclEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2NetworkAclEntry) SetCidrBlock

SetCidrBlock sets the CidrBlock field's value.

func (*AwsEc2NetworkAclEntry) SetEgress

SetEgress sets the Egress field's value.

func (*AwsEc2NetworkAclEntry) SetIcmpTypeCode

SetIcmpTypeCode sets the IcmpTypeCode field's value.

func (*AwsEc2NetworkAclEntry) SetIpv6CidrBlock

func (s *AwsEc2NetworkAclEntry) SetIpv6CidrBlock(v string) *AwsEc2NetworkAclEntry

SetIpv6CidrBlock sets the Ipv6CidrBlock field's value.

func (*AwsEc2NetworkAclEntry) SetPortRange

SetPortRange sets the PortRange field's value.

func (*AwsEc2NetworkAclEntry) SetProtocol

SetProtocol sets the Protocol field's value.

func (*AwsEc2NetworkAclEntry) SetRuleAction

func (s *AwsEc2NetworkAclEntry) SetRuleAction(v string) *AwsEc2NetworkAclEntry

SetRuleAction sets the RuleAction field's value.

func (*AwsEc2NetworkAclEntry) SetRuleNumber

func (s *AwsEc2NetworkAclEntry) SetRuleNumber(v int64) *AwsEc2NetworkAclEntry

SetRuleNumber sets the RuleNumber field's value.

func (AwsEc2NetworkAclEntry) String

func (s AwsEc2NetworkAclEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2NetworkInterfaceAttachment

type AwsEc2NetworkInterfaceAttachment struct {

	// Indicates when the attachment initiated.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	AttachTime *string `type:"string"`

	// The identifier of the network interface attachment
	AttachmentId *string `type:"string"`

	// Indicates whether the network interface is deleted when the instance is terminated.
	DeleteOnTermination *bool `type:"boolean"`

	// The device index of the network interface attachment on the instance.
	DeviceIndex *int64 `type:"integer"`

	// The ID of the instance.
	InstanceId *string `type:"string"`

	// The Amazon Web Services account ID of the owner of the instance.
	InstanceOwnerId *string `type:"string"`

	// The attachment state.
	//
	// Valid values: attaching | attached | detaching | detached
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the network interface attachment.

func (AwsEc2NetworkInterfaceAttachment) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2NetworkInterfaceAttachment) SetAttachTime

SetAttachTime sets the AttachTime field's value.

func (*AwsEc2NetworkInterfaceAttachment) SetAttachmentId

SetAttachmentId sets the AttachmentId field's value.

func (*AwsEc2NetworkInterfaceAttachment) SetDeleteOnTermination

SetDeleteOnTermination sets the DeleteOnTermination field's value.

func (*AwsEc2NetworkInterfaceAttachment) SetDeviceIndex

SetDeviceIndex sets the DeviceIndex field's value.

func (*AwsEc2NetworkInterfaceAttachment) SetInstanceId

SetInstanceId sets the InstanceId field's value.

func (*AwsEc2NetworkInterfaceAttachment) SetInstanceOwnerId

SetInstanceOwnerId sets the InstanceOwnerId field's value.

func (*AwsEc2NetworkInterfaceAttachment) SetStatus

SetStatus sets the Status field's value.

func (AwsEc2NetworkInterfaceAttachment) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2NetworkInterfaceDetails

type AwsEc2NetworkInterfaceDetails struct {

	// The network interface attachment.
	Attachment *AwsEc2NetworkInterfaceAttachment `type:"structure"`

	// The IPv6 addresses associated with the network interface.
	IpV6Addresses []*AwsEc2NetworkInterfaceIpV6AddressDetail `type:"list"`

	// The ID of the network interface.
	NetworkInterfaceId *string `type:"string"`

	// The private IPv4 addresses associated with the network interface.
	PrivateIpAddresses []*AwsEc2NetworkInterfacePrivateIpAddressDetail `type:"list"`

	// The public DNS name of the network interface.
	PublicDnsName *string `type:"string"`

	// The address of the Elastic IP address bound to the network interface.
	PublicIp *string `type:"string"`

	// Security groups for the network interface.
	SecurityGroups []*AwsEc2NetworkInterfaceSecurityGroup `type:"list"`

	// Indicates whether traffic to or from the instance is validated.
	SourceDestCheck *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Details about the network interface

func (AwsEc2NetworkInterfaceDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2NetworkInterfaceDetails) SetAttachment

SetAttachment sets the Attachment field's value.

func (*AwsEc2NetworkInterfaceDetails) SetIpV6Addresses

SetIpV6Addresses sets the IpV6Addresses field's value.

func (*AwsEc2NetworkInterfaceDetails) SetNetworkInterfaceId

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*AwsEc2NetworkInterfaceDetails) SetPrivateIpAddresses

SetPrivateIpAddresses sets the PrivateIpAddresses field's value.

func (*AwsEc2NetworkInterfaceDetails) SetPublicDnsName

SetPublicDnsName sets the PublicDnsName field's value.

func (*AwsEc2NetworkInterfaceDetails) SetPublicIp

SetPublicIp sets the PublicIp field's value.

func (*AwsEc2NetworkInterfaceDetails) SetSecurityGroups

SetSecurityGroups sets the SecurityGroups field's value.

func (*AwsEc2NetworkInterfaceDetails) SetSourceDestCheck

SetSourceDestCheck sets the SourceDestCheck field's value.

func (AwsEc2NetworkInterfaceDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2NetworkInterfaceIpV6AddressDetail

type AwsEc2NetworkInterfaceIpV6AddressDetail struct {

	// The IPV6 address.
	IpV6Address *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about an IPV6 address that is associated with the network interface.

func (AwsEc2NetworkInterfaceIpV6AddressDetail) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2NetworkInterfaceIpV6AddressDetail) SetIpV6Address

SetIpV6Address sets the IpV6Address field's value.

func (AwsEc2NetworkInterfaceIpV6AddressDetail) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2NetworkInterfacePrivateIpAddressDetail

type AwsEc2NetworkInterfacePrivateIpAddressDetail struct {

	// The private DNS name for the IP address.
	PrivateDnsName *string `type:"string"`

	// The IP address.
	PrivateIpAddress *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a private IPv4 address that is with the network interface.

func (AwsEc2NetworkInterfacePrivateIpAddressDetail) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2NetworkInterfacePrivateIpAddressDetail) SetPrivateDnsName

SetPrivateDnsName sets the PrivateDnsName field's value.

func (*AwsEc2NetworkInterfacePrivateIpAddressDetail) SetPrivateIpAddress

SetPrivateIpAddress sets the PrivateIpAddress field's value.

func (AwsEc2NetworkInterfacePrivateIpAddressDetail) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2NetworkInterfaceSecurityGroup

type AwsEc2NetworkInterfaceSecurityGroup struct {

	// The ID of the security group.
	GroupId *string `type:"string"`

	// The name of the security group.
	GroupName *string `type:"string"`
	// contains filtered or unexported fields
}

A security group associated with the network interface.

func (AwsEc2NetworkInterfaceSecurityGroup) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2NetworkInterfaceSecurityGroup) SetGroupId

SetGroupId sets the GroupId field's value.

func (*AwsEc2NetworkInterfaceSecurityGroup) SetGroupName

SetGroupName sets the GroupName field's value.

func (AwsEc2NetworkInterfaceSecurityGroup) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2RouteTableDetails added in v1.42.9

type AwsEc2RouteTableDetails struct {

	// The associations between a route table and one or more subnets or a gateway.
	AssociationSet []*AssociationSetDetails `type:"list"`

	// The ID of the Amazon Web Services account that owns the route table.
	OwnerId *string `type:"string"`

	// Describes a virtual private gateway propagating route.
	PropagatingVgwSet []*PropagatingVgwSetDetails `type:"list"`

	// The routes in the route table.
	RouteSet []*RouteSetDetails `type:"list"`

	// The ID of the route table.
	RouteTableId *string `type:"string"`

	// The ID of the virtual private cloud (VPC).
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about a route table for the specified VPC.

func (AwsEc2RouteTableDetails) GoString added in v1.42.9

func (s AwsEc2RouteTableDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2RouteTableDetails) SetAssociationSet added in v1.42.9

SetAssociationSet sets the AssociationSet field's value.

func (*AwsEc2RouteTableDetails) SetOwnerId added in v1.42.9

SetOwnerId sets the OwnerId field's value.

func (*AwsEc2RouteTableDetails) SetPropagatingVgwSet added in v1.42.9

SetPropagatingVgwSet sets the PropagatingVgwSet field's value.

func (*AwsEc2RouteTableDetails) SetRouteSet added in v1.42.9

SetRouteSet sets the RouteSet field's value.

func (*AwsEc2RouteTableDetails) SetRouteTableId added in v1.42.9

SetRouteTableId sets the RouteTableId field's value.

func (*AwsEc2RouteTableDetails) SetVpcId added in v1.42.9

SetVpcId sets the VpcId field's value.

func (AwsEc2RouteTableDetails) String added in v1.42.9

func (s AwsEc2RouteTableDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2SecurityGroupDetails

type AwsEc2SecurityGroupDetails struct {

	// The ID of the security group.
	GroupId *string `type:"string"`

	// The name of the security group.
	GroupName *string `type:"string"`

	// The inbound rules associated with the security group.
	IpPermissions []*AwsEc2SecurityGroupIpPermission `type:"list"`

	// [VPC only] The outbound rules associated with the security group.
	IpPermissionsEgress []*AwsEc2SecurityGroupIpPermission `type:"list"`

	// The Amazon Web Services account ID of the owner of the security group.
	OwnerId *string `type:"string"`

	// [VPC only] The ID of the VPC for the security group.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Details about an Amazon EC2 security group.

func (AwsEc2SecurityGroupDetails) GoString

func (s AwsEc2SecurityGroupDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2SecurityGroupDetails) SetGroupId

SetGroupId sets the GroupId field's value.

func (*AwsEc2SecurityGroupDetails) SetGroupName

SetGroupName sets the GroupName field's value.

func (*AwsEc2SecurityGroupDetails) SetIpPermissions

SetIpPermissions sets the IpPermissions field's value.

func (*AwsEc2SecurityGroupDetails) SetIpPermissionsEgress

SetIpPermissionsEgress sets the IpPermissionsEgress field's value.

func (*AwsEc2SecurityGroupDetails) SetOwnerId

SetOwnerId sets the OwnerId field's value.

func (*AwsEc2SecurityGroupDetails) SetVpcId

SetVpcId sets the VpcId field's value.

func (AwsEc2SecurityGroupDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2SecurityGroupIpPermission

type AwsEc2SecurityGroupIpPermission struct {

	// The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6
	// type number.
	//
	// A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6
	// types, you must specify all codes.
	FromPort *int64 `type:"integer"`

	// The IP protocol name (tcp, udp, icmp, icmpv6) or number.
	//
	// [VPC only] Use -1 to specify all protocols.
	//
	// When authorizing security group rules, specifying -1 or a protocol number
	// other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless
	// of any port range you specify.
	//
	// For tcp, udp, and icmp, you must specify a port range.
	//
	// For icmpv6, the port range is optional. If you omit the port range, traffic
	// for all types and codes is allowed.
	IpProtocol *string `type:"string"`

	// The IPv4 ranges.
	IpRanges []*AwsEc2SecurityGroupIpRange `type:"list"`

	// The IPv6 ranges.
	Ipv6Ranges []*AwsEc2SecurityGroupIpv6Range `type:"list"`

	// [VPC only] The prefix list IDs for an Amazon Web Services service. With outbound
	// rules, this is the Amazon Web Services service to access through a VPC endpoint
	// from instances associated with the security group.
	PrefixListIds []*AwsEc2SecurityGroupPrefixListId `type:"list"`

	// The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6
	// code.
	//
	// A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6
	// types, you must specify all codes.
	ToPort *int64 `type:"integer"`

	// The security group and Amazon Web Services account ID pairs.
	UserIdGroupPairs []*AwsEc2SecurityGroupUserIdGroupPair `type:"list"`
	// contains filtered or unexported fields
}

An IP permission for an EC2 security group.

func (AwsEc2SecurityGroupIpPermission) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2SecurityGroupIpPermission) SetFromPort

SetFromPort sets the FromPort field's value.

func (*AwsEc2SecurityGroupIpPermission) SetIpProtocol

SetIpProtocol sets the IpProtocol field's value.

func (*AwsEc2SecurityGroupIpPermission) SetIpRanges

SetIpRanges sets the IpRanges field's value.

func (*AwsEc2SecurityGroupIpPermission) SetIpv6Ranges

SetIpv6Ranges sets the Ipv6Ranges field's value.

func (*AwsEc2SecurityGroupIpPermission) SetPrefixListIds

SetPrefixListIds sets the PrefixListIds field's value.

func (*AwsEc2SecurityGroupIpPermission) SetToPort

SetToPort sets the ToPort field's value.

func (*AwsEc2SecurityGroupIpPermission) SetUserIdGroupPairs

SetUserIdGroupPairs sets the UserIdGroupPairs field's value.

func (AwsEc2SecurityGroupIpPermission) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2SecurityGroupIpRange

type AwsEc2SecurityGroupIpRange struct {

	// The IPv4 CIDR range. You can specify either a CIDR range or a source security
	// group, but not both. To specify a single IPv4 address, use the /32 prefix
	// length.
	CidrIp *string `type:"string"`
	// contains filtered or unexported fields
}

A range of IPv4 addresses.

func (AwsEc2SecurityGroupIpRange) GoString

func (s AwsEc2SecurityGroupIpRange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2SecurityGroupIpRange) SetCidrIp

SetCidrIp sets the CidrIp field's value.

func (AwsEc2SecurityGroupIpRange) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2SecurityGroupIpv6Range

type AwsEc2SecurityGroupIpv6Range struct {

	// The IPv6 CIDR range. You can specify either a CIDR range or a source security
	// group, but not both. To specify a single IPv6 address, use the /128 prefix
	// length.
	CidrIpv6 *string `type:"string"`
	// contains filtered or unexported fields
}

A range of IPv6 addresses.

func (AwsEc2SecurityGroupIpv6Range) GoString

func (s AwsEc2SecurityGroupIpv6Range) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2SecurityGroupIpv6Range) SetCidrIpv6

SetCidrIpv6 sets the CidrIpv6 field's value.

func (AwsEc2SecurityGroupIpv6Range) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2SecurityGroupPrefixListId

type AwsEc2SecurityGroupPrefixListId struct {

	// The ID of the prefix.
	PrefixListId *string `type:"string"`
	// contains filtered or unexported fields
}

A prefix list ID.

func (AwsEc2SecurityGroupPrefixListId) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2SecurityGroupPrefixListId) SetPrefixListId

SetPrefixListId sets the PrefixListId field's value.

func (AwsEc2SecurityGroupPrefixListId) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2SecurityGroupUserIdGroupPair

type AwsEc2SecurityGroupUserIdGroupPair struct {

	// The ID of the security group.
	GroupId *string `type:"string"`

	// The name of the security group.
	GroupName *string `type:"string"`

	// The status of a VPC peering connection, if applicable.
	PeeringStatus *string `type:"string"`

	// The ID of an Amazon Web Services account.
	//
	// For a referenced security group in another VPC, the account ID of the referenced
	// security group is returned in the response. If the referenced security group
	// is deleted, this value is not returned.
	//
	// [EC2-Classic] Required when adding or removing rules that reference a security
	// group in another VPC.
	UserId *string `type:"string"`

	// The ID of the VPC for the referenced security group, if applicable.
	VpcId *string `type:"string"`

	// The ID of the VPC peering connection, if applicable.
	VpcPeeringConnectionId *string `type:"string"`
	// contains filtered or unexported fields
}

A relationship between a security group and a user.

func (AwsEc2SecurityGroupUserIdGroupPair) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2SecurityGroupUserIdGroupPair) SetGroupId

SetGroupId sets the GroupId field's value.

func (*AwsEc2SecurityGroupUserIdGroupPair) SetGroupName

SetGroupName sets the GroupName field's value.

func (*AwsEc2SecurityGroupUserIdGroupPair) SetPeeringStatus

SetPeeringStatus sets the PeeringStatus field's value.

func (*AwsEc2SecurityGroupUserIdGroupPair) SetUserId

SetUserId sets the UserId field's value.

func (*AwsEc2SecurityGroupUserIdGroupPair) SetVpcId

SetVpcId sets the VpcId field's value.

func (*AwsEc2SecurityGroupUserIdGroupPair) SetVpcPeeringConnectionId

SetVpcPeeringConnectionId sets the VpcPeeringConnectionId field's value.

func (AwsEc2SecurityGroupUserIdGroupPair) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2SubnetDetails

type AwsEc2SubnetDetails struct {

	// Whether to assign an IPV6 address to a network interface that is created
	// in this subnet.
	AssignIpv6AddressOnCreation *bool `type:"boolean"`

	// The Availability Zone for the subnet.
	AvailabilityZone *string `type:"string"`

	// The identifier of the Availability Zone for the subnet.
	AvailabilityZoneId *string `type:"string"`

	// The number of available IPV4 addresses in the subnet. Does not include addresses
	// for stopped instances.
	AvailableIpAddressCount *int64 `type:"integer"`

	// The IPV4 CIDR block that is assigned to the subnet.
	CidrBlock *string `type:"string"`

	// Whether this subnet is the default subnet for the Availability Zone.
	DefaultForAz *bool `type:"boolean"`

	// The IPV6 CIDR blocks that are associated with the subnet.
	Ipv6CidrBlockAssociationSet []*Ipv6CidrBlockAssociation `type:"list"`

	// Whether instances in this subnet receive a public IP address.
	MapPublicIpOnLaunch *bool `type:"boolean"`

	// The identifier of the Amazon Web Services account that owns the subnet.
	OwnerId *string `type:"string"`

	// The current state of the subnet. Valid values are available or pending.
	State *string `type:"string"`

	// The ARN of the subnet.
	SubnetArn *string `type:"string"`

	// The identifier of the subnet.
	SubnetId *string `type:"string"`

	// The identifier of the VPC that contains the subnet.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about a subnet in Amazon EC2.

func (AwsEc2SubnetDetails) GoString

func (s AwsEc2SubnetDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2SubnetDetails) SetAssignIpv6AddressOnCreation

func (s *AwsEc2SubnetDetails) SetAssignIpv6AddressOnCreation(v bool) *AwsEc2SubnetDetails

SetAssignIpv6AddressOnCreation sets the AssignIpv6AddressOnCreation field's value.

func (*AwsEc2SubnetDetails) SetAvailabilityZone

func (s *AwsEc2SubnetDetails) SetAvailabilityZone(v string) *AwsEc2SubnetDetails

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*AwsEc2SubnetDetails) SetAvailabilityZoneId

func (s *AwsEc2SubnetDetails) SetAvailabilityZoneId(v string) *AwsEc2SubnetDetails

SetAvailabilityZoneId sets the AvailabilityZoneId field's value.

func (*AwsEc2SubnetDetails) SetAvailableIpAddressCount

func (s *AwsEc2SubnetDetails) SetAvailableIpAddressCount(v int64) *AwsEc2SubnetDetails

SetAvailableIpAddressCount sets the AvailableIpAddressCount field's value.

func (*AwsEc2SubnetDetails) SetCidrBlock

func (s *AwsEc2SubnetDetails) SetCidrBlock(v string) *AwsEc2SubnetDetails

SetCidrBlock sets the CidrBlock field's value.

func (*AwsEc2SubnetDetails) SetDefaultForAz

func (s *AwsEc2SubnetDetails) SetDefaultForAz(v bool) *AwsEc2SubnetDetails

SetDefaultForAz sets the DefaultForAz field's value.

func (*AwsEc2SubnetDetails) SetIpv6CidrBlockAssociationSet

func (s *AwsEc2SubnetDetails) SetIpv6CidrBlockAssociationSet(v []*Ipv6CidrBlockAssociation) *AwsEc2SubnetDetails

SetIpv6CidrBlockAssociationSet sets the Ipv6CidrBlockAssociationSet field's value.

func (*AwsEc2SubnetDetails) SetMapPublicIpOnLaunch

func (s *AwsEc2SubnetDetails) SetMapPublicIpOnLaunch(v bool) *AwsEc2SubnetDetails

SetMapPublicIpOnLaunch sets the MapPublicIpOnLaunch field's value.

func (*AwsEc2SubnetDetails) SetOwnerId

SetOwnerId sets the OwnerId field's value.

func (*AwsEc2SubnetDetails) SetState

SetState sets the State field's value.

func (*AwsEc2SubnetDetails) SetSubnetArn

func (s *AwsEc2SubnetDetails) SetSubnetArn(v string) *AwsEc2SubnetDetails

SetSubnetArn sets the SubnetArn field's value.

func (*AwsEc2SubnetDetails) SetSubnetId

func (s *AwsEc2SubnetDetails) SetSubnetId(v string) *AwsEc2SubnetDetails

SetSubnetId sets the SubnetId field's value.

func (*AwsEc2SubnetDetails) SetVpcId

SetVpcId sets the VpcId field's value.

func (AwsEc2SubnetDetails) String

func (s AwsEc2SubnetDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2TransitGatewayDetails added in v1.42.9

type AwsEc2TransitGatewayDetails struct {

	// A private Autonomous System Number (ASN) for the Amazon side of a BGP session.
	AmazonSideAsn *int64 `type:"integer"`

	// The ID of the default association route table.
	AssociationDefaultRouteTableId *string `type:"string"`

	// Turn on or turn off automatic acceptance of attachment requests.
	AutoAcceptSharedAttachments *string `type:"string"`

	// Turn on or turn off automatic association with the default association route
	// table.
	DefaultRouteTableAssociation *string `type:"string"`

	// Turn on or turn off automatic propagation of routes to the default propagation
	// route table.
	DefaultRouteTablePropagation *string `type:"string"`

	// The description of the transit gateway.
	Description *string `type:"string"`

	// Turn on or turn off DNS support.
	DnsSupport *string `type:"string"`

	// The ID of the transit gateway.
	Id *string `type:"string"`

	// Indicates whether multicast is supported on the transit gateway.
	MulticastSupport *string `type:"string"`

	// The ID of the default propagation route table.
	PropagationDefaultRouteTableId *string `type:"string"`

	// The transit gateway Classless Inter-Domain Routing (CIDR) blocks.
	TransitGatewayCidrBlocks []*string `type:"list"`

	// Turn on or turn off Equal Cost Multipath Protocol (ECMP) support.
	VpnEcmpSupport *string `type:"string"`
	// contains filtered or unexported fields
}

Information about an Amazon Web Services Amazon EC2 Transit Gateway that interconnects virtual private clouds (VPCs) and on-premises networks.

func (AwsEc2TransitGatewayDetails) GoString added in v1.42.9

func (s AwsEc2TransitGatewayDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2TransitGatewayDetails) SetAmazonSideAsn added in v1.42.9

SetAmazonSideAsn sets the AmazonSideAsn field's value.

func (*AwsEc2TransitGatewayDetails) SetAssociationDefaultRouteTableId added in v1.42.9

func (s *AwsEc2TransitGatewayDetails) SetAssociationDefaultRouteTableId(v string) *AwsEc2TransitGatewayDetails

SetAssociationDefaultRouteTableId sets the AssociationDefaultRouteTableId field's value.

func (*AwsEc2TransitGatewayDetails) SetAutoAcceptSharedAttachments added in v1.42.9

func (s *AwsEc2TransitGatewayDetails) SetAutoAcceptSharedAttachments(v string) *AwsEc2TransitGatewayDetails

SetAutoAcceptSharedAttachments sets the AutoAcceptSharedAttachments field's value.

func (*AwsEc2TransitGatewayDetails) SetDefaultRouteTableAssociation added in v1.42.9

func (s *AwsEc2TransitGatewayDetails) SetDefaultRouteTableAssociation(v string) *AwsEc2TransitGatewayDetails

SetDefaultRouteTableAssociation sets the DefaultRouteTableAssociation field's value.

func (*AwsEc2TransitGatewayDetails) SetDefaultRouteTablePropagation added in v1.42.9

func (s *AwsEc2TransitGatewayDetails) SetDefaultRouteTablePropagation(v string) *AwsEc2TransitGatewayDetails

SetDefaultRouteTablePropagation sets the DefaultRouteTablePropagation field's value.

func (*AwsEc2TransitGatewayDetails) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*AwsEc2TransitGatewayDetails) SetDnsSupport added in v1.42.9

SetDnsSupport sets the DnsSupport field's value.

func (*AwsEc2TransitGatewayDetails) SetId added in v1.42.9

SetId sets the Id field's value.

func (*AwsEc2TransitGatewayDetails) SetMulticastSupport added in v1.42.9

SetMulticastSupport sets the MulticastSupport field's value.

func (*AwsEc2TransitGatewayDetails) SetPropagationDefaultRouteTableId added in v1.42.9

func (s *AwsEc2TransitGatewayDetails) SetPropagationDefaultRouteTableId(v string) *AwsEc2TransitGatewayDetails

SetPropagationDefaultRouteTableId sets the PropagationDefaultRouteTableId field's value.

func (*AwsEc2TransitGatewayDetails) SetTransitGatewayCidrBlocks added in v1.42.9

func (s *AwsEc2TransitGatewayDetails) SetTransitGatewayCidrBlocks(v []*string) *AwsEc2TransitGatewayDetails

SetTransitGatewayCidrBlocks sets the TransitGatewayCidrBlocks field's value.

func (*AwsEc2TransitGatewayDetails) SetVpnEcmpSupport added in v1.42.9

SetVpnEcmpSupport sets the VpnEcmpSupport field's value.

func (AwsEc2TransitGatewayDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2VolumeAttachment

type AwsEc2VolumeAttachment struct {

	// The datetime when the attachment initiated.
	AttachTime *string `type:"string"`

	// Whether the EBS volume is deleted when the EC2 instance is terminated.
	DeleteOnTermination *bool `type:"boolean"`

	// The identifier of the EC2 instance.
	InstanceId *string `type:"string"`

	// The attachment state of the volume. Valid values are as follows:
	//
	//    * attaching
	//
	//    * attached
	//
	//    * busy
	//
	//    * detaching
	//
	//    * detached
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

An attachment to an Amazon EC2 volume.

func (AwsEc2VolumeAttachment) GoString

func (s AwsEc2VolumeAttachment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2VolumeAttachment) SetAttachTime

SetAttachTime sets the AttachTime field's value.

func (*AwsEc2VolumeAttachment) SetDeleteOnTermination

func (s *AwsEc2VolumeAttachment) SetDeleteOnTermination(v bool) *AwsEc2VolumeAttachment

SetDeleteOnTermination sets the DeleteOnTermination field's value.

func (*AwsEc2VolumeAttachment) SetInstanceId

SetInstanceId sets the InstanceId field's value.

func (*AwsEc2VolumeAttachment) SetStatus

SetStatus sets the Status field's value.

func (AwsEc2VolumeAttachment) String

func (s AwsEc2VolumeAttachment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2VolumeDetails

type AwsEc2VolumeDetails struct {

	// The volume attachments.
	Attachments []*AwsEc2VolumeAttachment `type:"list"`

	// Indicates when the volume was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreateTime *string `type:"string"`

	// The device name for the volume that is attached to the instance.
	DeviceName *string `type:"string"`

	// Specifies whether the volume is encrypted.
	Encrypted *bool `type:"boolean"`

	// The ARN of the KMS key that was used to protect the volume encryption key
	// for the volume.
	KmsKeyId *string `type:"string"`

	// The size of the volume, in GiBs.
	Size *int64 `type:"integer"`

	// The snapshot from which the volume was created.
	SnapshotId *string `type:"string"`

	// The volume state. Valid values are as follows:
	//
	//    * available
	//
	//    * creating
	//
	//    * deleted
	//
	//    * deleting
	//
	//    * error
	//
	//    * in-use
	Status *string `type:"string"`

	// The ID of the volume.
	VolumeId *string `type:"string"`

	// Indicates whether the volume was scanned or skipped.
	VolumeScanStatus *string `type:"string"`

	// The volume type.
	VolumeType *string `type:"string"`
	// contains filtered or unexported fields
}

Details about an EC2 volume.

func (AwsEc2VolumeDetails) GoString

func (s AwsEc2VolumeDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2VolumeDetails) SetAttachments

SetAttachments sets the Attachments field's value.

func (*AwsEc2VolumeDetails) SetCreateTime

func (s *AwsEc2VolumeDetails) SetCreateTime(v string) *AwsEc2VolumeDetails

SetCreateTime sets the CreateTime field's value.

func (*AwsEc2VolumeDetails) SetDeviceName added in v1.42.9

func (s *AwsEc2VolumeDetails) SetDeviceName(v string) *AwsEc2VolumeDetails

SetDeviceName sets the DeviceName field's value.

func (*AwsEc2VolumeDetails) SetEncrypted

func (s *AwsEc2VolumeDetails) SetEncrypted(v bool) *AwsEc2VolumeDetails

SetEncrypted sets the Encrypted field's value.

func (*AwsEc2VolumeDetails) SetKmsKeyId

func (s *AwsEc2VolumeDetails) SetKmsKeyId(v string) *AwsEc2VolumeDetails

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsEc2VolumeDetails) SetSize

SetSize sets the Size field's value.

func (*AwsEc2VolumeDetails) SetSnapshotId

func (s *AwsEc2VolumeDetails) SetSnapshotId(v string) *AwsEc2VolumeDetails

SetSnapshotId sets the SnapshotId field's value.

func (*AwsEc2VolumeDetails) SetStatus

SetStatus sets the Status field's value.

func (*AwsEc2VolumeDetails) SetVolumeId added in v1.42.9

func (s *AwsEc2VolumeDetails) SetVolumeId(v string) *AwsEc2VolumeDetails

SetVolumeId sets the VolumeId field's value.

func (*AwsEc2VolumeDetails) SetVolumeScanStatus added in v1.42.9

func (s *AwsEc2VolumeDetails) SetVolumeScanStatus(v string) *AwsEc2VolumeDetails

SetVolumeScanStatus sets the VolumeScanStatus field's value.

func (*AwsEc2VolumeDetails) SetVolumeType added in v1.42.9

func (s *AwsEc2VolumeDetails) SetVolumeType(v string) *AwsEc2VolumeDetails

SetVolumeType sets the VolumeType field's value.

func (AwsEc2VolumeDetails) String

func (s AwsEc2VolumeDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2VpcDetails

type AwsEc2VpcDetails struct {

	// Information about the IPv4 CIDR blocks associated with the VPC.
	CidrBlockAssociationSet []*CidrBlockAssociation `type:"list"`

	// The identifier of the set of Dynamic Host Configuration Protocol (DHCP) options
	// that are associated with the VPC. If the default options are associated with
	// the VPC, then this is default.
	DhcpOptionsId *string `type:"string"`

	// Information about the IPv6 CIDR blocks associated with the VPC.
	Ipv6CidrBlockAssociationSet []*Ipv6CidrBlockAssociation `type:"list"`

	// The current state of the VPC. Valid values are available or pending.
	State *string `type:"string"`
	// contains filtered or unexported fields
}

Details about an EC2 VPC.

func (AwsEc2VpcDetails) GoString

func (s AwsEc2VpcDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2VpcDetails) SetCidrBlockAssociationSet

func (s *AwsEc2VpcDetails) SetCidrBlockAssociationSet(v []*CidrBlockAssociation) *AwsEc2VpcDetails

SetCidrBlockAssociationSet sets the CidrBlockAssociationSet field's value.

func (*AwsEc2VpcDetails) SetDhcpOptionsId

func (s *AwsEc2VpcDetails) SetDhcpOptionsId(v string) *AwsEc2VpcDetails

SetDhcpOptionsId sets the DhcpOptionsId field's value.

func (*AwsEc2VpcDetails) SetIpv6CidrBlockAssociationSet

func (s *AwsEc2VpcDetails) SetIpv6CidrBlockAssociationSet(v []*Ipv6CidrBlockAssociation) *AwsEc2VpcDetails

SetIpv6CidrBlockAssociationSet sets the Ipv6CidrBlockAssociationSet field's value.

func (*AwsEc2VpcDetails) SetState

func (s *AwsEc2VpcDetails) SetState(v string) *AwsEc2VpcDetails

SetState sets the State field's value.

func (AwsEc2VpcDetails) String

func (s AwsEc2VpcDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2VpcEndpointServiceDetails

type AwsEc2VpcEndpointServiceDetails struct {

	// Whether requests from other Amazon Web Services accounts to create an endpoint
	// to the service must first be accepted.
	AcceptanceRequired *bool `type:"boolean"`

	// The Availability Zones where the service is available.
	AvailabilityZones []*string `type:"list"`

	// The DNS names for the service.
	BaseEndpointDnsNames []*string `type:"list"`

	// The ARNs of the Gateway Load Balancers for the service.
	GatewayLoadBalancerArns []*string `type:"list"`

	// Whether the service manages its VPC endpoints.
	ManagesVpcEndpoints *bool `type:"boolean"`

	// The ARNs of the Network Load Balancers for the service.
	NetworkLoadBalancerArns []*string `type:"list"`

	// The private DNS name for the service.
	PrivateDnsName *string `type:"string"`

	// The identifier of the service.
	ServiceId *string `type:"string"`

	// The name of the service.
	ServiceName *string `type:"string"`

	// The current state of the service. Valid values are as follows:
	//
	//    * Available
	//
	//    * Deleted
	//
	//    * Deleting
	//
	//    * Failed
	//
	//    * Pending
	ServiceState *string `type:"string"`

	// The types for the service.
	ServiceType []*AwsEc2VpcEndpointServiceServiceTypeDetails `type:"list"`
	// contains filtered or unexported fields
}

Contains details about the service configuration for a VPC endpoint service.

func (AwsEc2VpcEndpointServiceDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2VpcEndpointServiceDetails) SetAcceptanceRequired

SetAcceptanceRequired sets the AcceptanceRequired field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetAvailabilityZones

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetBaseEndpointDnsNames

SetBaseEndpointDnsNames sets the BaseEndpointDnsNames field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetGatewayLoadBalancerArns

func (s *AwsEc2VpcEndpointServiceDetails) SetGatewayLoadBalancerArns(v []*string) *AwsEc2VpcEndpointServiceDetails

SetGatewayLoadBalancerArns sets the GatewayLoadBalancerArns field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetManagesVpcEndpoints

SetManagesVpcEndpoints sets the ManagesVpcEndpoints field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetNetworkLoadBalancerArns

func (s *AwsEc2VpcEndpointServiceDetails) SetNetworkLoadBalancerArns(v []*string) *AwsEc2VpcEndpointServiceDetails

SetNetworkLoadBalancerArns sets the NetworkLoadBalancerArns field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetPrivateDnsName

SetPrivateDnsName sets the PrivateDnsName field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetServiceId

SetServiceId sets the ServiceId field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetServiceName

SetServiceName sets the ServiceName field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetServiceState

SetServiceState sets the ServiceState field's value.

func (*AwsEc2VpcEndpointServiceDetails) SetServiceType

SetServiceType sets the ServiceType field's value.

func (AwsEc2VpcEndpointServiceDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2VpcEndpointServiceServiceTypeDetails

type AwsEc2VpcEndpointServiceServiceTypeDetails struct {

	// The type of service.
	ServiceType *string `type:"string"`
	// contains filtered or unexported fields
}

The service type information for a VPC endpoint service.

func (AwsEc2VpcEndpointServiceServiceTypeDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2VpcEndpointServiceServiceTypeDetails) SetServiceType

SetServiceType sets the ServiceType field's value.

func (AwsEc2VpcEndpointServiceServiceTypeDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2VpcPeeringConnectionDetails added in v1.42.9

type AwsEc2VpcPeeringConnectionDetails struct {

	// Information about the accepter VPC.
	AccepterVpcInfo *AwsEc2VpcPeeringConnectionVpcInfoDetails `type:"structure"`

	// The time at which an unaccepted VPC peering connection will expire.
	ExpirationTime *string `type:"string"`

	// Information about the requester VPC.
	RequesterVpcInfo *AwsEc2VpcPeeringConnectionVpcInfoDetails `type:"structure"`

	// The status of the VPC peering connection.
	Status *AwsEc2VpcPeeringConnectionStatusDetails `type:"structure"`

	// The ID of the VPC peering connection.
	VpcPeeringConnectionId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection.

func (AwsEc2VpcPeeringConnectionDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2VpcPeeringConnectionDetails) SetAccepterVpcInfo added in v1.42.9

SetAccepterVpcInfo sets the AccepterVpcInfo field's value.

func (*AwsEc2VpcPeeringConnectionDetails) SetExpirationTime added in v1.42.9

SetExpirationTime sets the ExpirationTime field's value.

func (*AwsEc2VpcPeeringConnectionDetails) SetRequesterVpcInfo added in v1.42.9

SetRequesterVpcInfo sets the RequesterVpcInfo field's value.

func (*AwsEc2VpcPeeringConnectionDetails) SetStatus added in v1.42.9

SetStatus sets the Status field's value.

func (*AwsEc2VpcPeeringConnectionDetails) SetVpcPeeringConnectionId added in v1.42.9

SetVpcPeeringConnectionId sets the VpcPeeringConnectionId field's value.

func (AwsEc2VpcPeeringConnectionDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2VpcPeeringConnectionStatusDetails added in v1.42.9

type AwsEc2VpcPeeringConnectionStatusDetails struct {

	// The status of the VPC peering connection.
	Code *string `type:"string"`

	// A message that provides more information about the status, if applicable.
	Message *string `type:"string"`
	// contains filtered or unexported fields
}

Details about the status of the VPC peering connection.

func (AwsEc2VpcPeeringConnectionStatusDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2VpcPeeringConnectionStatusDetails) SetCode added in v1.42.9

SetCode sets the Code field's value.

func (*AwsEc2VpcPeeringConnectionStatusDetails) SetMessage added in v1.42.9

SetMessage sets the Message field's value.

func (AwsEc2VpcPeeringConnectionStatusDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2VpcPeeringConnectionVpcInfoDetails added in v1.42.9

type AwsEc2VpcPeeringConnectionVpcInfoDetails struct {

	// The IPv4 CIDR block for the VPC.
	CidrBlock *string `type:"string"`

	// Information about the IPv4 CIDR blocks for the VPC.
	CidrBlockSet []*VpcInfoCidrBlockSetDetails `type:"list"`

	// The IPv6 CIDR block for the VPC.
	Ipv6CidrBlockSet []*VpcInfoIpv6CidrBlockSetDetails `type:"list"`

	// The ID of the Amazon Web Services account that owns the VPC.
	OwnerId *string `type:"string"`

	// Information about the VPC peering connection options for the accepter or
	// requester VPC.
	PeeringOptions *VpcInfoPeeringOptionsDetails `type:"structure"`

	// The Amazon Web Services Region in which the VPC is located.
	Region *string `type:"string"`

	// The ID of the VPC.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Describes a VPC in a VPC peering connection.

func (AwsEc2VpcPeeringConnectionVpcInfoDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2VpcPeeringConnectionVpcInfoDetails) SetCidrBlock added in v1.42.9

SetCidrBlock sets the CidrBlock field's value.

func (*AwsEc2VpcPeeringConnectionVpcInfoDetails) SetCidrBlockSet added in v1.42.9

SetCidrBlockSet sets the CidrBlockSet field's value.

func (*AwsEc2VpcPeeringConnectionVpcInfoDetails) SetIpv6CidrBlockSet added in v1.42.9

SetIpv6CidrBlockSet sets the Ipv6CidrBlockSet field's value.

func (*AwsEc2VpcPeeringConnectionVpcInfoDetails) SetOwnerId added in v1.42.9

SetOwnerId sets the OwnerId field's value.

func (*AwsEc2VpcPeeringConnectionVpcInfoDetails) SetPeeringOptions added in v1.42.9

SetPeeringOptions sets the PeeringOptions field's value.

func (*AwsEc2VpcPeeringConnectionVpcInfoDetails) SetRegion added in v1.42.9

SetRegion sets the Region field's value.

func (*AwsEc2VpcPeeringConnectionVpcInfoDetails) SetVpcId added in v1.42.9

SetVpcId sets the VpcId field's value.

func (AwsEc2VpcPeeringConnectionVpcInfoDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2VpnConnectionDetails

type AwsEc2VpnConnectionDetails struct {

	// The category of the VPN connection. VPN indicates an Amazon Web Services
	// VPN connection. VPN-Classic indicates an Amazon Web Services Classic VPN
	// connection.
	Category *string `type:"string"`

	// The configuration information for the VPN connection's customer gateway,
	// in the native XML format.
	CustomerGatewayConfiguration *string `type:"string"`

	// The identifier of the customer gateway that is at your end of the VPN connection.
	CustomerGatewayId *string `type:"string"`

	// The VPN connection options.
	Options *AwsEc2VpnConnectionOptionsDetails `type:"structure"`

	// The static routes that are associated with the VPN connection.
	Routes []*AwsEc2VpnConnectionRoutesDetails `type:"list"`

	// The current state of the VPN connection. Valid values are as follows:
	//
	//    * available
	//
	//    * deleted
	//
	//    * deleting
	//
	//    * pending
	State *string `type:"string"`

	// The identifier of the transit gateway that is associated with the VPN connection.
	TransitGatewayId *string `type:"string"`

	// The type of VPN connection.
	Type *string `type:"string"`

	// Information about the VPN tunnel.
	VgwTelemetry []*AwsEc2VpnConnectionVgwTelemetryDetails `type:"list"`

	// The identifier of the VPN connection.
	VpnConnectionId *string `type:"string"`

	// The identifier of the virtual private gateway that is at the Amazon Web Services
	// side of the VPN connection.
	VpnGatewayId *string `type:"string"`
	// contains filtered or unexported fields
}

Details about an Amazon EC2 VPN connection.

func (AwsEc2VpnConnectionDetails) GoString

func (s AwsEc2VpnConnectionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2VpnConnectionDetails) SetCategory

SetCategory sets the Category field's value.

func (*AwsEc2VpnConnectionDetails) SetCustomerGatewayConfiguration

func (s *AwsEc2VpnConnectionDetails) SetCustomerGatewayConfiguration(v string) *AwsEc2VpnConnectionDetails

SetCustomerGatewayConfiguration sets the CustomerGatewayConfiguration field's value.

func (*AwsEc2VpnConnectionDetails) SetCustomerGatewayId

func (s *AwsEc2VpnConnectionDetails) SetCustomerGatewayId(v string) *AwsEc2VpnConnectionDetails

SetCustomerGatewayId sets the CustomerGatewayId field's value.

func (*AwsEc2VpnConnectionDetails) SetOptions

SetOptions sets the Options field's value.

func (*AwsEc2VpnConnectionDetails) SetRoutes

SetRoutes sets the Routes field's value.

func (*AwsEc2VpnConnectionDetails) SetState

SetState sets the State field's value.

func (*AwsEc2VpnConnectionDetails) SetTransitGatewayId

SetTransitGatewayId sets the TransitGatewayId field's value.

func (*AwsEc2VpnConnectionDetails) SetType

SetType sets the Type field's value.

func (*AwsEc2VpnConnectionDetails) SetVgwTelemetry

SetVgwTelemetry sets the VgwTelemetry field's value.

func (*AwsEc2VpnConnectionDetails) SetVpnConnectionId

SetVpnConnectionId sets the VpnConnectionId field's value.

func (*AwsEc2VpnConnectionDetails) SetVpnGatewayId

SetVpnGatewayId sets the VpnGatewayId field's value.

func (AwsEc2VpnConnectionDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2VpnConnectionOptionsDetails

type AwsEc2VpnConnectionOptionsDetails struct {

	// Whether the VPN connection uses static routes only.
	StaticRoutesOnly *bool `type:"boolean"`

	// The VPN tunnel options.
	TunnelOptions []*AwsEc2VpnConnectionOptionsTunnelOptionsDetails `type:"list"`
	// contains filtered or unexported fields
}

VPN connection options.

func (AwsEc2VpnConnectionOptionsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2VpnConnectionOptionsDetails) SetStaticRoutesOnly

SetStaticRoutesOnly sets the StaticRoutesOnly field's value.

func (*AwsEc2VpnConnectionOptionsDetails) SetTunnelOptions

SetTunnelOptions sets the TunnelOptions field's value.

func (AwsEc2VpnConnectionOptionsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2VpnConnectionOptionsTunnelOptionsDetails

type AwsEc2VpnConnectionOptionsTunnelOptionsDetails struct {

	// The number of seconds after which a Dead Peer Detection (DPD) timeout occurs.
	DpdTimeoutSeconds *int64 `type:"integer"`

	// The Internet Key Exchange (IKE) versions that are permitted for the VPN tunnel.
	IkeVersions []*string `type:"list"`

	// The external IP address of the VPN tunnel.
	OutsideIpAddress *string `type:"string"`

	// The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1
	// IKE negotiations.
	Phase1DhGroupNumbers []*int64 `type:"list"`

	// The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
	Phase1EncryptionAlgorithms []*string `type:"list"`

	// The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
	Phase1IntegrityAlgorithms []*string `type:"list"`

	// The lifetime for phase 1 of the IKE negotiation, in seconds.
	Phase1LifetimeSeconds *int64 `type:"integer"`

	// The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2
	// IKE negotiations.
	Phase2DhGroupNumbers []*int64 `type:"list"`

	// The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
	Phase2EncryptionAlgorithms []*string `type:"list"`

	// The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
	Phase2IntegrityAlgorithms []*string `type:"list"`

	// The lifetime for phase 2 of the IKE negotiation, in seconds.
	Phase2LifetimeSeconds *int64 `type:"integer"`

	// The preshared key to establish initial authentication between the virtual
	// private gateway and the customer gateway.
	PreSharedKey *string `type:"string"`

	// The percentage of the rekey window, which is determined by RekeyMarginTimeSeconds
	// during which the rekey time is randomly selected.
	RekeyFuzzPercentage *int64 `type:"integer"`

	// The margin time, in seconds, before the phase 2 lifetime expires, during
	// which the Amazon Web Services side of the VPN connection performs an IKE
	// rekey.
	RekeyMarginTimeSeconds *int64 `type:"integer"`

	// The number of packets in an IKE replay window.
	ReplayWindowSize *int64 `type:"integer"`

	// The range of inside IPv4 addresses for the tunnel.
	TunnelInsideCidr *string `type:"string"`
	// contains filtered or unexported fields
}

The VPN tunnel options.

func (AwsEc2VpnConnectionOptionsTunnelOptionsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetDpdTimeoutSeconds

SetDpdTimeoutSeconds sets the DpdTimeoutSeconds field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetIkeVersions

SetIkeVersions sets the IkeVersions field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetOutsideIpAddress

SetOutsideIpAddress sets the OutsideIpAddress field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase1DhGroupNumbers

SetPhase1DhGroupNumbers sets the Phase1DhGroupNumbers field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase1EncryptionAlgorithms

SetPhase1EncryptionAlgorithms sets the Phase1EncryptionAlgorithms field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase1IntegrityAlgorithms

SetPhase1IntegrityAlgorithms sets the Phase1IntegrityAlgorithms field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase1LifetimeSeconds

SetPhase1LifetimeSeconds sets the Phase1LifetimeSeconds field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase2DhGroupNumbers

SetPhase2DhGroupNumbers sets the Phase2DhGroupNumbers field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase2EncryptionAlgorithms

SetPhase2EncryptionAlgorithms sets the Phase2EncryptionAlgorithms field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase2IntegrityAlgorithms

SetPhase2IntegrityAlgorithms sets the Phase2IntegrityAlgorithms field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPhase2LifetimeSeconds

SetPhase2LifetimeSeconds sets the Phase2LifetimeSeconds field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetPreSharedKey

SetPreSharedKey sets the PreSharedKey field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetRekeyFuzzPercentage

SetRekeyFuzzPercentage sets the RekeyFuzzPercentage field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetRekeyMarginTimeSeconds

SetRekeyMarginTimeSeconds sets the RekeyMarginTimeSeconds field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetReplayWindowSize

SetReplayWindowSize sets the ReplayWindowSize field's value.

func (*AwsEc2VpnConnectionOptionsTunnelOptionsDetails) SetTunnelInsideCidr

SetTunnelInsideCidr sets the TunnelInsideCidr field's value.

func (AwsEc2VpnConnectionOptionsTunnelOptionsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2VpnConnectionRoutesDetails

type AwsEc2VpnConnectionRoutesDetails struct {

	// The CIDR block associated with the local subnet of the customer data center.
	DestinationCidrBlock *string `type:"string"`

	// The current state of the static route.
	State *string `type:"string"`
	// contains filtered or unexported fields
}

A static routes associated with the VPN connection.

func (AwsEc2VpnConnectionRoutesDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2VpnConnectionRoutesDetails) SetDestinationCidrBlock

SetDestinationCidrBlock sets the DestinationCidrBlock field's value.

func (*AwsEc2VpnConnectionRoutesDetails) SetState

SetState sets the State field's value.

func (AwsEc2VpnConnectionRoutesDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEc2VpnConnectionVgwTelemetryDetails

type AwsEc2VpnConnectionVgwTelemetryDetails struct {

	// The number of accepted routes.
	AcceptedRouteCount *int64 `type:"integer"`

	// The ARN of the VPN tunnel endpoint certificate.
	CertificateArn *string `type:"string"`

	// The date and time of the last change in status.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	LastStatusChange *string `type:"string"`

	// The Internet-routable IP address of the virtual private gateway's outside
	// interface.
	OutsideIpAddress *string `type:"string"`

	// The status of the VPN tunnel. Valid values are DOWN or UP.
	Status *string `type:"string"`

	// If an error occurs, a description of the error.
	StatusMessage *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the VPN tunnel.

func (AwsEc2VpnConnectionVgwTelemetryDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEc2VpnConnectionVgwTelemetryDetails) SetAcceptedRouteCount

SetAcceptedRouteCount sets the AcceptedRouteCount field's value.

func (*AwsEc2VpnConnectionVgwTelemetryDetails) SetCertificateArn

SetCertificateArn sets the CertificateArn field's value.

func (*AwsEc2VpnConnectionVgwTelemetryDetails) SetLastStatusChange

SetLastStatusChange sets the LastStatusChange field's value.

func (*AwsEc2VpnConnectionVgwTelemetryDetails) SetOutsideIpAddress

SetOutsideIpAddress sets the OutsideIpAddress field's value.

func (*AwsEc2VpnConnectionVgwTelemetryDetails) SetStatus

SetStatus sets the Status field's value.

func (*AwsEc2VpnConnectionVgwTelemetryDetails) SetStatusMessage

SetStatusMessage sets the StatusMessage field's value.

func (AwsEc2VpnConnectionVgwTelemetryDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcrContainerImageDetails

type AwsEcrContainerImageDetails struct {

	// The architecture of the image. Valid values are as follows:
	//
	//    * arm64
	//
	//    * i386
	//
	//    * x86_64
	Architecture *string `type:"string"`

	// The sha256 digest of the image manifest.
	ImageDigest *string `type:"string"`

	// The date and time when the image was pushed to the repository.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	ImagePublishedAt *string `type:"string"`

	// The list of tags that are associated with the image.
	ImageTags []*string `type:"list"`

	// The Amazon Web Services account identifier that is associated with the registry
	// that the image belongs to.
	RegistryId *string `type:"string"`

	// The name of the repository that the image belongs to.
	RepositoryName *string `type:"string"`
	// contains filtered or unexported fields
}

Information about an Amazon ECR image.

func (AwsEcrContainerImageDetails) GoString

func (s AwsEcrContainerImageDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcrContainerImageDetails) SetArchitecture

SetArchitecture sets the Architecture field's value.

func (*AwsEcrContainerImageDetails) SetImageDigest

SetImageDigest sets the ImageDigest field's value.

func (*AwsEcrContainerImageDetails) SetImagePublishedAt

SetImagePublishedAt sets the ImagePublishedAt field's value.

func (*AwsEcrContainerImageDetails) SetImageTags

SetImageTags sets the ImageTags field's value.

func (*AwsEcrContainerImageDetails) SetRegistryId

SetRegistryId sets the RegistryId field's value.

func (*AwsEcrContainerImageDetails) SetRepositoryName

SetRepositoryName sets the RepositoryName field's value.

func (AwsEcrContainerImageDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcrRepositoryDetails

type AwsEcrRepositoryDetails struct {

	// The ARN of the repository.
	Arn *string `type:"string"`

	// The image scanning configuration for a repository.
	ImageScanningConfiguration *AwsEcrRepositoryImageScanningConfigurationDetails `type:"structure"`

	// The tag mutability setting for the repository. Valid values are IMMUTABLE
	// or MUTABLE.
	ImageTagMutability *string `type:"string"`

	// Information about the lifecycle policy for the repository.
	LifecyclePolicy *AwsEcrRepositoryLifecyclePolicyDetails `type:"structure"`

	// The name of the repository.
	RepositoryName *string `type:"string"`

	// The text of the repository policy.
	RepositoryPolicyText *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about an Amazon Elastic Container Registry repository.

func (AwsEcrRepositoryDetails) GoString

func (s AwsEcrRepositoryDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcrRepositoryDetails) SetArn

SetArn sets the Arn field's value.

func (*AwsEcrRepositoryDetails) SetImageScanningConfiguration

SetImageScanningConfiguration sets the ImageScanningConfiguration field's value.

func (*AwsEcrRepositoryDetails) SetImageTagMutability

func (s *AwsEcrRepositoryDetails) SetImageTagMutability(v string) *AwsEcrRepositoryDetails

SetImageTagMutability sets the ImageTagMutability field's value.

func (*AwsEcrRepositoryDetails) SetLifecyclePolicy

SetLifecyclePolicy sets the LifecyclePolicy field's value.

func (*AwsEcrRepositoryDetails) SetRepositoryName

func (s *AwsEcrRepositoryDetails) SetRepositoryName(v string) *AwsEcrRepositoryDetails

SetRepositoryName sets the RepositoryName field's value.

func (*AwsEcrRepositoryDetails) SetRepositoryPolicyText

func (s *AwsEcrRepositoryDetails) SetRepositoryPolicyText(v string) *AwsEcrRepositoryDetails

SetRepositoryPolicyText sets the RepositoryPolicyText field's value.

func (AwsEcrRepositoryDetails) String

func (s AwsEcrRepositoryDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcrRepositoryImageScanningConfigurationDetails

type AwsEcrRepositoryImageScanningConfigurationDetails struct {

	// Whether to scan images after they are pushed to a repository.
	ScanOnPush *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The image scanning configuration for a repository.

func (AwsEcrRepositoryImageScanningConfigurationDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcrRepositoryImageScanningConfigurationDetails) SetScanOnPush

SetScanOnPush sets the ScanOnPush field's value.

func (AwsEcrRepositoryImageScanningConfigurationDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcrRepositoryLifecyclePolicyDetails

type AwsEcrRepositoryLifecyclePolicyDetails struct {

	// The text of the lifecycle policy.
	LifecyclePolicyText *string `type:"string"`

	// The Amazon Web Services account identifier that is associated with the registry
	// that contains the repository.
	RegistryId *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the lifecycle policy for the repository.

func (AwsEcrRepositoryLifecyclePolicyDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcrRepositoryLifecyclePolicyDetails) SetLifecyclePolicyText

SetLifecyclePolicyText sets the LifecyclePolicyText field's value.

func (*AwsEcrRepositoryLifecyclePolicyDetails) SetRegistryId

SetRegistryId sets the RegistryId field's value.

func (AwsEcrRepositoryLifecyclePolicyDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsClusterClusterSettingsDetails

type AwsEcsClusterClusterSettingsDetails struct {

	// The name of the setting. The valid value is containerInsights.
	Name *string `type:"string"`

	// The value of the setting. Valid values are disabled or enabled.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Indicates whether to enable CloudWatch Container Insights for the ECS cluster.

func (AwsEcsClusterClusterSettingsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsClusterClusterSettingsDetails) SetName

SetName sets the Name field's value.

func (*AwsEcsClusterClusterSettingsDetails) SetValue

SetValue sets the Value field's value.

func (AwsEcsClusterClusterSettingsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsClusterConfigurationDetails

type AwsEcsClusterConfigurationDetails struct {

	// Contains the run command configuration for the cluster.
	ExecuteCommandConfiguration *AwsEcsClusterConfigurationExecuteCommandConfigurationDetails `type:"structure"`
	// contains filtered or unexported fields
}

The run command configuration for the cluster.

func (AwsEcsClusterConfigurationDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsClusterConfigurationDetails) SetExecuteCommandConfiguration

SetExecuteCommandConfiguration sets the ExecuteCommandConfiguration field's value.

func (AwsEcsClusterConfigurationDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsClusterConfigurationExecuteCommandConfigurationDetails

type AwsEcsClusterConfigurationExecuteCommandConfigurationDetails struct {

	// The identifier of the KMS key that is used to encrypt the data between the
	// local client and the container.
	KmsKeyId *string `type:"string"`

	// The log configuration for the results of the run command actions. Required
	// if Logging is NONE.
	LogConfiguration *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails `type:"structure"`

	// The log setting to use for redirecting logs for run command results.
	Logging *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the run command configuration for the cluster.

func (AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) SetKmsKeyId

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) SetLogConfiguration

SetLogConfiguration sets the LogConfiguration field's value.

func (*AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) SetLogging

SetLogging sets the Logging field's value.

func (AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails

type AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails struct {

	// Whether to enable encryption on the CloudWatch logs.
	CloudWatchEncryptionEnabled *bool `type:"boolean"`

	// The name of the CloudWatch log group to send the logs to.
	CloudWatchLogGroupName *string `type:"string"`

	// The name of the S3 bucket to send logs to.
	S3BucketName *string `type:"string"`

	// Whether to encrypt the logs that are sent to the S3 bucket.
	S3EncryptionEnabled *bool `type:"boolean"`

	// Identifies the folder in the S3 bucket to send the logs to.
	S3KeyPrefix *string `type:"string"`
	// contains filtered or unexported fields
}

The log configuration for the results of the run command actions.

func (AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetCloudWatchEncryptionEnabled

SetCloudWatchEncryptionEnabled sets the CloudWatchEncryptionEnabled field's value.

func (*AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetCloudWatchLogGroupName

SetCloudWatchLogGroupName sets the CloudWatchLogGroupName field's value.

func (*AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetS3BucketName

SetS3BucketName sets the S3BucketName field's value.

func (*AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetS3EncryptionEnabled

SetS3EncryptionEnabled sets the S3EncryptionEnabled field's value.

func (*AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetS3KeyPrefix

SetS3KeyPrefix sets the S3KeyPrefix field's value.

func (AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsClusterDefaultCapacityProviderStrategyDetails

type AwsEcsClusterDefaultCapacityProviderStrategyDetails struct {

	// The minimum number of tasks to run on the specified capacity provider.
	Base *int64 `type:"integer"`

	// The name of the capacity provider.
	CapacityProvider *string `type:"string"`

	// The relative percentage of the total number of tasks launched that should
	// use the capacity provider.
	Weight *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.

func (AwsEcsClusterDefaultCapacityProviderStrategyDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsClusterDefaultCapacityProviderStrategyDetails) SetBase

SetBase sets the Base field's value.

func (*AwsEcsClusterDefaultCapacityProviderStrategyDetails) SetCapacityProvider

SetCapacityProvider sets the CapacityProvider field's value.

func (*AwsEcsClusterDefaultCapacityProviderStrategyDetails) SetWeight

SetWeight sets the Weight field's value.

func (AwsEcsClusterDefaultCapacityProviderStrategyDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsClusterDetails

type AwsEcsClusterDetails struct {

	// The number of services that are running on the cluster in an ACTIVE state.
	// You can view these services with the Amazon ECS ListServices (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html)
	// API operation.
	ActiveServicesCount *int64 `type:"integer"`

	// The short name of one or more capacity providers to associate with the cluster.
	CapacityProviders []*string `type:"list"`

	// The Amazon Resource Name (ARN) that identifies the cluster.
	ClusterArn *string `type:"string"`

	// A name that you use to identify your cluster.
	ClusterName *string `type:"string"`

	// The setting to use to create the cluster. Specifically used to configure
	// whether to enable CloudWatch Container Insights for the cluster.
	ClusterSettings []*AwsEcsClusterClusterSettingsDetails `type:"list"`

	// The run command configuration for the cluster.
	Configuration *AwsEcsClusterConfigurationDetails `type:"structure"`

	// The default capacity provider strategy for the cluster. The default capacity
	// provider strategy is used when services or tasks are run without a specified
	// launch type or capacity provider strategy.
	DefaultCapacityProviderStrategy []*AwsEcsClusterDefaultCapacityProviderStrategyDetails `type:"list"`

	// The number of container instances registered into the cluster. This includes
	// container instances in both ACTIVE and DRAINING status.
	RegisteredContainerInstancesCount *int64 `type:"integer"`

	// The number of tasks in the cluster that are in the RUNNING state.
	RunningTasksCount *int64 `type:"integer"`

	// The status of the cluster.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about an Amazon ECS cluster.

func (AwsEcsClusterDetails) GoString

func (s AwsEcsClusterDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsClusterDetails) SetActiveServicesCount added in v1.42.9

func (s *AwsEcsClusterDetails) SetActiveServicesCount(v int64) *AwsEcsClusterDetails

SetActiveServicesCount sets the ActiveServicesCount field's value.

func (*AwsEcsClusterDetails) SetCapacityProviders

func (s *AwsEcsClusterDetails) SetCapacityProviders(v []*string) *AwsEcsClusterDetails

SetCapacityProviders sets the CapacityProviders field's value.

func (*AwsEcsClusterDetails) SetClusterArn added in v1.42.9

func (s *AwsEcsClusterDetails) SetClusterArn(v string) *AwsEcsClusterDetails

SetClusterArn sets the ClusterArn field's value.

func (*AwsEcsClusterDetails) SetClusterName added in v1.42.9

func (s *AwsEcsClusterDetails) SetClusterName(v string) *AwsEcsClusterDetails

SetClusterName sets the ClusterName field's value.

func (*AwsEcsClusterDetails) SetClusterSettings

SetClusterSettings sets the ClusterSettings field's value.

func (*AwsEcsClusterDetails) SetConfiguration

SetConfiguration sets the Configuration field's value.

func (*AwsEcsClusterDetails) SetDefaultCapacityProviderStrategy

SetDefaultCapacityProviderStrategy sets the DefaultCapacityProviderStrategy field's value.

func (*AwsEcsClusterDetails) SetRegisteredContainerInstancesCount added in v1.42.9

func (s *AwsEcsClusterDetails) SetRegisteredContainerInstancesCount(v int64) *AwsEcsClusterDetails

SetRegisteredContainerInstancesCount sets the RegisteredContainerInstancesCount field's value.

func (*AwsEcsClusterDetails) SetRunningTasksCount added in v1.42.9

func (s *AwsEcsClusterDetails) SetRunningTasksCount(v int64) *AwsEcsClusterDetails

SetRunningTasksCount sets the RunningTasksCount field's value.

func (*AwsEcsClusterDetails) SetStatus added in v1.42.9

SetStatus sets the Status field's value.

func (AwsEcsClusterDetails) String

func (s AwsEcsClusterDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsContainerDetails added in v1.42.9

type AwsEcsContainerDetails struct {

	// The image used for the container.
	Image *string `type:"string"`

	// The mount points for data volumes in your container.
	MountPoints []*AwsMountPoint `type:"list"`

	// The name of the container.
	Name *string `type:"string"`

	// When this parameter is true, the container is given elevated privileges on
	// the host container instance (similar to the root user).
	Privileged *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Provides information about an Amazon ECS container.

func (AwsEcsContainerDetails) GoString added in v1.42.9

func (s AwsEcsContainerDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsContainerDetails) SetImage added in v1.42.9

SetImage sets the Image field's value.

func (*AwsEcsContainerDetails) SetMountPoints added in v1.42.9

SetMountPoints sets the MountPoints field's value.

func (*AwsEcsContainerDetails) SetName added in v1.42.9

SetName sets the Name field's value.

func (*AwsEcsContainerDetails) SetPrivileged added in v1.42.9

func (s *AwsEcsContainerDetails) SetPrivileged(v bool) *AwsEcsContainerDetails

SetPrivileged sets the Privileged field's value.

func (AwsEcsContainerDetails) String added in v1.42.9

func (s AwsEcsContainerDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsServiceCapacityProviderStrategyDetails

type AwsEcsServiceCapacityProviderStrategyDetails struct {

	// The minimum number of tasks to run on the capacity provider. Only one strategy
	// item can specify a value for Base.
	//
	// The value must be between 0 and 100000.
	Base *int64 `type:"integer"`

	// The short name of the capacity provider.
	CapacityProvider *string `type:"string"`

	// The relative percentage of the total number of tasks that should use the
	// capacity provider.
	//
	// If no weight is specified, the default value is 0. At least one capacity
	// provider must have a weight greater than 0.
	//
	// The value can be between 0 and 1000.
	Weight *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Strategy item for the capacity provider strategy that the service uses.

func (AwsEcsServiceCapacityProviderStrategyDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsServiceCapacityProviderStrategyDetails) SetBase

SetBase sets the Base field's value.

func (*AwsEcsServiceCapacityProviderStrategyDetails) SetCapacityProvider

SetCapacityProvider sets the CapacityProvider field's value.

func (*AwsEcsServiceCapacityProviderStrategyDetails) SetWeight

SetWeight sets the Weight field's value.

func (AwsEcsServiceCapacityProviderStrategyDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails

type AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails struct {

	// Whether to enable the deployment circuit breaker logic for the service.
	Enable *bool `type:"boolean"`

	// Whether to roll back the service if a service deployment fails. If rollback
	// is enabled, when a service deployment fails, the service is rolled back to
	// the last deployment that completed successfully.
	Rollback *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Determines whether a service deployment fails if a service cannot reach a steady state.

func (AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails) SetEnable

SetEnable sets the Enable field's value.

func (*AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails) SetRollback

SetRollback sets the Rollback field's value.

func (AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsServiceDeploymentConfigurationDetails

type AwsEcsServiceDeploymentConfigurationDetails struct {

	// Determines whether a service deployment fails if a service cannot reach a
	// steady state.
	DeploymentCircuitBreaker *AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails `type:"structure"`

	// For a service that uses the rolling update (ECS) deployment type, the maximum
	// number of tasks in a service that are allowed in the RUNNING or PENDING state
	// during a deployment, and for tasks that use the EC2 launch type, when any
	// container instances are in the DRAINING state. Provided as a percentage of
	// the desired number of tasks. The default value is 200%.
	//
	// For a service that uses the blue/green (CODE_DEPLOY) or EXTERNAL deployment
	// types, and tasks that use the EC2 launch type, the maximum number of tasks
	// in the service that remain in the RUNNING state while the container instances
	// are in the DRAINING state.
	//
	// For the Fargate launch type, the maximum percent value is not used.
	MaximumPercent *int64 `type:"integer"`

	// For a service that uses the rolling update (ECS) deployment type, the minimum
	// number of tasks in a service that must remain in the RUNNING state during
	// a deployment, and while any container instances are in the DRAINING state
	// if the service contains tasks using the EC2 launch type. Expressed as a percentage
	// of the desired number of tasks. The default value is 100%.
	//
	// For a service that uses the blue/green (CODE_DEPLOY) or EXTERNAL deployment
	// types and tasks that use the EC2 launch type, the minimum number of the tasks
	// in the service that remain in the RUNNING state while the container instances
	// are in the DRAINING state.
	//
	// For the Fargate launch type, the minimum healthy percent value is not used.
	MinimumHealthyPercent *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Optional deployment parameters for the service.

func (AwsEcsServiceDeploymentConfigurationDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsServiceDeploymentConfigurationDetails) SetDeploymentCircuitBreaker

SetDeploymentCircuitBreaker sets the DeploymentCircuitBreaker field's value.

func (*AwsEcsServiceDeploymentConfigurationDetails) SetMaximumPercent

SetMaximumPercent sets the MaximumPercent field's value.

func (*AwsEcsServiceDeploymentConfigurationDetails) SetMinimumHealthyPercent

SetMinimumHealthyPercent sets the MinimumHealthyPercent field's value.

func (AwsEcsServiceDeploymentConfigurationDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsServiceDeploymentControllerDetails

type AwsEcsServiceDeploymentControllerDetails struct {

	// The rolling update (ECS) deployment type replaces the current running version
	// of the container with the latest version.
	//
	// The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment
	// model that is powered by CodeDeploy. This deployment model a new deployment
	// of a service can be verified before production traffic is sent to it.
	//
	// The external (EXTERNAL) deployment type allows the use of any third-party
	// deployment controller for full control over the deployment process for an
	// Amazon ECS service.
	//
	// Valid values: ECS | CODE_DEPLOY | EXTERNAL
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the deployment controller type that the service uses.

func (AwsEcsServiceDeploymentControllerDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsServiceDeploymentControllerDetails) SetType

SetType sets the Type field's value.

func (AwsEcsServiceDeploymentControllerDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsServiceDetails

type AwsEcsServiceDetails struct {

	// The capacity provider strategy that the service uses.
	CapacityProviderStrategy []*AwsEcsServiceCapacityProviderStrategyDetails `type:"list"`

	// The ARN of the cluster that hosts the service.
	Cluster *string `type:"string"`

	// Deployment parameters for the service. Includes the number of tasks that
	// run and the order in which to start and stop tasks.
	DeploymentConfiguration *AwsEcsServiceDeploymentConfigurationDetails `type:"structure"`

	// Contains the deployment controller type that the service uses.
	DeploymentController *AwsEcsServiceDeploymentControllerDetails `type:"structure"`

	// The number of instantiations of the task definition to run on the service.
	DesiredCount *int64 `type:"integer"`

	// Whether to enable Amazon ECS managed tags for the tasks in the service.
	EnableEcsManagedTags *bool `type:"boolean"`

	// Whether the execute command functionality is enabled for the service.
	EnableExecuteCommand *bool `type:"boolean"`

	// After a task starts, the amount of time in seconds that the Amazon ECS service
	// scheduler ignores unhealthy Elastic Load Balancing target health checks.
	HealthCheckGracePeriodSeconds *int64 `type:"integer"`

	// The launch type that the service uses.
	//
	// Valid values: EC2 | FARGATE | EXTERNAL
	LaunchType *string `type:"string"`

	// Information about the load balancers that the service uses.
	LoadBalancers []*AwsEcsServiceLoadBalancersDetails `type:"list"`

	// The name of the service.
	Name *string `type:"string"`

	// For tasks that use the awsvpc networking mode, the VPC subnet and security
	// group configuration.
	NetworkConfiguration *AwsEcsServiceNetworkConfigurationDetails `type:"structure"`

	// The placement constraints for the tasks in the service.
	PlacementConstraints []*AwsEcsServicePlacementConstraintsDetails `type:"list"`

	// Information about how tasks for the service are placed.
	PlacementStrategies []*AwsEcsServicePlacementStrategiesDetails `type:"list"`

	// The platform version on which to run the service. Only specified for tasks
	// that are hosted on Fargate. If a platform version is not specified, the LATEST
	// platform version is used by default.
	PlatformVersion *string `type:"string"`

	// Indicates whether to propagate the tags from the task definition to the task
	// or from the service to the task. If no value is provided, then tags are not
	// propagated.
	//
	// Valid values: TASK_DEFINITION | SERVICE
	PropagateTags *string `type:"string"`

	// The ARN of the IAM role that is associated with the service. The role allows
	// the Amazon ECS container agent to register container instances with an Elastic
	// Load Balancing load balancer.
	Role *string `type:"string"`

	// The scheduling strategy to use for the service.
	//
	// The REPLICA scheduling strategy places and maintains the desired number of
	// tasks across the cluster. By default, the service scheduler spreads tasks
	// across Availability Zones. Task placement strategies and constraints are
	// used to customize task placement decisions.
	//
	// The DAEMON scheduling strategy deploys exactly one task on each active container
	// instance that meets all of the task placement constraints that are specified
	// in the cluster. The service scheduler also evaluates the task placement constraints
	// for running tasks and stops tasks that do not meet the placement constraints.
	//
	// Valid values: REPLICA | DAEMON
	SchedulingStrategy *string `type:"string"`

	// The ARN of the service.
	ServiceArn *string `type:"string"`

	// The name of the service.
	//
	// The name can contain up to 255 characters. It can use letters, numbers, underscores,
	// and hyphens.
	ServiceName *string `type:"string"`

	// Information about the service discovery registries to assign to the service.
	ServiceRegistries []*AwsEcsServiceServiceRegistriesDetails `type:"list"`

	// The task definition to use for tasks in the service.
	TaskDefinition *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about a service within an ECS cluster.

func (AwsEcsServiceDetails) GoString

func (s AwsEcsServiceDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsServiceDetails) SetCapacityProviderStrategy

SetCapacityProviderStrategy sets the CapacityProviderStrategy field's value.

func (*AwsEcsServiceDetails) SetCluster

SetCluster sets the Cluster field's value.

func (*AwsEcsServiceDetails) SetDeploymentConfiguration

SetDeploymentConfiguration sets the DeploymentConfiguration field's value.

func (*AwsEcsServiceDetails) SetDeploymentController

SetDeploymentController sets the DeploymentController field's value.

func (*AwsEcsServiceDetails) SetDesiredCount

func (s *AwsEcsServiceDetails) SetDesiredCount(v int64) *AwsEcsServiceDetails

SetDesiredCount sets the DesiredCount field's value.

func (*AwsEcsServiceDetails) SetEnableEcsManagedTags

func (s *AwsEcsServiceDetails) SetEnableEcsManagedTags(v bool) *AwsEcsServiceDetails

SetEnableEcsManagedTags sets the EnableEcsManagedTags field's value.

func (*AwsEcsServiceDetails) SetEnableExecuteCommand

func (s *AwsEcsServiceDetails) SetEnableExecuteCommand(v bool) *AwsEcsServiceDetails

SetEnableExecuteCommand sets the EnableExecuteCommand field's value.

func (*AwsEcsServiceDetails) SetHealthCheckGracePeriodSeconds

func (s *AwsEcsServiceDetails) SetHealthCheckGracePeriodSeconds(v int64) *AwsEcsServiceDetails

SetHealthCheckGracePeriodSeconds sets the HealthCheckGracePeriodSeconds field's value.

func (*AwsEcsServiceDetails) SetLaunchType

func (s *AwsEcsServiceDetails) SetLaunchType(v string) *AwsEcsServiceDetails

SetLaunchType sets the LaunchType field's value.

func (*AwsEcsServiceDetails) SetLoadBalancers

SetLoadBalancers sets the LoadBalancers field's value.

func (*AwsEcsServiceDetails) SetName

SetName sets the Name field's value.

func (*AwsEcsServiceDetails) SetNetworkConfiguration

SetNetworkConfiguration sets the NetworkConfiguration field's value.

func (*AwsEcsServiceDetails) SetPlacementConstraints

SetPlacementConstraints sets the PlacementConstraints field's value.

func (*AwsEcsServiceDetails) SetPlacementStrategies

SetPlacementStrategies sets the PlacementStrategies field's value.

func (*AwsEcsServiceDetails) SetPlatformVersion

func (s *AwsEcsServiceDetails) SetPlatformVersion(v string) *AwsEcsServiceDetails

SetPlatformVersion sets the PlatformVersion field's value.

func (*AwsEcsServiceDetails) SetPropagateTags

func (s *AwsEcsServiceDetails) SetPropagateTags(v string) *AwsEcsServiceDetails

SetPropagateTags sets the PropagateTags field's value.

func (*AwsEcsServiceDetails) SetRole

SetRole sets the Role field's value.

func (*AwsEcsServiceDetails) SetSchedulingStrategy

func (s *AwsEcsServiceDetails) SetSchedulingStrategy(v string) *AwsEcsServiceDetails

SetSchedulingStrategy sets the SchedulingStrategy field's value.

func (*AwsEcsServiceDetails) SetServiceArn

func (s *AwsEcsServiceDetails) SetServiceArn(v string) *AwsEcsServiceDetails

SetServiceArn sets the ServiceArn field's value.

func (*AwsEcsServiceDetails) SetServiceName

func (s *AwsEcsServiceDetails) SetServiceName(v string) *AwsEcsServiceDetails

SetServiceName sets the ServiceName field's value.

func (*AwsEcsServiceDetails) SetServiceRegistries

SetServiceRegistries sets the ServiceRegistries field's value.

func (*AwsEcsServiceDetails) SetTaskDefinition

func (s *AwsEcsServiceDetails) SetTaskDefinition(v string) *AwsEcsServiceDetails

SetTaskDefinition sets the TaskDefinition field's value.

func (AwsEcsServiceDetails) String

func (s AwsEcsServiceDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsServiceLoadBalancersDetails

type AwsEcsServiceLoadBalancersDetails struct {

	// The name of the container to associate with the load balancer.
	ContainerName *string `type:"string"`

	// The port on the container to associate with the load balancer. This port
	// must correspond to a containerPort in the task definition the tasks in the
	// service are using. For tasks that use the EC2 launch type, the container
	// instance they are launched on must allow ingress traffic on the hostPort
	// of the port mapping.
	ContainerPort *int64 `type:"integer"`

	// The name of the load balancer to associate with the Amazon ECS service or
	// task set.
	//
	// Only specified when using a Classic Load Balancer. For an Application Load
	// Balancer or a Network Load Balancer, the load balancer name is omitted.
	LoadBalancerName *string `type:"string"`

	// The ARN of the Elastic Load Balancing target group or groups associated with
	// a service or task set.
	//
	// Only specified when using an Application Load Balancer or a Network Load
	// Balancer. For a Classic Load Balancer, the target group ARN is omitted.
	TargetGroupArn *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a load balancer that the service uses.

func (AwsEcsServiceLoadBalancersDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsServiceLoadBalancersDetails) SetContainerName

SetContainerName sets the ContainerName field's value.

func (*AwsEcsServiceLoadBalancersDetails) SetContainerPort

SetContainerPort sets the ContainerPort field's value.

func (*AwsEcsServiceLoadBalancersDetails) SetLoadBalancerName

SetLoadBalancerName sets the LoadBalancerName field's value.

func (*AwsEcsServiceLoadBalancersDetails) SetTargetGroupArn

SetTargetGroupArn sets the TargetGroupArn field's value.

func (AwsEcsServiceLoadBalancersDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails

type AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails struct {

	// Whether the task's elastic network interface receives a public IP address.
	// The default value is DISABLED.
	//
	// Valid values: ENABLED | DISABLED
	AssignPublicIp *string `type:"string"`

	// The IDs of the security groups associated with the task or service.
	//
	// You can provide up to five security groups.
	SecurityGroups []*string `type:"list"`

	// The IDs of the subnets associated with the task or service.
	//
	// You can provide up to 16 subnets.
	Subnets []*string `type:"list"`
	// contains filtered or unexported fields
}

For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.

func (AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails) SetAssignPublicIp

SetAssignPublicIp sets the AssignPublicIp field's value.

func (*AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails) SetSecurityGroups

SetSecurityGroups sets the SecurityGroups field's value.

func (*AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails) SetSubnets

SetSubnets sets the Subnets field's value.

func (AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsServiceNetworkConfigurationDetails

type AwsEcsServiceNetworkConfigurationDetails struct {

	// The VPC subnet and security group configuration.
	AwsVpcConfiguration *AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails `type:"structure"`
	// contains filtered or unexported fields
}

For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.

func (AwsEcsServiceNetworkConfigurationDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsServiceNetworkConfigurationDetails) SetAwsVpcConfiguration

SetAwsVpcConfiguration sets the AwsVpcConfiguration field's value.

func (AwsEcsServiceNetworkConfigurationDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsServicePlacementConstraintsDetails

type AwsEcsServicePlacementConstraintsDetails struct {

	// A cluster query language expression to apply to the constraint. You cannot
	// specify an expression if the constraint type is distinctInstance.
	Expression *string `type:"string"`

	// The type of constraint. Use distinctInstance to run each task in a particular
	// group on a different container instance. Use memberOf to restrict the selection
	// to a group of valid candidates.
	//
	// Valid values: distinctInstance | memberOf
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

A placement constraint for the tasks in the service.

func (AwsEcsServicePlacementConstraintsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsServicePlacementConstraintsDetails) SetExpression

SetExpression sets the Expression field's value.

func (*AwsEcsServicePlacementConstraintsDetails) SetType

SetType sets the Type field's value.

func (AwsEcsServicePlacementConstraintsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsServicePlacementStrategiesDetails

type AwsEcsServicePlacementStrategiesDetails struct {

	// The field to apply the placement strategy against.
	//
	// For the spread placement strategy, valid values are instanceId (or host,
	// which has the same effect), or any platform or custom attribute that is applied
	// to a container instance, such as attribute:ecs.availability-zone.
	//
	// For the binpack placement strategy, valid values are cpu and memory.
	//
	// For the random placement strategy, this attribute is not used.
	Field *string `type:"string"`

	// The type of placement strategy.
	//
	// The random placement strategy randomly places tasks on available candidates.
	//
	// The spread placement strategy spreads placement across available candidates
	// evenly based on the value of Field.
	//
	// The binpack strategy places tasks on available candidates that have the least
	// available amount of the resource that is specified in Field.
	//
	// Valid values: random | spread | binpack
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

A placement strategy that determines how to place the tasks for the service.

func (AwsEcsServicePlacementStrategiesDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsServicePlacementStrategiesDetails) SetField

SetField sets the Field field's value.

func (*AwsEcsServicePlacementStrategiesDetails) SetType

SetType sets the Type field's value.

func (AwsEcsServicePlacementStrategiesDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsServiceServiceRegistriesDetails

type AwsEcsServiceServiceRegistriesDetails struct {

	// The container name value to use for the service discovery service.
	//
	// If the task definition uses the bridge or host network mode, you must specify
	// ContainerName and ContainerPort.
	//
	// If the task definition uses the awsvpc network mode and a type SRV DNS record,
	// you must specify either ContainerName and ContainerPort, or Port , but not
	// both.
	ContainerName *string `type:"string"`

	// The port value to use for the service discovery service.
	//
	// If the task definition uses the bridge or host network mode, you must specify
	// ContainerName and ContainerPort.
	//
	// If the task definition uses the awsvpc network mode and a type SRV DNS record,
	// you must specify either ContainerName and ContainerPort, or Port , but not
	// both.
	ContainerPort *int64 `type:"integer"`

	// The port value to use for a service discovery service that specifies an SRV
	// record. This field can be used if both the awsvpcawsvpc network mode and
	// SRV records are used.
	Port *int64 `type:"integer"`

	// The ARN of the service registry.
	RegistryArn *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a service discovery registry to assign to the service.

func (AwsEcsServiceServiceRegistriesDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsServiceServiceRegistriesDetails) SetContainerName

SetContainerName sets the ContainerName field's value.

func (*AwsEcsServiceServiceRegistriesDetails) SetContainerPort

SetContainerPort sets the ContainerPort field's value.

func (*AwsEcsServiceServiceRegistriesDetails) SetPort

SetPort sets the Port field's value.

func (*AwsEcsServiceServiceRegistriesDetails) SetRegistryArn

SetRegistryArn sets the RegistryArn field's value.

func (AwsEcsServiceServiceRegistriesDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails

type AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails struct {

	// The dependency condition of the dependent container. Indicates the required
	// status of the dependent container before the current container can start.
	// Valid values are as follows:
	//
	//    * COMPLETE
	//
	//    * HEALTHY
	//
	//    * SUCCESS
	//
	//    * START
	Condition *string `type:"string"`

	// The name of the dependent container.
	ContainerName *string `type:"string"`
	// contains filtered or unexported fields
}

A dependency that is defined for container startup and shutdown.

func (AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails) SetCondition

SetCondition sets the Condition field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails) SetContainerName

SetContainerName sets the ContainerName field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsDetails

type AwsEcsTaskDefinitionContainerDefinitionsDetails struct {

	// The command that is passed to the container.
	Command []*string `type:"list"`

	// The number of CPU units reserved for the container.
	Cpu *int64 `type:"integer"`

	// The dependencies that are defined for container startup and shutdown.
	DependsOn []*AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails `type:"list"`

	// Whether to disable networking within the container.
	DisableNetworking *bool `type:"boolean"`

	// A list of DNS search domains that are presented to the container.
	DnsSearchDomains []*string `type:"list"`

	// A list of DNS servers that are presented to the container.
	DnsServers []*string `type:"list"`

	// A key-value map of labels to add to the container.
	DockerLabels map[string]*string `type:"map"`

	// A list of strings to provide custom labels for SELinux and AppArmor multi-level
	// security systems.
	DockerSecurityOptions []*string `type:"list"`

	// The entry point that is passed to the container.
	EntryPoint []*string `type:"list"`

	// The environment variables to pass to a container.
	Environment []*AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails `type:"list"`

	// A list of files containing the environment variables to pass to a container.
	EnvironmentFiles []*AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails `type:"list"`

	// Whether the container is essential. All tasks must have at least one essential
	// container.
	Essential *bool `type:"boolean"`

	// A list of hostnames and IP address mappings to append to the /etc/hosts file
	// on the container.
	ExtraHosts []*AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails `type:"list"`

	// The FireLens configuration for the container. Specifies and configures a
	// log router for container logs.
	FirelensConfiguration *AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails `type:"structure"`

	// The container health check command and associated configuration parameters
	// for the container.
	HealthCheck *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails `type:"structure"`

	// The hostname to use for the container.
	Hostname *string `type:"string"`

	// The image used to start the container.
	Image *string `type:"string"`

	// If set to true, then containerized applications can be deployed that require
	// stdin or a tty to be allocated.
	Interactive *bool `type:"boolean"`

	// A list of links for the container in the form container_name:alias . Allows
	// containers to communicate with each other without the need for port mappings.
	Links []*string `type:"list"`

	// Linux-specific modifications that are applied to the container, such as Linux
	// kernel capabilities.
	LinuxParameters *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails `type:"structure"`

	// The log configuration specification for the container.
	LogConfiguration *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails `type:"structure"`

	// The amount (in MiB) of memory to present to the container. If the container
	// attempts to exceed the memory specified here, the container is shut down.
	// The total amount of memory reserved for all containers within a task must
	// be lower than the task memory value, if one is specified.
	Memory *int64 `type:"integer"`

	// The soft limit (in MiB) of memory to reserve for the container.
	MemoryReservation *int64 `type:"integer"`

	// The mount points for the data volumes in the container.
	MountPoints []*AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails `type:"list"`

	// The name of the container.
	Name *string `type:"string"`

	// The list of port mappings for the container.
	PortMappings []*AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails `type:"list"`

	// Whether the container is given elevated privileges on the host container
	// instance. The elevated privileges are similar to the root user.
	Privileged *bool `type:"boolean"`

	// Whether to allocate a TTY to the container.
	PseudoTerminal *bool `type:"boolean"`

	// Whether the container is given read-only access to its root file system.
	ReadonlyRootFilesystem *bool `type:"boolean"`

	// The private repository authentication credentials to use.
	RepositoryCredentials *AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails `type:"structure"`

	// The type and amount of a resource to assign to a container. The only supported
	// resource is a GPU.
	ResourceRequirements []*AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails `type:"list"`

	// The secrets to pass to the container.
	Secrets []*AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails `type:"list"`

	// The number of seconds to wait before giving up on resolving dependencies
	// for a container.
	StartTimeout *int64 `type:"integer"`

	// The number of seconds to wait before the container is stopped if it doesn't
	// shut down normally on its own.
	StopTimeout *int64 `type:"integer"`

	// A list of namespaced kernel parameters to set in the container.
	SystemControls []*AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails `type:"list"`

	// A list of ulimits to set in the container.
	Ulimits []*AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails `type:"list"`

	// The user to use inside the container.
	//
	// The value can use one of the following formats.
	//
	//    * user
	//
	//    * user :group
	//
	//    * uid
	//
	//    * uid :gid
	//
	//    * user :gid
	//
	//    * uid :group
	User *string `type:"string"`

	// Data volumes to mount from another container.
	VolumesFrom []*AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails `type:"list"`

	// The working directory in which to run commands inside the container.
	WorkingDirectory *string `type:"string"`
	// contains filtered or unexported fields
}

A container definition that describes a container in the task.

func (AwsEcsTaskDefinitionContainerDefinitionsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetCommand

SetCommand sets the Command field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetCpu

SetCpu sets the Cpu field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDependsOn

SetDependsOn sets the DependsOn field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDisableNetworking

SetDisableNetworking sets the DisableNetworking field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDnsSearchDomains

SetDnsSearchDomains sets the DnsSearchDomains field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDnsServers

SetDnsServers sets the DnsServers field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDockerLabels

SetDockerLabels sets the DockerLabels field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDockerSecurityOptions

SetDockerSecurityOptions sets the DockerSecurityOptions field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetEntryPoint

SetEntryPoint sets the EntryPoint field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetEnvironment

SetEnvironment sets the Environment field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetEnvironmentFiles

SetEnvironmentFiles sets the EnvironmentFiles field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetEssential

SetEssential sets the Essential field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetExtraHosts

SetExtraHosts sets the ExtraHosts field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetFirelensConfiguration

SetFirelensConfiguration sets the FirelensConfiguration field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetHealthCheck

SetHealthCheck sets the HealthCheck field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetHostname

SetHostname sets the Hostname field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetImage

SetImage sets the Image field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetInteractive

SetInteractive sets the Interactive field's value.

SetLinks sets the Links field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetLinuxParameters

SetLinuxParameters sets the LinuxParameters field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetLogConfiguration

SetLogConfiguration sets the LogConfiguration field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetMemory

SetMemory sets the Memory field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetMemoryReservation

SetMemoryReservation sets the MemoryReservation field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetMountPoints

SetMountPoints sets the MountPoints field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetName

SetName sets the Name field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetPortMappings

SetPortMappings sets the PortMappings field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetPrivileged

SetPrivileged sets the Privileged field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetPseudoTerminal

SetPseudoTerminal sets the PseudoTerminal field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetReadonlyRootFilesystem

SetReadonlyRootFilesystem sets the ReadonlyRootFilesystem field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetRepositoryCredentials

SetRepositoryCredentials sets the RepositoryCredentials field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetResourceRequirements

SetResourceRequirements sets the ResourceRequirements field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetSecrets

SetSecrets sets the Secrets field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetStartTimeout

SetStartTimeout sets the StartTimeout field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetStopTimeout

SetStopTimeout sets the StopTimeout field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetSystemControls

SetSystemControls sets the SystemControls field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetUlimits

SetUlimits sets the Ulimits field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetUser

SetUser sets the User field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetVolumesFrom

SetVolumesFrom sets the VolumesFrom field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsDetails) SetWorkingDirectory

SetWorkingDirectory sets the WorkingDirectory field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails

type AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails struct {

	// The name of the environment variable.
	Name *string `type:"string"`

	// The value of the environment variable.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

An environment variable to pass to the container.

func (AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails) SetName

SetName sets the Name field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails) SetValue

SetValue sets the Value field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails

type AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails struct {

	// The type of environment file. The valid value is s3.
	Type *string `type:"string"`

	// The ARN of the S3 object that contains the environment variable file.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A file that contain environment variables to pass to a container.

func (AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails) SetType

SetType sets the Type field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails) SetValue

SetValue sets the Value field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails

type AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails struct {

	// The hostname to use in the /etc/hosts entry.
	Hostname *string `type:"string"`

	// The IP address to use in the /etc/hosts entry.
	IpAddress *string `type:"string"`
	// contains filtered or unexported fields
}

A hostname and IP address mapping to append to the /etc/hosts file on the container.

func (AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails) SetHostname

SetHostname sets the Hostname field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails) SetIpAddress

SetIpAddress sets the IpAddress field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails

type AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails struct {

	// The options to use to configure the log router.
	//
	// The valid option keys are as follows:
	//
	//    * enable-ecs-log-metadata. The value can be true or false.
	//
	//    * config-file-type. The value can be s3 or file.
	//
	//    * config-file-value. The value is either an S3 ARN or a file path.
	Options map[string]*string `type:"map"`

	// The log router to use. Valid values are fluentbit or fluentd.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

The FireLens configuration for the container. The configuration specifies and configures a log router for container logs.

func (AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails) SetOptions

SetOptions sets the Options field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails) SetType

SetType sets the Type field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails

type AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails struct {

	// The command that the container runs to determine whether it is healthy.
	Command []*string `type:"list"`

	// The time period in seconds between each health check execution. The default
	// value is 30 seconds.
	Interval *int64 `type:"integer"`

	// The number of times to retry a failed health check before the container is
	// considered unhealthy. The default value is 3.
	Retries *int64 `type:"integer"`

	// The optional grace period in seconds that allows containers time to bootstrap
	// before failed health checks count towards the maximum number of retries.
	StartPeriod *int64 `type:"integer"`

	// The time period in seconds to wait for a health check to succeed before it
	// is considered a failure. The default value is 5.
	Timeout *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The container health check command and associated configuration parameters for the container.

func (AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetCommand

SetCommand sets the Command field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetInterval

SetInterval sets the Interval field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetRetries

SetRetries sets the Retries field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetStartPeriod

SetStartPeriod sets the StartPeriod field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetTimeout

SetTimeout sets the Timeout field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails

type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails struct {

	// The Linux capabilities for the container that are added to the default configuration
	// provided by Docker. Valid values are as follows:
	//
	// Valid values: "ALL" | "AUDIT_CONTROL" |"AUDIT_WRITE" | "BLOCK_SUSPEND" |
	// "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK"
	// | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" |"MAC_OVERRIDE"
	// | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW"
	// | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT"
	// | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" |
	// "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" |
	// "WAKE_ALARM"
	Add []*string `type:"list"`

	// The Linux capabilities for the container that are dropped from the default
	// configuration provided by Docker.
	//
	// Valid values: "ALL" | "AUDIT_CONTROL" |"AUDIT_WRITE" | "BLOCK_SUSPEND" |
	// "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK"
	// | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" |"MAC_OVERRIDE"
	// | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW"
	// | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT"
	// | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" |
	// "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" |
	// "WAKE_ALARM"
	Drop []*string `type:"list"`
	// contains filtered or unexported fields
}

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

func (AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails) SetAdd

SetAdd sets the Add field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails) SetDrop

SetDrop sets the Drop field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails

type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails struct {

	// The Linux capabilities for the container that are added to or dropped from
	// the default configuration provided by Docker.
	Capabilities *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails `type:"structure"`

	// The host devices to expose to the container.
	Devices []*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails `type:"list"`

	// Whether to run an init process inside the container that forwards signals
	// and reaps processes.
	InitProcessEnabled *bool `type:"boolean"`

	// The total amount of swap memory (in MiB) that a container can use.
	MaxSwap *int64 `type:"integer"`

	// The value for the size (in MiB) of the /dev/shm volume.
	SharedMemorySize *int64 `type:"integer"`

	// Configures the container's memory swappiness behavior. Determines how aggressively
	// pages are swapped. The higher the value, the more aggressive the swappiness.
	// The default is 60.
	Swappiness *int64 `type:"integer"`

	// The container path, mount options, and size (in MiB) of the tmpfs mount.
	Tmpfs []*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails `type:"list"`
	// contains filtered or unexported fields
}

>Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.

func (AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetCapabilities

SetCapabilities sets the Capabilities field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetDevices

SetDevices sets the Devices field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetInitProcessEnabled

SetInitProcessEnabled sets the InitProcessEnabled field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetMaxSwap

SetMaxSwap sets the MaxSwap field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetSharedMemorySize

SetSharedMemorySize sets the SharedMemorySize field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetSwappiness

SetSwappiness sets the Swappiness field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetTmpfs

SetTmpfs sets the Tmpfs field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails

type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails struct {

	// The path inside the container at which to expose the host device.
	ContainerPath *string `type:"string"`

	// The path for the device on the host container instance.
	HostPath *string `type:"string"`

	// The explicit permissions to provide to the container for the device. By default,
	// the container has permissions for read, write, and mknod for the device.
	Permissions []*string `type:"list"`
	// contains filtered or unexported fields
}

A host device to expose to the container.

func (AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) SetContainerPath

SetContainerPath sets the ContainerPath field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) SetHostPath

SetHostPath sets the HostPath field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) SetPermissions

SetPermissions sets the Permissions field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails

type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails struct {

	// The absolute file path where the tmpfs volume is to be mounted.
	ContainerPath *string `type:"string"`

	// The list of tmpfs volume mount options.
	//
	// Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev"
	// |"exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" |
	// "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind"
	// | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared"
	// | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime"
	// |"mode" | "uid" | "gid" | "nr_inodes" |"nr_blocks" | "mpol"
	MountOptions []*string `type:"list"`

	// The maximum size (in MiB) of the tmpfs volume.
	Size *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The container path, mount options, and size (in MiB) of a tmpfs mount.

func (AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) SetContainerPath

SetContainerPath sets the ContainerPath field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) SetMountOptions

SetMountOptions sets the MountOptions field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) SetSize

SetSize sets the Size field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails

type AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails struct {

	// The log driver to use for the container.
	//
	// Valid values on Fargate are as follows:
	//
	//    * awsfirelens
	//
	//    * awslogs
	//
	//    * splunk
	//
	// Valid values on Amazon EC2 are as follows:
	//
	//    * awsfirelens
	//
	//    * awslogs
	//
	//    * fluentd
	//
	//    * gelf
	//
	//    * journald
	//
	//    * json-file
	//
	//    * logentries
	//
	//    * splunk
	//
	//    * syslog
	LogDriver *string `type:"string"`

	// The configuration options to send to the log driver. Requires version 1.19
	// of the Docker Remote API or greater on your container instance.
	Options map[string]*string `type:"map"`

	// The secrets to pass to the log configuration.
	SecretOptions []*AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails `type:"list"`
	// contains filtered or unexported fields
}

The log configuration specification for the container.

func (AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) SetLogDriver

SetLogDriver sets the LogDriver field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) SetOptions

SetOptions sets the Options field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) SetSecretOptions

SetSecretOptions sets the SecretOptions field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails

type AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails struct {

	// The name of the secret.
	Name *string `type:"string"`

	// The secret to expose to the container.
	//
	// The value is either the full ARN of the Secrets Manager secret or the full
	// ARN of the parameter in the Systems Manager Parameter Store.
	ValueFrom *string `type:"string"`
	// contains filtered or unexported fields
}

A secret to pass to the log configuration.

func (AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails) SetName

SetName sets the Name field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails) SetValueFrom

SetValueFrom sets the ValueFrom field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails

type AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails struct {

	// The path on the container to mount the host volume at.
	ContainerPath *string `type:"string"`

	// Whether the container has read-only access to the volume.
	ReadOnly *bool `type:"boolean"`

	// The name of the volume to mount. Must match the name of a volume listed in
	// VolumeDetails for the task definition.
	SourceVolume *string `type:"string"`
	// contains filtered or unexported fields
}

A mount point for the data volumes in the container.

func (AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) SetContainerPath

SetContainerPath sets the ContainerPath field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) SetReadOnly

SetReadOnly sets the ReadOnly field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) SetSourceVolume

SetSourceVolume sets the SourceVolume field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails

type AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails struct {

	// The port number on the container that is bound to the user-specified or automatically
	// assigned host port.
	ContainerPort *int64 `type:"integer"`

	// The port number on the container instance to reserve for the container.
	HostPort *int64 `type:"integer"`

	// The protocol used for the port mapping. The default is tcp.
	Protocol *string `type:"string"`
	// contains filtered or unexported fields
}

A port mapping for the container.

func (AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) SetContainerPort

SetContainerPort sets the ContainerPort field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) SetHostPort

SetHostPort sets the HostPort field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) SetProtocol

SetProtocol sets the Protocol field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails

type AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails struct {

	// The ARN of the secret that contains the private repository credentials.
	CredentialsParameter *string `type:"string"`
	// contains filtered or unexported fields
}

The private repository authentication credentials to use.

func (AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails) SetCredentialsParameter

SetCredentialsParameter sets the CredentialsParameter field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails

type AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails struct {

	// The type of resource to assign to a container. Valid values are GPU or InferenceAccelerator.
	Type *string `type:"string"`

	// The value for the specified resource type.
	//
	// For GPU, the value is the number of physical GPUs the Amazon ECS container
	// agent reserves for the container.
	//
	// For InferenceAccelerator, the value should match the DeviceName attribute
	// of an entry in InferenceAccelerators.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A resource to assign to a container.

func (AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails) SetType

SetType sets the Type field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails) SetValue

SetValue sets the Value field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails

type AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails struct {

	// The name of the secret.
	Name *string `type:"string"`

	// The secret to expose to the container. The value is either the full ARN of
	// the Secrets Manager secret or the full ARN of the parameter in the Systems
	// Manager Parameter Store.
	ValueFrom *string `type:"string"`
	// contains filtered or unexported fields
}

A secret to pass to the container.

func (AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails) SetName

SetName sets the Name field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails) SetValueFrom

SetValueFrom sets the ValueFrom field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails

type AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails struct {

	// The namespaced kernel parameter for which to set a value.
	Namespace *string `type:"string"`

	// The value of the parameter.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A namespaced kernel parameter to set in the container.

func (AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails) SetNamespace

SetNamespace sets the Namespace field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails) SetValue

SetValue sets the Value field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails

type AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails struct {

	// The hard limit for the ulimit type.
	HardLimit *int64 `type:"integer"`

	// The type of the ulimit. Valid values are as follows:
	//
	//    * core
	//
	//    * cpu
	//
	//    * data
	//
	//    * fsize
	//
	//    * locks
	//
	//    * memlock
	//
	//    * msgqueue
	//
	//    * nice
	//
	//    * nofile
	//
	//    * nproc
	//
	//    * rss
	//
	//    * rtprio
	//
	//    * rttime
	//
	//    * sigpending
	//
	//    * stack
	Name *string `type:"string"`

	// The soft limit for the ulimit type.
	SoftLimit *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A ulimit to set in the container.

func (AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) SetHardLimit

SetHardLimit sets the HardLimit field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) SetName

SetName sets the Name field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) SetSoftLimit

SetSoftLimit sets the SoftLimit field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails

type AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails struct {

	// Whether the container has read-only access to the volume.
	ReadOnly *bool `type:"boolean"`

	// The name of another container within the same task definition from which
	// to mount volumes.
	SourceContainer *string `type:"string"`
	// contains filtered or unexported fields
}

A data volume to mount from another container.

func (AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails) SetReadOnly

SetReadOnly sets the ReadOnly field's value.

func (*AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails) SetSourceContainer

SetSourceContainer sets the SourceContainer field's value.

func (AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionDetails

type AwsEcsTaskDefinitionDetails struct {

	// The container definitions that describe the containers that make up the task.
	ContainerDefinitions []*AwsEcsTaskDefinitionContainerDefinitionsDetails `type:"list"`

	// The number of CPU units used by the task.Valid values are as follows:
	//
	//    * 256 (.25 vCPU)
	//
	//    * 512 (.5 vCPU)
	//
	//    * 1024 (1 vCPU)
	//
	//    * 2048 (2 vCPU)
	//
	//    * 4096 (4 vCPU)
	Cpu *string `type:"string"`

	// The ARN of the task execution role that grants the container agent permission
	// to make API calls on behalf of the container user.
	ExecutionRoleArn *string `type:"string"`

	// The name of a family that this task definition is registered to.
	Family *string `type:"string"`

	// The Elastic Inference accelerators to use for the containers in the task.
	InferenceAccelerators []*AwsEcsTaskDefinitionInferenceAcceleratorsDetails `type:"list"`

	// The inter-process communication (IPC) resource namespace to use for the containers
	// in the task. Valid values are as follows:
	//
	//    * host
	//
	//    * none
	//
	//    * task
	IpcMode *string `type:"string"`

	// The amount (in MiB) of memory used by the task.
	//
	// For tasks that are hosted on Amazon EC2, you can provide a task-level memory
	// value or a container-level memory value. For tasks that are hosted on Fargate,
	// you must use one of the specified values (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size)
	// in the Amazon Elastic Container Service Developer Guide , which determines
	// your range of supported values for the Cpu and Memory parameters.
	Memory *string `type:"string"`

	// The Docker networking mode to use for the containers in the task. Valid values
	// are as follows:
	//
	//    * awsvpc
	//
	//    * bridge
	//
	//    * host
	//
	//    * none
	NetworkMode *string `type:"string"`

	// The process namespace to use for the containers in the task. Valid values
	// are host or task.
	PidMode *string `type:"string"`

	// The placement constraint objects to use for tasks.
	PlacementConstraints []*AwsEcsTaskDefinitionPlacementConstraintsDetails `type:"list"`

	// The configuration details for the App Mesh proxy.
	ProxyConfiguration *AwsEcsTaskDefinitionProxyConfigurationDetails `type:"structure"`

	// The task launch types that the task definition was validated against.
	RequiresCompatibilities []*string `type:"list"`

	// The short name or ARN of the IAM role that grants containers in the task
	// permission to call Amazon Web Services API operations on your behalf.
	TaskRoleArn *string `type:"string"`

	// The data volume definitions for the task.
	Volumes []*AwsEcsTaskDefinitionVolumesDetails `type:"list"`
	// contains filtered or unexported fields
}

Details about a task definition. A task definition describes the container and volume definitions of an Amazon Elastic Container Service task.

func (AwsEcsTaskDefinitionDetails) GoString

func (s AwsEcsTaskDefinitionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionDetails) SetContainerDefinitions

SetContainerDefinitions sets the ContainerDefinitions field's value.

func (*AwsEcsTaskDefinitionDetails) SetCpu

SetCpu sets the Cpu field's value.

func (*AwsEcsTaskDefinitionDetails) SetExecutionRoleArn

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*AwsEcsTaskDefinitionDetails) SetFamily

SetFamily sets the Family field's value.

func (*AwsEcsTaskDefinitionDetails) SetInferenceAccelerators

SetInferenceAccelerators sets the InferenceAccelerators field's value.

func (*AwsEcsTaskDefinitionDetails) SetIpcMode

SetIpcMode sets the IpcMode field's value.

func (*AwsEcsTaskDefinitionDetails) SetMemory

SetMemory sets the Memory field's value.

func (*AwsEcsTaskDefinitionDetails) SetNetworkMode

SetNetworkMode sets the NetworkMode field's value.

func (*AwsEcsTaskDefinitionDetails) SetPidMode

SetPidMode sets the PidMode field's value.

func (*AwsEcsTaskDefinitionDetails) SetPlacementConstraints

SetPlacementConstraints sets the PlacementConstraints field's value.

func (*AwsEcsTaskDefinitionDetails) SetProxyConfiguration

SetProxyConfiguration sets the ProxyConfiguration field's value.

func (*AwsEcsTaskDefinitionDetails) SetRequiresCompatibilities

func (s *AwsEcsTaskDefinitionDetails) SetRequiresCompatibilities(v []*string) *AwsEcsTaskDefinitionDetails

SetRequiresCompatibilities sets the RequiresCompatibilities field's value.

func (*AwsEcsTaskDefinitionDetails) SetTaskRoleArn

SetTaskRoleArn sets the TaskRoleArn field's value.

func (*AwsEcsTaskDefinitionDetails) SetVolumes

SetVolumes sets the Volumes field's value.

func (AwsEcsTaskDefinitionDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionInferenceAcceleratorsDetails

type AwsEcsTaskDefinitionInferenceAcceleratorsDetails struct {

	// The Elastic Inference accelerator device name.
	DeviceName *string `type:"string"`

	// The Elastic Inference accelerator type to use.
	DeviceType *string `type:"string"`
	// contains filtered or unexported fields
}

An Elastic Inference accelerator to use for the containers in the task.

func (AwsEcsTaskDefinitionInferenceAcceleratorsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionInferenceAcceleratorsDetails) SetDeviceName

SetDeviceName sets the DeviceName field's value.

func (*AwsEcsTaskDefinitionInferenceAcceleratorsDetails) SetDeviceType

SetDeviceType sets the DeviceType field's value.

func (AwsEcsTaskDefinitionInferenceAcceleratorsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionPlacementConstraintsDetails

type AwsEcsTaskDefinitionPlacementConstraintsDetails struct {

	// A cluster query language expression to apply to the constraint.
	Expression *string `type:"string"`

	// The type of constraint.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

A placement constraint object to use for tasks.

func (AwsEcsTaskDefinitionPlacementConstraintsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionPlacementConstraintsDetails) SetExpression

SetExpression sets the Expression field's value.

func (*AwsEcsTaskDefinitionPlacementConstraintsDetails) SetType

SetType sets the Type field's value.

func (AwsEcsTaskDefinitionPlacementConstraintsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionProxyConfigurationDetails

type AwsEcsTaskDefinitionProxyConfigurationDetails struct {

	// The name of the container that will serve as the App Mesh proxy.
	ContainerName *string `type:"string"`

	// The set of network configuration parameters to provide to the Container Network
	// Interface (CNI) plugin, specified as key-value pairs.
	ProxyConfigurationProperties []*AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails `type:"list"`

	// The proxy type.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

The configuration details for the App Mesh proxy.

func (AwsEcsTaskDefinitionProxyConfigurationDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionProxyConfigurationDetails) SetContainerName

SetContainerName sets the ContainerName field's value.

func (*AwsEcsTaskDefinitionProxyConfigurationDetails) SetProxyConfigurationProperties

SetProxyConfigurationProperties sets the ProxyConfigurationProperties field's value.

func (*AwsEcsTaskDefinitionProxyConfigurationDetails) SetType

SetType sets the Type field's value.

func (AwsEcsTaskDefinitionProxyConfigurationDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails

type AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails struct {

	// The name of the property.
	Name *string `type:"string"`

	// The value of the property.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A network configuration parameter to provide to the Container Network Interface (CNI) plugin.

func (AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails) SetName

SetName sets the Name field's value.

func (*AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails) SetValue

SetValue sets the Value field's value.

func (AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionVolumesDetails

type AwsEcsTaskDefinitionVolumesDetails struct {

	// Information about a Docker volume.
	DockerVolumeConfiguration *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails `type:"structure"`

	// Information about the Amazon Elastic File System file system that is used
	// for task storage.
	EfsVolumeConfiguration *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails `type:"structure"`

	// Information about a bind mount host volume.
	Host *AwsEcsTaskDefinitionVolumesHostDetails `type:"structure"`

	// The name of the data volume.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

A data volume to mount from another container.

func (AwsEcsTaskDefinitionVolumesDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionVolumesDetails) SetDockerVolumeConfiguration

SetDockerVolumeConfiguration sets the DockerVolumeConfiguration field's value.

func (*AwsEcsTaskDefinitionVolumesDetails) SetEfsVolumeConfiguration

SetEfsVolumeConfiguration sets the EfsVolumeConfiguration field's value.

func (*AwsEcsTaskDefinitionVolumesDetails) SetHost

SetHost sets the Host field's value.

func (*AwsEcsTaskDefinitionVolumesDetails) SetName

SetName sets the Name field's value.

func (AwsEcsTaskDefinitionVolumesDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails

type AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails struct {

	// Whether to create the Docker volume automatically if it does not already
	// exist.
	Autoprovision *bool `type:"boolean"`

	// The Docker volume driver to use.
	Driver *string `type:"string"`

	// A map of Docker driver-specific options that are passed through.
	DriverOpts map[string]*string `type:"map"`

	// Custom metadata to add to the Docker volume.
	Labels map[string]*string `type:"map"`

	// The scope for the Docker volume that determines its lifecycle. Docker volumes
	// that are scoped to a task are provisioned automatically when the task starts
	// and destroyed when the task stops. Docker volumes that are shared persist
	// after the task stops. Valid values are shared or task.
	Scope *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a Docker volume.

func (AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetAutoprovision

SetAutoprovision sets the Autoprovision field's value.

func (*AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetDriver

SetDriver sets the Driver field's value.

func (*AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetDriverOpts

SetDriverOpts sets the DriverOpts field's value.

func (*AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetLabels

SetLabels sets the Labels field's value.

func (*AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetScope

SetScope sets the Scope field's value.

func (AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails

type AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails struct {

	// The Amazon EFS access point identifier to use.
	AccessPointId *string `type:"string"`

	// Whether to use the Amazon ECS task IAM role defined in a task definition
	// when mounting the Amazon EFS file system.
	Iam *string `type:"string"`
	// contains filtered or unexported fields
}

func (AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails) SetAccessPointId

SetAccessPointId sets the AccessPointId field's value.

func (*AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails) SetIam

SetIam sets the Iam field's value.

func (AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails

type AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails struct {

	// The authorization configuration details for the Amazon EFS file system.
	AuthorizationConfig *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails `type:"structure"`

	// The Amazon EFS file system identifier to use.
	FilesystemId *string `type:"string"`

	// The directory within the Amazon EFS file system to mount as the root directory
	// inside the host.
	RootDirectory *string `type:"string"`

	// Whether to enable encryption for Amazon EFS data in transit between the Amazon
	// ECS host and the Amazon EFS server.
	TransitEncryption *string `type:"string"`

	// The port to use when sending encrypted data between the Amazon ECS host and
	// the Amazon EFS server.
	TransitEncryptionPort *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Information about the Amazon Elastic File System file system that is used for task storage.

func (AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetAuthorizationConfig

SetAuthorizationConfig sets the AuthorizationConfig field's value.

func (*AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetFilesystemId

SetFilesystemId sets the FilesystemId field's value.

func (*AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetRootDirectory

SetRootDirectory sets the RootDirectory field's value.

func (*AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetTransitEncryption

SetTransitEncryption sets the TransitEncryption field's value.

func (*AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetTransitEncryptionPort

SetTransitEncryptionPort sets the TransitEncryptionPort field's value.

func (AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDefinitionVolumesHostDetails

type AwsEcsTaskDefinitionVolumesHostDetails struct {

	// The path on the host container instance that is presented to the container.
	SourcePath *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a bind mount host volume.

func (AwsEcsTaskDefinitionVolumesHostDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDefinitionVolumesHostDetails) SetSourcePath

SetSourcePath sets the SourcePath field's value.

func (AwsEcsTaskDefinitionVolumesHostDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskDetails added in v1.42.9

type AwsEcsTaskDetails struct {

	// The Amazon Resource Name (ARN) of the cluster that hosts the task.
	ClusterArn *string `type:"string"`

	// The containers that are associated with the task.
	Containers []*AwsEcsContainerDetails `type:"list"`

	// The Unix timestamp for the time when the task was created. More specifically,
	// it's for the time when the task entered the PENDING state.
	CreatedAt *string `type:"string"`

	// The name of the task group that's associated with the task.
	Group *string `type:"string"`

	// The Unix timestamp for the time when the task started. More specifically,
	// it's for the time when the task transitioned from the PENDING state to the
	// RUNNING state.
	StartedAt *string `type:"string"`

	// The tag specified when a task is started. If an Amazon ECS service started
	// the task, the startedBy parameter contains the deployment ID of that service.
	StartedBy *string `type:"string"`

	// The ARN of the task definition that creates the task.
	TaskDefinitionArn *string `type:"string"`

	// The version counter for the task.
	Version *string `type:"string"`

	// Details about the data volume that is used in a task definition.
	Volumes []*AwsEcsTaskVolumeDetails `type:"list"`
	// contains filtered or unexported fields
}

Provides details about a task in a cluster.

func (AwsEcsTaskDetails) GoString added in v1.42.9

func (s AwsEcsTaskDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskDetails) SetClusterArn added in v1.42.9

func (s *AwsEcsTaskDetails) SetClusterArn(v string) *AwsEcsTaskDetails

SetClusterArn sets the ClusterArn field's value.

func (*AwsEcsTaskDetails) SetContainers added in v1.42.9

SetContainers sets the Containers field's value.

func (*AwsEcsTaskDetails) SetCreatedAt added in v1.42.9

func (s *AwsEcsTaskDetails) SetCreatedAt(v string) *AwsEcsTaskDetails

SetCreatedAt sets the CreatedAt field's value.

func (*AwsEcsTaskDetails) SetGroup added in v1.42.9

func (s *AwsEcsTaskDetails) SetGroup(v string) *AwsEcsTaskDetails

SetGroup sets the Group field's value.

func (*AwsEcsTaskDetails) SetStartedAt added in v1.42.9

func (s *AwsEcsTaskDetails) SetStartedAt(v string) *AwsEcsTaskDetails

SetStartedAt sets the StartedAt field's value.

func (*AwsEcsTaskDetails) SetStartedBy added in v1.42.9

func (s *AwsEcsTaskDetails) SetStartedBy(v string) *AwsEcsTaskDetails

SetStartedBy sets the StartedBy field's value.

func (*AwsEcsTaskDetails) SetTaskDefinitionArn added in v1.42.9

func (s *AwsEcsTaskDetails) SetTaskDefinitionArn(v string) *AwsEcsTaskDetails

SetTaskDefinitionArn sets the TaskDefinitionArn field's value.

func (*AwsEcsTaskDetails) SetVersion added in v1.42.9

func (s *AwsEcsTaskDetails) SetVersion(v string) *AwsEcsTaskDetails

SetVersion sets the Version field's value.

func (*AwsEcsTaskDetails) SetVolumes added in v1.42.9

SetVolumes sets the Volumes field's value.

func (AwsEcsTaskDetails) String added in v1.42.9

func (s AwsEcsTaskDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskVolumeDetails added in v1.42.9

type AwsEcsTaskVolumeDetails struct {

	// This parameter is specified when you use bind mount host volumes. The contents
	// of the host parameter determine whether your bind mount host volume persists
	// on the host container instance and where it's stored.
	Host *AwsEcsTaskVolumeHostDetails `type:"structure"`

	// The name of the volume. Up to 255 letters (uppercase and lowercase), numbers,
	// underscores, and hyphens are allowed. This name is referenced in the sourceVolume
	// parameter of container definition mountPoints.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a data volume that's used in a task definition.

func (AwsEcsTaskVolumeDetails) GoString added in v1.42.9

func (s AwsEcsTaskVolumeDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskVolumeDetails) SetHost added in v1.42.9

SetHost sets the Host field's value.

func (*AwsEcsTaskVolumeDetails) SetName added in v1.42.9

SetName sets the Name field's value.

func (AwsEcsTaskVolumeDetails) String added in v1.42.9

func (s AwsEcsTaskVolumeDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEcsTaskVolumeHostDetails added in v1.42.9

type AwsEcsTaskVolumeHostDetails struct {

	// When the host parameter is used, specify a sourcePath to declare the path
	// on the host container instance that's presented to the container.
	SourcePath *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details on a container instance bind mount host volume.

func (AwsEcsTaskVolumeHostDetails) GoString added in v1.42.9

func (s AwsEcsTaskVolumeHostDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEcsTaskVolumeHostDetails) SetSourcePath added in v1.42.9

SetSourcePath sets the SourcePath field's value.

func (AwsEcsTaskVolumeHostDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEfsAccessPointDetails added in v1.42.9

type AwsEfsAccessPointDetails struct {

	// The ID of the Amazon EFS access point.
	AccessPointId *string `type:"string"`

	// The Amazon Resource Name (ARN) of the Amazon EFS access point.
	Arn *string `type:"string"`

	// The opaque string specified in the request to ensure idempotent creation.
	ClientToken *string `type:"string"`

	// The ID of the Amazon EFS file system that the access point applies to.
	FileSystemId *string `type:"string"`

	// The full POSIX identity, including the user ID, group ID, and secondary group
	// IDs on the access point, that is used for all file operations by NFS clients
	// using the access point.
	PosixUser *AwsEfsAccessPointPosixUserDetails `type:"structure"`

	// The directory on the Amazon EFS file system that the access point exposes
	// as the root directory to NFS clients using the access point.
	RootDirectory *AwsEfsAccessPointRootDirectoryDetails `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about an Amazon EFS access point.

func (AwsEfsAccessPointDetails) GoString added in v1.42.9

func (s AwsEfsAccessPointDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEfsAccessPointDetails) SetAccessPointId added in v1.42.9

SetAccessPointId sets the AccessPointId field's value.

func (*AwsEfsAccessPointDetails) SetArn added in v1.42.9

SetArn sets the Arn field's value.

func (*AwsEfsAccessPointDetails) SetClientToken added in v1.42.9

SetClientToken sets the ClientToken field's value.

func (*AwsEfsAccessPointDetails) SetFileSystemId added in v1.42.9

SetFileSystemId sets the FileSystemId field's value.

func (*AwsEfsAccessPointDetails) SetPosixUser added in v1.42.9

SetPosixUser sets the PosixUser field's value.

func (*AwsEfsAccessPointDetails) SetRootDirectory added in v1.42.9

SetRootDirectory sets the RootDirectory field's value.

func (AwsEfsAccessPointDetails) String added in v1.42.9

func (s AwsEfsAccessPointDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEfsAccessPointPosixUserDetails added in v1.42.9

type AwsEfsAccessPointPosixUserDetails struct {

	// The POSIX group ID used for all file system operations using this access
	// point.
	Gid *string `type:"string"`

	// Secondary POSIX group IDs used for all file system operations using this
	// access point.
	SecondaryGids []*string `type:"list"`

	// The POSIX user ID used for all file system operations using this access point.
	Uid *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details for all file system operations using this Amazon EFS access point.

func (AwsEfsAccessPointPosixUserDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEfsAccessPointPosixUserDetails) SetGid added in v1.42.9

SetGid sets the Gid field's value.

func (*AwsEfsAccessPointPosixUserDetails) SetSecondaryGids added in v1.42.9

SetSecondaryGids sets the SecondaryGids field's value.

func (*AwsEfsAccessPointPosixUserDetails) SetUid added in v1.42.9

SetUid sets the Uid field's value.

func (AwsEfsAccessPointPosixUserDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEfsAccessPointRootDirectoryCreationInfoDetails added in v1.42.9

type AwsEfsAccessPointRootDirectoryCreationInfoDetails struct {

	// Specifies the POSIX group ID to apply to the root directory.
	OwnerGid *string `type:"string"`

	// Specifies the POSIX user ID to apply to the root directory.
	OwnerUid *string `type:"string"`

	// Specifies the POSIX permissions to apply to the root directory, in the format
	// of an octal number representing the file's mode bits.
	Permissions *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the settings that Amazon EFS uses to create the root directory when a client connects to an access point.

func (AwsEfsAccessPointRootDirectoryCreationInfoDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEfsAccessPointRootDirectoryCreationInfoDetails) SetOwnerGid added in v1.42.9

SetOwnerGid sets the OwnerGid field's value.

func (*AwsEfsAccessPointRootDirectoryCreationInfoDetails) SetOwnerUid added in v1.42.9

SetOwnerUid sets the OwnerUid field's value.

func (*AwsEfsAccessPointRootDirectoryCreationInfoDetails) SetPermissions added in v1.42.9

SetPermissions sets the Permissions field's value.

func (AwsEfsAccessPointRootDirectoryCreationInfoDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEfsAccessPointRootDirectoryDetails added in v1.42.9

type AwsEfsAccessPointRootDirectoryDetails struct {

	// Specifies the POSIX IDs and permissions to apply to the access point's root
	// directory.
	CreationInfo *AwsEfsAccessPointRootDirectoryCreationInfoDetails `type:"structure"`

	// Specifies the path on the Amazon EFS file system to expose as the root directory
	// to NFS clients using the access point to access the EFS file system. A path
	// can have up to four subdirectories. If the specified path does not exist,
	// you are required to provide CreationInfo.
	Path *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.

func (AwsEfsAccessPointRootDirectoryDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEfsAccessPointRootDirectoryDetails) SetCreationInfo added in v1.42.9

SetCreationInfo sets the CreationInfo field's value.

func (*AwsEfsAccessPointRootDirectoryDetails) SetPath added in v1.42.9

SetPath sets the Path field's value.

func (AwsEfsAccessPointRootDirectoryDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEksClusterDetails

type AwsEksClusterDetails struct {

	// The ARN of the cluster.
	Arn *string `type:"string"`

	// The certificate authority data for the cluster.
	CertificateAuthorityData *string `type:"string"`

	// The status of the cluster. Valid values are as follows:
	//
	//    * ACTIVE
	//
	//    * CREATING
	//
	//    * DELETING
	//
	//    * FAILED
	//
	//    * PENDING
	//
	//    * UPDATING
	ClusterStatus *string `type:"string"`

	// The endpoint for the Amazon EKS API server.
	Endpoint *string `type:"string"`

	// The logging configuration for the cluster.
	Logging *AwsEksClusterLoggingDetails `type:"structure"`

	// The name of the cluster.
	Name *string `type:"string"`

	// The VPC configuration used by the cluster control plane.
	ResourcesVpcConfig *AwsEksClusterResourcesVpcConfigDetails `type:"structure"`

	// The ARN of the IAM role that provides permissions for the Amazon EKS control
	// plane to make calls to Amazon Web Services API operations on your behalf.
	RoleArn *string `type:"string"`

	// The Amazon EKS server version for the cluster.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about an Amazon EKS cluster.

func (AwsEksClusterDetails) GoString

func (s AwsEksClusterDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEksClusterDetails) SetArn

SetArn sets the Arn field's value.

func (*AwsEksClusterDetails) SetCertificateAuthorityData

func (s *AwsEksClusterDetails) SetCertificateAuthorityData(v string) *AwsEksClusterDetails

SetCertificateAuthorityData sets the CertificateAuthorityData field's value.

func (*AwsEksClusterDetails) SetClusterStatus

func (s *AwsEksClusterDetails) SetClusterStatus(v string) *AwsEksClusterDetails

SetClusterStatus sets the ClusterStatus field's value.

func (*AwsEksClusterDetails) SetEndpoint

SetEndpoint sets the Endpoint field's value.

func (*AwsEksClusterDetails) SetLogging

SetLogging sets the Logging field's value.

func (*AwsEksClusterDetails) SetName

SetName sets the Name field's value.

func (*AwsEksClusterDetails) SetResourcesVpcConfig

SetResourcesVpcConfig sets the ResourcesVpcConfig field's value.

func (*AwsEksClusterDetails) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*AwsEksClusterDetails) SetVersion

SetVersion sets the Version field's value.

func (AwsEksClusterDetails) String

func (s AwsEksClusterDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEksClusterLoggingClusterLoggingDetails

type AwsEksClusterLoggingClusterLoggingDetails struct {

	// Whether the logging types that are listed in Types are enabled.
	Enabled *bool `type:"boolean"`

	// A list of logging types. Valid values are as follows:
	//
	//    * api
	//
	//    * audit
	//
	//    * authenticator
	//
	//    * controllerManager
	//
	//    * scheduler
	Types []*string `type:"list"`
	// contains filtered or unexported fields
}

Details for a cluster logging configuration.

func (AwsEksClusterLoggingClusterLoggingDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEksClusterLoggingClusterLoggingDetails) SetEnabled

SetEnabled sets the Enabled field's value.

func (*AwsEksClusterLoggingClusterLoggingDetails) SetTypes

SetTypes sets the Types field's value.

func (AwsEksClusterLoggingClusterLoggingDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEksClusterLoggingDetails

type AwsEksClusterLoggingDetails struct {

	// Cluster logging configurations.
	ClusterLogging []*AwsEksClusterLoggingClusterLoggingDetails `type:"list"`
	// contains filtered or unexported fields
}

The logging configuration for an Amazon EKS cluster.

func (AwsEksClusterLoggingDetails) GoString

func (s AwsEksClusterLoggingDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEksClusterLoggingDetails) SetClusterLogging

SetClusterLogging sets the ClusterLogging field's value.

func (AwsEksClusterLoggingDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEksClusterResourcesVpcConfigDetails

type AwsEksClusterResourcesVpcConfigDetails struct {

	// Indicates whether the Amazon EKS public API server endpoint is turned on.
	// If the Amazon EKS public API server endpoint is turned off, your cluster's
	// Kubernetes API server can only receive requests that originate from within
	// the cluster VPC.
	EndpointPublicAccess *bool `type:"boolean"`

	// The security groups that are associated with the cross-account elastic network
	// interfaces that are used to allow communication between your nodes and the
	// Amazon EKS control plane.
	SecurityGroupIds []*string `type:"list"`

	// The subnets that are associated with the cluster.
	SubnetIds []*string `type:"list"`
	// contains filtered or unexported fields
}

Information about the VPC configuration used by the cluster control plane.

func (AwsEksClusterResourcesVpcConfigDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEksClusterResourcesVpcConfigDetails) SetEndpointPublicAccess added in v1.42.9

SetEndpointPublicAccess sets the EndpointPublicAccess field's value.

func (*AwsEksClusterResourcesVpcConfigDetails) SetSecurityGroupIds

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*AwsEksClusterResourcesVpcConfigDetails) SetSubnetIds

SetSubnetIds sets the SubnetIds field's value.

func (AwsEksClusterResourcesVpcConfigDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElasticBeanstalkEnvironmentDetails

type AwsElasticBeanstalkEnvironmentDetails struct {

	// The name of the application that is associated with the environment.
	ApplicationName *string `type:"string"`

	// The URL to the CNAME for this environment.
	Cname *string `type:"string"`

	// The creation date for this environment.
	DateCreated *string `type:"string"`

	// The date when this environment was last modified.
	DateUpdated *string `type:"string"`

	// A description of the environment.
	Description *string `type:"string"`

	// For load-balanced, autoscaling environments, the URL to the load balancer.
	// For single-instance environments, the IP address of the instance.
	EndpointUrl *string `type:"string"`

	// The ARN of the environment.
	EnvironmentArn *string `type:"string"`

	// The identifier of the environment.
	EnvironmentId *string `type:"string"`

	// Links to other environments in the same group.
	EnvironmentLinks []*AwsElasticBeanstalkEnvironmentEnvironmentLink `type:"list"`

	// The name of the environment.
	EnvironmentName *string `type:"string"`

	// The configuration setting for the environment.
	OptionSettings []*AwsElasticBeanstalkEnvironmentOptionSetting `type:"list"`

	// The ARN of the platform version for the environment.
	PlatformArn *string `type:"string"`

	// The name of the solution stack that is deployed with the environment.
	SolutionStackName *string `type:"string"`

	// The current operational status of the environment. Valid values are as follows:
	//
	//    * Aborting
	//
	//    * Launching
	//
	//    * LinkingFrom
	//
	//    * LinkingTo
	//
	//    * Ready
	//
	//    * Terminated
	//
	//    * Terminating
	//
	//    * Updating
	Status *string `type:"string"`

	// The tier of the environment.
	Tier *AwsElasticBeanstalkEnvironmentTier `type:"structure"`

	// The application version of the environment.
	VersionLabel *string `type:"string"`
	// contains filtered or unexported fields
}

Contains details about an Elastic Beanstalk environment.

func (AwsElasticBeanstalkEnvironmentDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElasticBeanstalkEnvironmentDetails) SetApplicationName

SetApplicationName sets the ApplicationName field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetCname

SetCname sets the Cname field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetDateCreated

SetDateCreated sets the DateCreated field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetDateUpdated

SetDateUpdated sets the DateUpdated field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetDescription

SetDescription sets the Description field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetEndpointUrl

SetEndpointUrl sets the EndpointUrl field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetEnvironmentArn

SetEnvironmentArn sets the EnvironmentArn field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetEnvironmentId

SetEnvironmentId sets the EnvironmentId field's value.

SetEnvironmentLinks sets the EnvironmentLinks field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetEnvironmentName

SetEnvironmentName sets the EnvironmentName field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetOptionSettings

SetOptionSettings sets the OptionSettings field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetPlatformArn

SetPlatformArn sets the PlatformArn field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetSolutionStackName

SetSolutionStackName sets the SolutionStackName field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetStatus

SetStatus sets the Status field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetTier

SetTier sets the Tier field's value.

func (*AwsElasticBeanstalkEnvironmentDetails) SetVersionLabel

SetVersionLabel sets the VersionLabel field's value.

func (AwsElasticBeanstalkEnvironmentDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElasticBeanstalkEnvironmentEnvironmentLink struct {

	// The name of the linked environment.
	EnvironmentName *string `type:"string"`

	// The name of the environment link.
	LinkName *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about a link to another environment that is in the same group.

func (AwsElasticBeanstalkEnvironmentEnvironmentLink) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElasticBeanstalkEnvironmentEnvironmentLink) SetEnvironmentName

SetEnvironmentName sets the EnvironmentName field's value.

func (*AwsElasticBeanstalkEnvironmentEnvironmentLink) SetLinkName

SetLinkName sets the LinkName field's value.

func (AwsElasticBeanstalkEnvironmentEnvironmentLink) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElasticBeanstalkEnvironmentOptionSetting

type AwsElasticBeanstalkEnvironmentOptionSetting struct {

	// The type of resource that the configuration option is associated with.
	Namespace *string `type:"string"`

	// The name of the option.
	OptionName *string `type:"string"`

	// The name of the resource.
	ResourceName *string `type:"string"`

	// The value of the configuration setting.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A configuration option setting for the environment.

func (AwsElasticBeanstalkEnvironmentOptionSetting) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElasticBeanstalkEnvironmentOptionSetting) SetNamespace

SetNamespace sets the Namespace field's value.

func (*AwsElasticBeanstalkEnvironmentOptionSetting) SetOptionName

SetOptionName sets the OptionName field's value.

func (*AwsElasticBeanstalkEnvironmentOptionSetting) SetResourceName

SetResourceName sets the ResourceName field's value.

func (*AwsElasticBeanstalkEnvironmentOptionSetting) SetValue

SetValue sets the Value field's value.

func (AwsElasticBeanstalkEnvironmentOptionSetting) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElasticBeanstalkEnvironmentTier

type AwsElasticBeanstalkEnvironmentTier struct {

	// The name of the environment tier. Valid values are WebServer or Worker.
	Name *string `type:"string"`

	// The type of environment tier. Valid values are Standard or SQS/HTTP.
	Type *string `type:"string"`

	// The version of the environment tier.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about the tier of the environment.

func (AwsElasticBeanstalkEnvironmentTier) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElasticBeanstalkEnvironmentTier) SetName

SetName sets the Name field's value.

func (*AwsElasticBeanstalkEnvironmentTier) SetType

SetType sets the Type field's value.

func (*AwsElasticBeanstalkEnvironmentTier) SetVersion

SetVersion sets the Version field's value.

func (AwsElasticBeanstalkEnvironmentTier) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElasticsearchDomainDetails

type AwsElasticsearchDomainDetails struct {

	// IAM policy document specifying the access policies for the new Elasticsearch
	// domain.
	AccessPolicies *string `type:"string"`

	// Additional options for the domain endpoint.
	DomainEndpointOptions *AwsElasticsearchDomainDomainEndpointOptions `type:"structure"`

	// Unique identifier for an Elasticsearch domain.
	DomainId *string `type:"string"`

	// Name of an Elasticsearch domain.
	//
	// Domain names are unique across all domains owned by the same account within
	// an Amazon Web Services Region.
	//
	// Domain names must start with a lowercase letter and must be between 3 and
	// 28 characters.
	//
	// Valid characters are a-z (lowercase only), 0-9, and – (hyphen).
	DomainName *string `type:"string"`

	// Information about an OpenSearch cluster configuration.
	ElasticsearchClusterConfig *AwsElasticsearchDomainElasticsearchClusterConfigDetails `type:"structure"`

	// OpenSearch version.
	ElasticsearchVersion *string `type:"string"`

	// Details about the configuration for encryption at rest.
	EncryptionAtRestOptions *AwsElasticsearchDomainEncryptionAtRestOptions `type:"structure"`

	// Domain-specific endpoint used to submit index, search, and data upload requests
	// to an Elasticsearch domain.
	//
	// The endpoint is a service URL.
	Endpoint *string `type:"string"`

	// The key-value pair that exists if the Elasticsearch domain uses VPC endpoints.
	Endpoints map[string]*string `type:"map"`

	// Configures the CloudWatch Logs to publish for the Elasticsearch domain.
	LogPublishingOptions *AwsElasticsearchDomainLogPublishingOptions `type:"structure"`

	// Details about the configuration for node-to-node encryption.
	NodeToNodeEncryptionOptions *AwsElasticsearchDomainNodeToNodeEncryptionOptions `type:"structure"`

	// Information about the status of a domain relative to the latest service software.
	ServiceSoftwareOptions *AwsElasticsearchDomainServiceSoftwareOptions `type:"structure"`

	// Information that OpenSearch derives based on VPCOptions for the domain.
	VPCOptions *AwsElasticsearchDomainVPCOptions `type:"structure"`
	// contains filtered or unexported fields
}

Information about an Elasticsearch domain.

func (AwsElasticsearchDomainDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElasticsearchDomainDetails) SetAccessPolicies

SetAccessPolicies sets the AccessPolicies field's value.

func (*AwsElasticsearchDomainDetails) SetDomainEndpointOptions

SetDomainEndpointOptions sets the DomainEndpointOptions field's value.

func (*AwsElasticsearchDomainDetails) SetDomainId

SetDomainId sets the DomainId field's value.

func (*AwsElasticsearchDomainDetails) SetDomainName

SetDomainName sets the DomainName field's value.

func (*AwsElasticsearchDomainDetails) SetElasticsearchClusterConfig

SetElasticsearchClusterConfig sets the ElasticsearchClusterConfig field's value.

func (*AwsElasticsearchDomainDetails) SetElasticsearchVersion

SetElasticsearchVersion sets the ElasticsearchVersion field's value.

func (*AwsElasticsearchDomainDetails) SetEncryptionAtRestOptions

SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.

func (*AwsElasticsearchDomainDetails) SetEndpoint

SetEndpoint sets the Endpoint field's value.

func (*AwsElasticsearchDomainDetails) SetEndpoints

SetEndpoints sets the Endpoints field's value.

func (*AwsElasticsearchDomainDetails) SetLogPublishingOptions

SetLogPublishingOptions sets the LogPublishingOptions field's value.

func (*AwsElasticsearchDomainDetails) SetNodeToNodeEncryptionOptions

SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.

func (*AwsElasticsearchDomainDetails) SetServiceSoftwareOptions

SetServiceSoftwareOptions sets the ServiceSoftwareOptions field's value.

func (*AwsElasticsearchDomainDetails) SetVPCOptions

SetVPCOptions sets the VPCOptions field's value.

func (AwsElasticsearchDomainDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElasticsearchDomainDomainEndpointOptions

type AwsElasticsearchDomainDomainEndpointOptions struct {

	// Whether to require that all traffic to the domain arrive over HTTPS.
	EnforceHTTPS *bool `type:"boolean"`

	// The TLS security policy to apply to the HTTPS endpoint of the OpenSearch
	// domain.
	//
	// Valid values:
	//
	//    * Policy-Min-TLS-1-0-2019-07, which supports TLSv1.0 and higher
	//
	//    * Policy-Min-TLS-1-2-2019-07, which only supports TLSv1.2
	TLSSecurityPolicy *string `type:"string"`
	// contains filtered or unexported fields
}

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

func (AwsElasticsearchDomainDomainEndpointOptions) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElasticsearchDomainDomainEndpointOptions) SetEnforceHTTPS

SetEnforceHTTPS sets the EnforceHTTPS field's value.

func (*AwsElasticsearchDomainDomainEndpointOptions) SetTLSSecurityPolicy

SetTLSSecurityPolicy sets the TLSSecurityPolicy field's value.

func (AwsElasticsearchDomainDomainEndpointOptions) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElasticsearchDomainElasticsearchClusterConfigDetails

type AwsElasticsearchDomainElasticsearchClusterConfigDetails struct {

	// The number of instances to use for the master node. If this attribute is
	// specified, then DedicatedMasterEnabled must be true.
	DedicatedMasterCount *int64 `type:"integer"`

	// Whether to use a dedicated master node for the Elasticsearch domain. A dedicated
	// master node performs cluster management tasks, but doesn't hold data or respond
	// to data upload requests.
	DedicatedMasterEnabled *bool `type:"boolean"`

	// The hardware configuration of the computer that hosts the dedicated master
	// node. A sample value is m3.medium.elasticsearch. If this attribute is specified,
	// then DedicatedMasterEnabled must be true.
	//
	// For a list of valid values, see Supported instance types in Amazon OpenSearch
	// Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html)
	// in the Amazon OpenSearch Service Developer Guide.
	DedicatedMasterType *string `type:"string"`

	// The number of data nodes to use in the Elasticsearch domain.
	InstanceCount *int64 `type:"integer"`

	// The instance type for your data nodes. For example, m3.medium.elasticsearch.
	//
	// For a list of valid values, see Supported instance types in Amazon OpenSearch
	// Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html)
	// in the Amazon OpenSearch Service Developer Guide.
	InstanceType *string `type:"string"`

	// Configuration options for zone awareness. Provided if ZoneAwarenessEnabled
	// is true.
	ZoneAwarenessConfig *AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails `type:"structure"`

	// Whether to enable zone awareness for the Elasticsearch domain. When zone
	// awareness is enabled, OpenSearch allocates the cluster's nodes and replica
	// index shards across Availability Zones in the same Region. This prevents
	// data loss and minimizes downtime if a node or data center fails.
	ZoneAwarenessEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

details about the configuration of an OpenSearch cluster.

func (AwsElasticsearchDomainElasticsearchClusterConfigDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetDedicatedMasterCount

SetDedicatedMasterCount sets the DedicatedMasterCount field's value.

func (*AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetDedicatedMasterEnabled

SetDedicatedMasterEnabled sets the DedicatedMasterEnabled field's value.

func (*AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetDedicatedMasterType

SetDedicatedMasterType sets the DedicatedMasterType field's value.

func (*AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetInstanceCount

SetInstanceCount sets the InstanceCount field's value.

func (*AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetInstanceType

SetInstanceType sets the InstanceType field's value.

func (*AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetZoneAwarenessConfig

SetZoneAwarenessConfig sets the ZoneAwarenessConfig field's value.

func (*AwsElasticsearchDomainElasticsearchClusterConfigDetails) SetZoneAwarenessEnabled

SetZoneAwarenessEnabled sets the ZoneAwarenessEnabled field's value.

func (AwsElasticsearchDomainElasticsearchClusterConfigDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails

type AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails struct {

	// he number of Availability Zones that the domain uses. Valid values are 2
	// and 3. The default is 2.
	AvailabilityZoneCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Configuration options for zone awareness.

func (AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails) SetAvailabilityZoneCount

SetAvailabilityZoneCount sets the AvailabilityZoneCount field's value.

func (AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElasticsearchDomainEncryptionAtRestOptions

type AwsElasticsearchDomainEncryptionAtRestOptions struct {

	// Whether encryption at rest is enabled.
	Enabled *bool `type:"boolean"`

	// The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.
	KmsKeyId *string `type:"string"`
	// contains filtered or unexported fields
}

Details about the configuration for encryption at rest.

func (AwsElasticsearchDomainEncryptionAtRestOptions) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElasticsearchDomainEncryptionAtRestOptions) SetEnabled

SetEnabled sets the Enabled field's value.

func (*AwsElasticsearchDomainEncryptionAtRestOptions) SetKmsKeyId

SetKmsKeyId sets the KmsKeyId field's value.

func (AwsElasticsearchDomainEncryptionAtRestOptions) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElasticsearchDomainLogPublishingOptions

type AwsElasticsearchDomainLogPublishingOptions struct {

	// The log configuration.
	AuditLogs *AwsElasticsearchDomainLogPublishingOptionsLogConfig `type:"structure"`

	// Configures the OpenSearch index logs publishing.
	IndexSlowLogs *AwsElasticsearchDomainLogPublishingOptionsLogConfig `type:"structure"`

	// Configures the OpenSearch search slow log publishing.
	SearchSlowLogs *AwsElasticsearchDomainLogPublishingOptionsLogConfig `type:"structure"`
	// contains filtered or unexported fields
}

configures the CloudWatch Logs to publish for the Elasticsearch domain.

func (AwsElasticsearchDomainLogPublishingOptions) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElasticsearchDomainLogPublishingOptions) SetAuditLogs

SetAuditLogs sets the AuditLogs field's value.

func (*AwsElasticsearchDomainLogPublishingOptions) SetIndexSlowLogs

SetIndexSlowLogs sets the IndexSlowLogs field's value.

func (*AwsElasticsearchDomainLogPublishingOptions) SetSearchSlowLogs

SetSearchSlowLogs sets the SearchSlowLogs field's value.

func (AwsElasticsearchDomainLogPublishingOptions) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElasticsearchDomainLogPublishingOptionsLogConfig

type AwsElasticsearchDomainLogPublishingOptionsLogConfig struct {

	// The ARN of the CloudWatch Logs group to publish the logs to.
	CloudWatchLogsLogGroupArn *string `type:"string"`

	// Whether the log publishing is enabled.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The log configuration.

func (AwsElasticsearchDomainLogPublishingOptionsLogConfig) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElasticsearchDomainLogPublishingOptionsLogConfig) SetCloudWatchLogsLogGroupArn

SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value.

func (*AwsElasticsearchDomainLogPublishingOptionsLogConfig) SetEnabled

SetEnabled sets the Enabled field's value.

func (AwsElasticsearchDomainLogPublishingOptionsLogConfig) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElasticsearchDomainNodeToNodeEncryptionOptions

type AwsElasticsearchDomainNodeToNodeEncryptionOptions struct {

	// Whether node-to-node encryption is enabled.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Details about the configuration for node-to-node encryption.

func (AwsElasticsearchDomainNodeToNodeEncryptionOptions) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElasticsearchDomainNodeToNodeEncryptionOptions) SetEnabled

SetEnabled sets the Enabled field's value.

func (AwsElasticsearchDomainNodeToNodeEncryptionOptions) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElasticsearchDomainServiceSoftwareOptions

type AwsElasticsearchDomainServiceSoftwareOptions struct {

	// The epoch time when the deployment window closes for required updates. After
	// this time, Amazon OpenSearch Service schedules the software upgrade automatically.
	AutomatedUpdateDate *string `type:"string"`

	// Whether a request to update the domain can be canceled.
	Cancellable *bool `type:"boolean"`

	// The version of the service software that is currently installed on the domain.
	CurrentVersion *string `type:"string"`

	// A more detailed description of the service software status.
	Description *string `type:"string"`

	// The most recent version of the service software.
	NewVersion *string `type:"string"`

	// Whether a service software update is available for the domain.
	UpdateAvailable *bool `type:"boolean"`

	// The status of the service software update. Valid values are as follows:
	//
	//    * COMPLETED
	//
	//    * ELIGIBLE
	//
	//    * IN_PROGRESS
	//
	//    * NOT_ELIGIBLE
	//
	//    * PENDING_UPDATE
	UpdateStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the state of the domain relative to the latest service software.

func (AwsElasticsearchDomainServiceSoftwareOptions) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElasticsearchDomainServiceSoftwareOptions) SetAutomatedUpdateDate

SetAutomatedUpdateDate sets the AutomatedUpdateDate field's value.

func (*AwsElasticsearchDomainServiceSoftwareOptions) SetCancellable

SetCancellable sets the Cancellable field's value.

func (*AwsElasticsearchDomainServiceSoftwareOptions) SetCurrentVersion

SetCurrentVersion sets the CurrentVersion field's value.

func (*AwsElasticsearchDomainServiceSoftwareOptions) SetDescription

SetDescription sets the Description field's value.

func (*AwsElasticsearchDomainServiceSoftwareOptions) SetNewVersion

SetNewVersion sets the NewVersion field's value.

func (*AwsElasticsearchDomainServiceSoftwareOptions) SetUpdateAvailable

SetUpdateAvailable sets the UpdateAvailable field's value.

func (*AwsElasticsearchDomainServiceSoftwareOptions) SetUpdateStatus

SetUpdateStatus sets the UpdateStatus field's value.

func (AwsElasticsearchDomainServiceSoftwareOptions) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElasticsearchDomainVPCOptions

type AwsElasticsearchDomainVPCOptions struct {

	// The list of Availability Zones associated with the VPC subnets.
	AvailabilityZones []*string `type:"list"`

	// The list of security group IDs associated with the VPC endpoints for the
	// domain.
	SecurityGroupIds []*string `type:"list"`

	// A list of subnet IDs associated with the VPC endpoints for the domain.
	SubnetIds []*string `type:"list"`

	// ID for the VPC.
	VPCId *string `type:"string"`
	// contains filtered or unexported fields
}

Information that OpenSearch derives based on VPCOptions for the domain.

func (AwsElasticsearchDomainVPCOptions) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElasticsearchDomainVPCOptions) SetAvailabilityZones

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*AwsElasticsearchDomainVPCOptions) SetSecurityGroupIds

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*AwsElasticsearchDomainVPCOptions) SetSubnetIds

SetSubnetIds sets the SubnetIds field's value.

func (*AwsElasticsearchDomainVPCOptions) SetVPCId

SetVPCId sets the VPCId field's value.

func (AwsElasticsearchDomainVPCOptions) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElbAppCookieStickinessPolicy

type AwsElbAppCookieStickinessPolicy struct {

	// The name of the application cookie used for stickiness.
	CookieName *string `type:"string"`

	// The mnemonic name for the policy being created. The name must be unique within
	// the set of policies for the load balancer.
	PolicyName *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about a stickiness policy that was created using CreateAppCookieStickinessPolicy.

func (AwsElbAppCookieStickinessPolicy) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElbAppCookieStickinessPolicy) SetCookieName

SetCookieName sets the CookieName field's value.

func (*AwsElbAppCookieStickinessPolicy) SetPolicyName

SetPolicyName sets the PolicyName field's value.

func (AwsElbAppCookieStickinessPolicy) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElbLbCookieStickinessPolicy

type AwsElbLbCookieStickinessPolicy struct {

	// The amount of time, in seconds, after which the cookie is considered stale.
	// If an expiration period is not specified, the stickiness session lasts for
	// the duration of the browser session.
	CookieExpirationPeriod *int64 `type:"long"`

	// The name of the policy. The name must be unique within the set of policies
	// for the load balancer.
	PolicyName *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about a stickiness policy that was created using CreateLBCookieStickinessPolicy.

func (AwsElbLbCookieStickinessPolicy) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElbLbCookieStickinessPolicy) SetCookieExpirationPeriod

func (s *AwsElbLbCookieStickinessPolicy) SetCookieExpirationPeriod(v int64) *AwsElbLbCookieStickinessPolicy

SetCookieExpirationPeriod sets the CookieExpirationPeriod field's value.

func (*AwsElbLbCookieStickinessPolicy) SetPolicyName

SetPolicyName sets the PolicyName field's value.

func (AwsElbLbCookieStickinessPolicy) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElbLoadBalancerAccessLog

type AwsElbLoadBalancerAccessLog struct {

	// The interval in minutes for publishing the access logs.
	//
	// You can publish access logs either every 5 minutes or every 60 minutes.
	EmitInterval *int64 `type:"integer"`

	// Indicates whether access logs are enabled for the load balancer.
	Enabled *bool `type:"boolean"`

	// The name of the S3 bucket where the access logs are stored.
	S3BucketName *string `type:"string"`

	// The logical hierarchy that was created for the S3 bucket.
	//
	// If a prefix is not provided, the log is placed at the root level of the bucket.
	S3BucketPrefix *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about the access log configuration for the load balancer.

func (AwsElbLoadBalancerAccessLog) GoString

func (s AwsElbLoadBalancerAccessLog) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElbLoadBalancerAccessLog) SetEmitInterval

SetEmitInterval sets the EmitInterval field's value.

func (*AwsElbLoadBalancerAccessLog) SetEnabled

SetEnabled sets the Enabled field's value.

func (*AwsElbLoadBalancerAccessLog) SetS3BucketName

SetS3BucketName sets the S3BucketName field's value.

func (*AwsElbLoadBalancerAccessLog) SetS3BucketPrefix

SetS3BucketPrefix sets the S3BucketPrefix field's value.

func (AwsElbLoadBalancerAccessLog) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElbLoadBalancerAdditionalAttribute added in v1.42.9

type AwsElbLoadBalancerAdditionalAttribute struct {

	// The name of the attribute.
	Key *string `type:"string"`

	// The value of the attribute.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about additional attributes for the load balancer.

func (AwsElbLoadBalancerAdditionalAttribute) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElbLoadBalancerAdditionalAttribute) SetKey added in v1.42.9

SetKey sets the Key field's value.

func (*AwsElbLoadBalancerAdditionalAttribute) SetValue added in v1.42.9

SetValue sets the Value field's value.

func (AwsElbLoadBalancerAdditionalAttribute) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElbLoadBalancerAttributes

type AwsElbLoadBalancerAttributes struct {

	// Information about the access log configuration for the load balancer.
	//
	// If the access log is enabled, the load balancer captures detailed information
	// about all requests. It delivers the information to a specified S3 bucket.
	AccessLog *AwsElbLoadBalancerAccessLog `type:"structure"`

	// Any additional attributes for a load balancer.
	AdditionalAttributes []*AwsElbLoadBalancerAdditionalAttribute `type:"list"`

	// Information about the connection draining configuration for the load balancer.
	//
	// If connection draining is enabled, the load balancer allows existing requests
	// to complete before it shifts traffic away from a deregistered or unhealthy
	// instance.
	ConnectionDraining *AwsElbLoadBalancerConnectionDraining `type:"structure"`

	// Connection settings for the load balancer.
	//
	// If an idle timeout is configured, the load balancer allows connections to
	// remain idle for the specified duration. When a connection is idle, no data
	// is sent over the connection.
	ConnectionSettings *AwsElbLoadBalancerConnectionSettings `type:"structure"`

	// Cross-zone load balancing settings for the load balancer.
	//
	// If cross-zone load balancing is enabled, the load balancer routes the request
	// traffic evenly across all instances regardless of the Availability Zones.
	CrossZoneLoadBalancing *AwsElbLoadBalancerCrossZoneLoadBalancing `type:"structure"`
	// contains filtered or unexported fields
}

Contains attributes for the load balancer.

func (AwsElbLoadBalancerAttributes) GoString

func (s AwsElbLoadBalancerAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElbLoadBalancerAttributes) SetAccessLog

SetAccessLog sets the AccessLog field's value.

func (*AwsElbLoadBalancerAttributes) SetAdditionalAttributes added in v1.42.9

SetAdditionalAttributes sets the AdditionalAttributes field's value.

func (*AwsElbLoadBalancerAttributes) SetConnectionDraining

SetConnectionDraining sets the ConnectionDraining field's value.

func (*AwsElbLoadBalancerAttributes) SetConnectionSettings

SetConnectionSettings sets the ConnectionSettings field's value.

func (*AwsElbLoadBalancerAttributes) SetCrossZoneLoadBalancing

SetCrossZoneLoadBalancing sets the CrossZoneLoadBalancing field's value.

func (AwsElbLoadBalancerAttributes) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElbLoadBalancerBackendServerDescription

type AwsElbLoadBalancerBackendServerDescription struct {

	// The port on which the EC2 instance is listening.
	InstancePort *int64 `type:"integer"`

	// The names of the policies that are enabled for the EC2 instance.
	PolicyNames []*string `type:"list"`
	// contains filtered or unexported fields
}

Provides information about the configuration of an EC2 instance for the load balancer.

func (AwsElbLoadBalancerBackendServerDescription) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElbLoadBalancerBackendServerDescription) SetInstancePort

SetInstancePort sets the InstancePort field's value.

func (*AwsElbLoadBalancerBackendServerDescription) SetPolicyNames

SetPolicyNames sets the PolicyNames field's value.

func (AwsElbLoadBalancerBackendServerDescription) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElbLoadBalancerConnectionDraining

type AwsElbLoadBalancerConnectionDraining struct {

	// Indicates whether connection draining is enabled for the load balancer.
	Enabled *bool `type:"boolean"`

	// The maximum time, in seconds, to keep the existing connections open before
	// deregistering the instances.
	Timeout *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Contains information about the connection draining configuration for the load balancer.

func (AwsElbLoadBalancerConnectionDraining) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElbLoadBalancerConnectionDraining) SetEnabled

SetEnabled sets the Enabled field's value.

func (*AwsElbLoadBalancerConnectionDraining) SetTimeout

SetTimeout sets the Timeout field's value.

func (AwsElbLoadBalancerConnectionDraining) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElbLoadBalancerConnectionSettings

type AwsElbLoadBalancerConnectionSettings struct {

	// The time, in seconds, that the connection can be idle (no data is sent over
	// the connection) before it is closed by the load balancer.
	IdleTimeout *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Contains connection settings for the load balancer.

func (AwsElbLoadBalancerConnectionSettings) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElbLoadBalancerConnectionSettings) SetIdleTimeout

SetIdleTimeout sets the IdleTimeout field's value.

func (AwsElbLoadBalancerConnectionSettings) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElbLoadBalancerCrossZoneLoadBalancing

type AwsElbLoadBalancerCrossZoneLoadBalancing struct {

	// Indicates whether cross-zone load balancing is enabled for the load balancer.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Contains cross-zone load balancing settings for the load balancer.

func (AwsElbLoadBalancerCrossZoneLoadBalancing) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElbLoadBalancerCrossZoneLoadBalancing) SetEnabled

SetEnabled sets the Enabled field's value.

func (AwsElbLoadBalancerCrossZoneLoadBalancing) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElbLoadBalancerDetails

type AwsElbLoadBalancerDetails struct {

	// The list of Availability Zones for the load balancer.
	AvailabilityZones []*string `type:"list"`

	// Information about the configuration of the EC2 instances.
	BackendServerDescriptions []*AwsElbLoadBalancerBackendServerDescription `type:"list"`

	// The name of the Amazon Route 53 hosted zone for the load balancer.
	CanonicalHostedZoneName *string `type:"string"`

	// The ID of the Amazon Route 53 hosted zone for the load balancer.
	CanonicalHostedZoneNameID *string `type:"string"`

	// Indicates when the load balancer was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreatedTime *string `type:"string"`

	// The DNS name of the load balancer.
	DnsName *string `type:"string"`

	// Information about the health checks that are conducted on the load balancer.
	HealthCheck *AwsElbLoadBalancerHealthCheck `type:"structure"`

	// List of EC2 instances for the load balancer.
	Instances []*AwsElbLoadBalancerInstance `type:"list"`

	// The policies that are enabled for the load balancer listeners.
	ListenerDescriptions []*AwsElbLoadBalancerListenerDescription `type:"list"`

	// The attributes for a load balancer.
	LoadBalancerAttributes *AwsElbLoadBalancerAttributes `type:"structure"`

	// The name of the load balancer.
	LoadBalancerName *string `type:"string"`

	// The policies for a load balancer.
	Policies *AwsElbLoadBalancerPolicies `type:"structure"`

	// The type of load balancer. Only provided if the load balancer is in a VPC.
	//
	// If Scheme is internet-facing, the load balancer has a public DNS name that
	// resolves to a public IP address.
	//
	// If Scheme is internal, the load balancer has a public DNS name that resolves
	// to a private IP address.
	Scheme *string `type:"string"`

	// The security groups for the load balancer. Only provided if the load balancer
	// is in a VPC.
	SecurityGroups []*string `type:"list"`

	// Information about the security group for the load balancer. This is the security
	// group that is used for inbound rules.
	SourceSecurityGroup *AwsElbLoadBalancerSourceSecurityGroup `type:"structure"`

	// The list of subnet identifiers for the load balancer.
	Subnets []*string `type:"list"`

	// The identifier of the VPC for the load balancer.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains details about a Classic Load Balancer.

func (AwsElbLoadBalancerDetails) GoString

func (s AwsElbLoadBalancerDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElbLoadBalancerDetails) SetAvailabilityZones

func (s *AwsElbLoadBalancerDetails) SetAvailabilityZones(v []*string) *AwsElbLoadBalancerDetails

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*AwsElbLoadBalancerDetails) SetBackendServerDescriptions

SetBackendServerDescriptions sets the BackendServerDescriptions field's value.

func (*AwsElbLoadBalancerDetails) SetCanonicalHostedZoneName

func (s *AwsElbLoadBalancerDetails) SetCanonicalHostedZoneName(v string) *AwsElbLoadBalancerDetails

SetCanonicalHostedZoneName sets the CanonicalHostedZoneName field's value.

func (*AwsElbLoadBalancerDetails) SetCanonicalHostedZoneNameID

func (s *AwsElbLoadBalancerDetails) SetCanonicalHostedZoneNameID(v string) *AwsElbLoadBalancerDetails

SetCanonicalHostedZoneNameID sets the CanonicalHostedZoneNameID field's value.

func (*AwsElbLoadBalancerDetails) SetCreatedTime

SetCreatedTime sets the CreatedTime field's value.

func (*AwsElbLoadBalancerDetails) SetDnsName

SetDnsName sets the DnsName field's value.

func (*AwsElbLoadBalancerDetails) SetHealthCheck

SetHealthCheck sets the HealthCheck field's value.

func (*AwsElbLoadBalancerDetails) SetInstances

SetInstances sets the Instances field's value.

func (*AwsElbLoadBalancerDetails) SetListenerDescriptions

SetListenerDescriptions sets the ListenerDescriptions field's value.

func (*AwsElbLoadBalancerDetails) SetLoadBalancerAttributes

SetLoadBalancerAttributes sets the LoadBalancerAttributes field's value.

func (*AwsElbLoadBalancerDetails) SetLoadBalancerName

func (s *AwsElbLoadBalancerDetails) SetLoadBalancerName(v string) *AwsElbLoadBalancerDetails

SetLoadBalancerName sets the LoadBalancerName field's value.

func (*AwsElbLoadBalancerDetails) SetPolicies

SetPolicies sets the Policies field's value.

func (*AwsElbLoadBalancerDetails) SetScheme

SetScheme sets the Scheme field's value.

func (*AwsElbLoadBalancerDetails) SetSecurityGroups

func (s *AwsElbLoadBalancerDetails) SetSecurityGroups(v []*string) *AwsElbLoadBalancerDetails

SetSecurityGroups sets the SecurityGroups field's value.

func (*AwsElbLoadBalancerDetails) SetSourceSecurityGroup

SetSourceSecurityGroup sets the SourceSecurityGroup field's value.

func (*AwsElbLoadBalancerDetails) SetSubnets

SetSubnets sets the Subnets field's value.

func (*AwsElbLoadBalancerDetails) SetVpcId

SetVpcId sets the VpcId field's value.

func (AwsElbLoadBalancerDetails) String

func (s AwsElbLoadBalancerDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElbLoadBalancerHealthCheck

type AwsElbLoadBalancerHealthCheck struct {

	// The number of consecutive health check successes required before the instance
	// is moved to the Healthy state.
	HealthyThreshold *int64 `type:"integer"`

	// The approximate interval, in seconds, between health checks of an individual
	// instance.
	Interval *int64 `type:"integer"`

	// The instance that is being checked. The target specifies the protocol and
	// port. The available protocols are TCP, SSL, HTTP, and HTTPS. The range of
	// valid ports is 1 through 65535.
	//
	// For the HTTP and HTTPS protocols, the target also specifies the ping path.
	//
	// For the TCP protocol, the target is specified as TCP: <port> .
	//
	// For the SSL protocol, the target is specified as SSL.<port> .
	//
	// For the HTTP and HTTPS protocols, the target is specified as <protocol>:<port>/<path
	// to ping> .
	Target *string `type:"string"`

	// The amount of time, in seconds, during which no response means a failed health
	// check.
	Timeout *int64 `type:"integer"`

	// The number of consecutive health check failures that must occur before the
	// instance is moved to the Unhealthy state.
	UnhealthyThreshold *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Contains information about the health checks that are conducted on the load balancer.

func (AwsElbLoadBalancerHealthCheck) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElbLoadBalancerHealthCheck) SetHealthyThreshold

SetHealthyThreshold sets the HealthyThreshold field's value.

func (*AwsElbLoadBalancerHealthCheck) SetInterval

SetInterval sets the Interval field's value.

func (*AwsElbLoadBalancerHealthCheck) SetTarget

SetTarget sets the Target field's value.

func (*AwsElbLoadBalancerHealthCheck) SetTimeout

SetTimeout sets the Timeout field's value.

func (*AwsElbLoadBalancerHealthCheck) SetUnhealthyThreshold

SetUnhealthyThreshold sets the UnhealthyThreshold field's value.

func (AwsElbLoadBalancerHealthCheck) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElbLoadBalancerInstance

type AwsElbLoadBalancerInstance struct {

	// The instance identifier.
	InstanceId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about an EC2 instance for a load balancer.

func (AwsElbLoadBalancerInstance) GoString

func (s AwsElbLoadBalancerInstance) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElbLoadBalancerInstance) SetInstanceId

SetInstanceId sets the InstanceId field's value.

func (AwsElbLoadBalancerInstance) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElbLoadBalancerListener

type AwsElbLoadBalancerListener struct {

	// The port on which the instance is listening.
	InstancePort *int64 `type:"integer"`

	// The protocol to use to route traffic to instances.
	//
	// Valid values: HTTP | HTTPS | TCP | SSL
	InstanceProtocol *string `type:"string"`

	// The port on which the load balancer is listening.
	//
	// On EC2-VPC, you can specify any port from the range 1-65535.
	//
	// On EC2-Classic, you can specify any port from the following list: 25, 80,
	// 443, 465, 587, 1024-65535.
	LoadBalancerPort *int64 `type:"integer"`

	// The load balancer transport protocol to use for routing.
	//
	// Valid values: HTTP | HTTPS | TCP | SSL
	Protocol *string `type:"string"`

	// The ARN of the server certificate.
	SslCertificateId *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a load balancer listener.

func (AwsElbLoadBalancerListener) GoString

func (s AwsElbLoadBalancerListener) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElbLoadBalancerListener) SetInstancePort

SetInstancePort sets the InstancePort field's value.

func (*AwsElbLoadBalancerListener) SetInstanceProtocol

SetInstanceProtocol sets the InstanceProtocol field's value.

func (*AwsElbLoadBalancerListener) SetLoadBalancerPort

func (s *AwsElbLoadBalancerListener) SetLoadBalancerPort(v int64) *AwsElbLoadBalancerListener

SetLoadBalancerPort sets the LoadBalancerPort field's value.

func (*AwsElbLoadBalancerListener) SetProtocol

SetProtocol sets the Protocol field's value.

func (*AwsElbLoadBalancerListener) SetSslCertificateId

SetSslCertificateId sets the SslCertificateId field's value.

func (AwsElbLoadBalancerListener) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElbLoadBalancerListenerDescription

type AwsElbLoadBalancerListenerDescription struct {

	// Information about the listener.
	Listener *AwsElbLoadBalancerListener `type:"structure"`

	// The policies enabled for the listener.
	PolicyNames []*string `type:"list"`
	// contains filtered or unexported fields
}

Lists the policies that are enabled for a load balancer listener.

func (AwsElbLoadBalancerListenerDescription) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElbLoadBalancerListenerDescription) SetListener

SetListener sets the Listener field's value.

func (*AwsElbLoadBalancerListenerDescription) SetPolicyNames

SetPolicyNames sets the PolicyNames field's value.

func (AwsElbLoadBalancerListenerDescription) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElbLoadBalancerPolicies

type AwsElbLoadBalancerPolicies struct {

	// The stickiness policies that are created using CreateAppCookieStickinessPolicy.
	AppCookieStickinessPolicies []*AwsElbAppCookieStickinessPolicy `type:"list"`

	// The stickiness policies that are created using CreateLBCookieStickinessPolicy.
	LbCookieStickinessPolicies []*AwsElbLbCookieStickinessPolicy `type:"list"`

	// The policies other than the stickiness policies.
	OtherPolicies []*string `type:"list"`
	// contains filtered or unexported fields
}

Contains information about the policies for a load balancer.

func (AwsElbLoadBalancerPolicies) GoString

func (s AwsElbLoadBalancerPolicies) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElbLoadBalancerPolicies) SetAppCookieStickinessPolicies

SetAppCookieStickinessPolicies sets the AppCookieStickinessPolicies field's value.

func (*AwsElbLoadBalancerPolicies) SetLbCookieStickinessPolicies

SetLbCookieStickinessPolicies sets the LbCookieStickinessPolicies field's value.

func (*AwsElbLoadBalancerPolicies) SetOtherPolicies

SetOtherPolicies sets the OtherPolicies field's value.

func (AwsElbLoadBalancerPolicies) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElbLoadBalancerSourceSecurityGroup

type AwsElbLoadBalancerSourceSecurityGroup struct {

	// The name of the security group.
	GroupName *string `type:"string"`

	// The owner of the security group.
	OwnerAlias *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about the security group for the load balancer.

func (AwsElbLoadBalancerSourceSecurityGroup) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElbLoadBalancerSourceSecurityGroup) SetGroupName

SetGroupName sets the GroupName field's value.

func (*AwsElbLoadBalancerSourceSecurityGroup) SetOwnerAlias

SetOwnerAlias sets the OwnerAlias field's value.

func (AwsElbLoadBalancerSourceSecurityGroup) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElbv2LoadBalancerAttribute

type AwsElbv2LoadBalancerAttribute struct {

	// The name of the load balancer attribute.
	Key *string `type:"string"`

	// The value of the load balancer attribute.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A load balancer attribute.

func (AwsElbv2LoadBalancerAttribute) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElbv2LoadBalancerAttribute) SetKey

SetKey sets the Key field's value.

func (*AwsElbv2LoadBalancerAttribute) SetValue

SetValue sets the Value field's value.

func (AwsElbv2LoadBalancerAttribute) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsElbv2LoadBalancerDetails

type AwsElbv2LoadBalancerDetails struct {

	// The Availability Zones for the load balancer.
	AvailabilityZones []*AvailabilityZone `type:"list"`

	// The ID of the Amazon Route 53 hosted zone associated with the load balancer.
	CanonicalHostedZoneId *string `type:"string"`

	// Indicates when the load balancer was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreatedTime *string `type:"string"`

	// The public DNS name of the load balancer.
	DNSName *string `type:"string"`

	// The type of IP addresses used by the subnets for your load balancer. The
	// possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and
	// IPv6 addresses).
	IpAddressType *string `type:"string"`

	// Attributes of the load balancer.
	LoadBalancerAttributes []*AwsElbv2LoadBalancerAttribute `type:"list"`

	// The nodes of an Internet-facing load balancer have public IP addresses.
	Scheme *string `type:"string"`

	// The IDs of the security groups for the load balancer.
	SecurityGroups []*string `type:"list"`

	// The state of the load balancer.
	State *LoadBalancerState `type:"structure"`

	// The type of load balancer.
	Type *string `type:"string"`

	// The ID of the VPC for the load balancer.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a load balancer.

func (AwsElbv2LoadBalancerDetails) GoString

func (s AwsElbv2LoadBalancerDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsElbv2LoadBalancerDetails) SetAvailabilityZones

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*AwsElbv2LoadBalancerDetails) SetCanonicalHostedZoneId

func (s *AwsElbv2LoadBalancerDetails) SetCanonicalHostedZoneId(v string) *AwsElbv2LoadBalancerDetails

SetCanonicalHostedZoneId sets the CanonicalHostedZoneId field's value.

func (*AwsElbv2LoadBalancerDetails) SetCreatedTime

SetCreatedTime sets the CreatedTime field's value.

func (*AwsElbv2LoadBalancerDetails) SetDNSName

SetDNSName sets the DNSName field's value.

func (*AwsElbv2LoadBalancerDetails) SetIpAddressType

SetIpAddressType sets the IpAddressType field's value.

func (*AwsElbv2LoadBalancerDetails) SetLoadBalancerAttributes

SetLoadBalancerAttributes sets the LoadBalancerAttributes field's value.

func (*AwsElbv2LoadBalancerDetails) SetScheme

SetScheme sets the Scheme field's value.

func (*AwsElbv2LoadBalancerDetails) SetSecurityGroups

SetSecurityGroups sets the SecurityGroups field's value.

func (*AwsElbv2LoadBalancerDetails) SetState

SetState sets the State field's value.

func (*AwsElbv2LoadBalancerDetails) SetType

SetType sets the Type field's value.

func (*AwsElbv2LoadBalancerDetails) SetVpcId

SetVpcId sets the VpcId field's value.

func (AwsElbv2LoadBalancerDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsEventSchemasRegistryDetails added in v1.42.9

type AwsEventSchemasRegistryDetails struct {

	// A description of the registry to be created.
	Description *string `type:"string"`

	// The Amazon Resource Name (ARN) of the registry.
	RegistryArn *string `type:"string"`

	// The name of the schema registry.
	RegistryName *string `type:"string"`
	// contains filtered or unexported fields
}

A schema defines the structure of events that are sent to Amazon EventBridge. Schema registries are containers for schemas. They collect and organize schemas so that your schemas are in logical groups.

func (AwsEventSchemasRegistryDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsEventSchemasRegistryDetails) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*AwsEventSchemasRegistryDetails) SetRegistryArn added in v1.42.9

SetRegistryArn sets the RegistryArn field's value.

func (*AwsEventSchemasRegistryDetails) SetRegistryName added in v1.42.9

SetRegistryName sets the RegistryName field's value.

func (AwsEventSchemasRegistryDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsGuardDutyDetectorDataSourcesCloudTrailDetails added in v1.42.9

type AwsGuardDutyDetectorDataSourcesCloudTrailDetails struct {

	// Specifies whether CloudTrail is activated as a data source for the detector.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

An object that contains information on the status of CloudTrail as a data source for the detector.

func (AwsGuardDutyDetectorDataSourcesCloudTrailDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsGuardDutyDetectorDataSourcesCloudTrailDetails) SetStatus added in v1.42.9

SetStatus sets the Status field's value.

func (AwsGuardDutyDetectorDataSourcesCloudTrailDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsGuardDutyDetectorDataSourcesDetails added in v1.42.9

type AwsGuardDutyDetectorDataSourcesDetails struct {

	// An object that contains information on the status of CloudTrail as a data
	// source for the detector.
	CloudTrail *AwsGuardDutyDetectorDataSourcesCloudTrailDetails `type:"structure"`

	// An object that contains information on the status of DNS logs as a data source
	// for the detector.
	DnsLogs *AwsGuardDutyDetectorDataSourcesDnsLogsDetails `type:"structure"`

	// An object that contains information on the status of VPC Flow Logs as a data
	// source for the detector.
	FlowLogs *AwsGuardDutyDetectorDataSourcesFlowLogsDetails `type:"structure"`

	// An object that contains information on the status of Kubernetes data sources
	// for the detector.
	Kubernetes *AwsGuardDutyDetectorDataSourcesKubernetesDetails `type:"structure"`

	// An object that contains information on the status of Malware Protection as
	// a data source for the detector.
	MalwareProtection *AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails `type:"structure"`

	// An object that contains information on the status of S3 Data event logs as
	// a data source for the detector.
	S3Logs *AwsGuardDutyDetectorDataSourcesS3LogsDetails `type:"structure"`
	// contains filtered or unexported fields
}

Describes which data sources are activated for the detector.

func (AwsGuardDutyDetectorDataSourcesDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsGuardDutyDetectorDataSourcesDetails) SetCloudTrail added in v1.42.9

SetCloudTrail sets the CloudTrail field's value.

func (*AwsGuardDutyDetectorDataSourcesDetails) SetDnsLogs added in v1.42.9

SetDnsLogs sets the DnsLogs field's value.

func (*AwsGuardDutyDetectorDataSourcesDetails) SetFlowLogs added in v1.42.9

SetFlowLogs sets the FlowLogs field's value.

func (*AwsGuardDutyDetectorDataSourcesDetails) SetKubernetes added in v1.42.9

SetKubernetes sets the Kubernetes field's value.

func (*AwsGuardDutyDetectorDataSourcesDetails) SetMalwareProtection added in v1.42.9

SetMalwareProtection sets the MalwareProtection field's value.

func (*AwsGuardDutyDetectorDataSourcesDetails) SetS3Logs added in v1.42.9

SetS3Logs sets the S3Logs field's value.

func (AwsGuardDutyDetectorDataSourcesDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsGuardDutyDetectorDataSourcesDnsLogsDetails added in v1.42.9

type AwsGuardDutyDetectorDataSourcesDnsLogsDetails struct {

	// Describes whether DNS logs is enabled as a data source for the detector.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

An object that contains information on the status of DNS logs as a data source for the detector.

func (AwsGuardDutyDetectorDataSourcesDnsLogsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsGuardDutyDetectorDataSourcesDnsLogsDetails) SetStatus added in v1.42.9

SetStatus sets the Status field's value.

func (AwsGuardDutyDetectorDataSourcesDnsLogsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsGuardDutyDetectorDataSourcesFlowLogsDetails added in v1.42.9

type AwsGuardDutyDetectorDataSourcesFlowLogsDetails struct {

	// Describes whether VPC Flow Logs are activated as a data source for the detector.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

An object that contains information on the status of VPC Flow Logs as a data source for the detector.

func (AwsGuardDutyDetectorDataSourcesFlowLogsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsGuardDutyDetectorDataSourcesFlowLogsDetails) SetStatus added in v1.42.9

SetStatus sets the Status field's value.

func (AwsGuardDutyDetectorDataSourcesFlowLogsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails added in v1.42.9

type AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails struct {

	// Describes whether Kubernetes audit logs are activated as a data source for
	// the detector.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

An object that contains information on the status of Kubernetes audit logs as a data source for the detector.

func (AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails) SetStatus added in v1.42.9

SetStatus sets the Status field's value.

func (AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsGuardDutyDetectorDataSourcesKubernetesDetails added in v1.42.9

type AwsGuardDutyDetectorDataSourcesKubernetesDetails struct {

	// Describes whether Kubernetes audit logs are activated as a data source for
	// the detector.
	AuditLogs *AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails `type:"structure"`
	// contains filtered or unexported fields
}

An object that contains information on the status of Kubernetes data sources for the detector.

func (AwsGuardDutyDetectorDataSourcesKubernetesDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsGuardDutyDetectorDataSourcesKubernetesDetails) SetAuditLogs added in v1.42.9

SetAuditLogs sets the AuditLogs field's value.

func (AwsGuardDutyDetectorDataSourcesKubernetesDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails added in v1.42.9

type AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails struct {

	// Describes the configuration of Malware Protection for EC2 instances with
	// findings.
	ScanEc2InstanceWithFindings *AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails `type:"structure"`

	// The GuardDuty Malware Protection service role.
	ServiceRole *string `type:"string"`
	// contains filtered or unexported fields
}

An object that contains information on the status of Malware Protection as a data source for the detector.

func (AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails) SetScanEc2InstanceWithFindings added in v1.42.9

SetScanEc2InstanceWithFindings sets the ScanEc2InstanceWithFindings field's value.

func (*AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails) SetServiceRole added in v1.42.9

SetServiceRole sets the ServiceRole field's value.

func (AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails added in v1.42.9

type AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails struct {

	// Describes the configuration of scanning EBS volumes (Malware Protection)
	// as a data source.
	EbsVolumes *AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails `type:"structure"`
	// contains filtered or unexported fields
}

Describes the configuration of Malware Protection for EC2 instances with findings.

func (AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails) SetEbsVolumes added in v1.42.9

SetEbsVolumes sets the EbsVolumes field's value.

func (AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails added in v1.42.9

type AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails struct {

	// Specifies the reason why scanning EBS volumes (Malware Protection) isn’t
	// activated as a data source.
	Reason *string `type:"string"`

	// Describes whether scanning EBS volumes is activated as a data source for
	// the detector.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the configuration of scanning EBS volumes (Malware Protection) as a data source.

func (AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails) SetReason added in v1.42.9

SetReason sets the Reason field's value.

func (*AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails) SetStatus added in v1.42.9

SetStatus sets the Status field's value.

func (AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsGuardDutyDetectorDataSourcesS3LogsDetails added in v1.42.9

type AwsGuardDutyDetectorDataSourcesS3LogsDetails struct {

	// A value that describes whether S3 data event logs are automatically enabled
	// for new members of an organization.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

An object that contains information on the status of S3 data event logs as a data source for the detector.

func (AwsGuardDutyDetectorDataSourcesS3LogsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsGuardDutyDetectorDataSourcesS3LogsDetails) SetStatus added in v1.42.9

SetStatus sets the Status field's value.

func (AwsGuardDutyDetectorDataSourcesS3LogsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsGuardDutyDetectorDetails added in v1.42.9

type AwsGuardDutyDetectorDetails struct {

	// Describes which data sources are activated for the detector.
	DataSources *AwsGuardDutyDetectorDataSourcesDetails `type:"structure"`

	// Describes which features are activated for the detector.
	Features []*AwsGuardDutyDetectorFeaturesDetails `type:"list"`

	// The publishing frequency of the finding.
	FindingPublishingFrequency *string `type:"string"`

	// The GuardDuty service role.
	ServiceRole *string `type:"string"`

	// The activation status of the detector.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about an Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. A detector is required for GuardDuty to become operational.

func (AwsGuardDutyDetectorDetails) GoString added in v1.42.9

func (s AwsGuardDutyDetectorDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsGuardDutyDetectorDetails) SetDataSources added in v1.42.9

SetDataSources sets the DataSources field's value.

func (*AwsGuardDutyDetectorDetails) SetFeatures added in v1.42.9

SetFeatures sets the Features field's value.

func (*AwsGuardDutyDetectorDetails) SetFindingPublishingFrequency added in v1.42.9

func (s *AwsGuardDutyDetectorDetails) SetFindingPublishingFrequency(v string) *AwsGuardDutyDetectorDetails

SetFindingPublishingFrequency sets the FindingPublishingFrequency field's value.

func (*AwsGuardDutyDetectorDetails) SetServiceRole added in v1.42.9

SetServiceRole sets the ServiceRole field's value.

func (*AwsGuardDutyDetectorDetails) SetStatus added in v1.42.9

SetStatus sets the Status field's value.

func (AwsGuardDutyDetectorDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsGuardDutyDetectorFeaturesDetails added in v1.42.9

type AwsGuardDutyDetectorFeaturesDetails struct {

	// Indicates the name of the feature that is activated for the detector.
	Name *string `type:"string"`

	// Indicates the status of the feature that is activated for the detector.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Describes which features are activated for the detector.

func (AwsGuardDutyDetectorFeaturesDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsGuardDutyDetectorFeaturesDetails) SetName added in v1.42.9

SetName sets the Name field's value.

func (*AwsGuardDutyDetectorFeaturesDetails) SetStatus added in v1.42.9

SetStatus sets the Status field's value.

func (AwsGuardDutyDetectorFeaturesDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsIamAccessKeyDetails

type AwsIamAccessKeyDetails struct {

	// The identifier of the access key.
	AccessKeyId *string `type:"string"`

	// The Amazon Web Services account ID of the account for the key.
	AccountId *string `type:"string"`

	// Indicates when the IAM access key was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreatedAt *string `type:"string"`

	// The ID of the principal associated with an access key.
	PrincipalId *string `type:"string"`

	// The name of the principal.
	PrincipalName *string `type:"string"`

	// The type of principal associated with an access key.
	PrincipalType *string `type:"string"`

	// Information about the session that the key was used for.
	SessionContext *AwsIamAccessKeySessionContext `type:"structure"`

	// The status of the IAM access key related to a finding.
	Status *string `type:"string" enum:"AwsIamAccessKeyStatus"`

	// The user associated with the IAM access key related to a finding.
	//
	// The UserName parameter has been replaced with the PrincipalName parameter
	// because access keys can also be assigned to principals that are not IAM users.
	//
	// Deprecated: This filter is deprecated. Instead, use PrincipalName.
	UserName *string `deprecated:"true" type:"string"`
	// contains filtered or unexported fields
}

IAM access key details related to a finding.

func (AwsIamAccessKeyDetails) GoString

func (s AwsIamAccessKeyDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamAccessKeyDetails) SetAccessKeyId

SetAccessKeyId sets the AccessKeyId field's value.

func (*AwsIamAccessKeyDetails) SetAccountId

SetAccountId sets the AccountId field's value.

func (*AwsIamAccessKeyDetails) SetCreatedAt

SetCreatedAt sets the CreatedAt field's value.

func (*AwsIamAccessKeyDetails) SetPrincipalId

SetPrincipalId sets the PrincipalId field's value.

func (*AwsIamAccessKeyDetails) SetPrincipalName

func (s *AwsIamAccessKeyDetails) SetPrincipalName(v string) *AwsIamAccessKeyDetails

SetPrincipalName sets the PrincipalName field's value.

func (*AwsIamAccessKeyDetails) SetPrincipalType

func (s *AwsIamAccessKeyDetails) SetPrincipalType(v string) *AwsIamAccessKeyDetails

SetPrincipalType sets the PrincipalType field's value.

func (*AwsIamAccessKeyDetails) SetSessionContext

SetSessionContext sets the SessionContext field's value.

func (*AwsIamAccessKeyDetails) SetStatus

SetStatus sets the Status field's value.

func (*AwsIamAccessKeyDetails) SetUserName

SetUserName sets the UserName field's value.

func (AwsIamAccessKeyDetails) String

func (s AwsIamAccessKeyDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsIamAccessKeySessionContext

type AwsIamAccessKeySessionContext struct {

	// Attributes of the session that the key was used for.
	Attributes *AwsIamAccessKeySessionContextAttributes `type:"structure"`

	// Information about the entity that created the session.
	SessionIssuer *AwsIamAccessKeySessionContextSessionIssuer `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about the session that the key was used for.

func (AwsIamAccessKeySessionContext) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamAccessKeySessionContext) SetAttributes

SetAttributes sets the Attributes field's value.

func (*AwsIamAccessKeySessionContext) SetSessionIssuer

SetSessionIssuer sets the SessionIssuer field's value.

func (AwsIamAccessKeySessionContext) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsIamAccessKeySessionContextAttributes

type AwsIamAccessKeySessionContextAttributes struct {

	// Indicates when the session was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreationDate *string `type:"string"`

	// Indicates whether the session used multi-factor authentication (MFA).
	MfaAuthenticated *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Attributes of the session that the key was used for.

func (AwsIamAccessKeySessionContextAttributes) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamAccessKeySessionContextAttributes) SetCreationDate

SetCreationDate sets the CreationDate field's value.

func (*AwsIamAccessKeySessionContextAttributes) SetMfaAuthenticated

SetMfaAuthenticated sets the MfaAuthenticated field's value.

func (AwsIamAccessKeySessionContextAttributes) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsIamAccessKeySessionContextSessionIssuer

type AwsIamAccessKeySessionContextSessionIssuer struct {

	// The identifier of the Amazon Web Services account that created the session.
	AccountId *string `type:"string"`

	// The ARN of the session.
	Arn *string `type:"string"`

	// The principal ID of the principal (user, role, or group) that created the
	// session.
	PrincipalId *string `type:"string"`

	// The type of principal (user, role, or group) that created the session.
	Type *string `type:"string"`

	// The name of the principal that created the session.
	UserName *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the entity that created the session.

func (AwsIamAccessKeySessionContextSessionIssuer) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamAccessKeySessionContextSessionIssuer) SetAccountId

SetAccountId sets the AccountId field's value.

func (*AwsIamAccessKeySessionContextSessionIssuer) SetArn

SetArn sets the Arn field's value.

func (*AwsIamAccessKeySessionContextSessionIssuer) SetPrincipalId

SetPrincipalId sets the PrincipalId field's value.

func (*AwsIamAccessKeySessionContextSessionIssuer) SetType

SetType sets the Type field's value.

func (*AwsIamAccessKeySessionContextSessionIssuer) SetUserName

SetUserName sets the UserName field's value.

func (AwsIamAccessKeySessionContextSessionIssuer) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsIamAttachedManagedPolicy

type AwsIamAttachedManagedPolicy struct {

	// The ARN of the policy.
	PolicyArn *string `type:"string"`

	// The name of the policy.
	PolicyName *string `type:"string"`
	// contains filtered or unexported fields
}

A managed policy that is attached to an IAM principal.

func (AwsIamAttachedManagedPolicy) GoString

func (s AwsIamAttachedManagedPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamAttachedManagedPolicy) SetPolicyArn

SetPolicyArn sets the PolicyArn field's value.

func (*AwsIamAttachedManagedPolicy) SetPolicyName

SetPolicyName sets the PolicyName field's value.

func (AwsIamAttachedManagedPolicy) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsIamGroupDetails

type AwsIamGroupDetails struct {

	// A list of the managed policies that are attached to the IAM group.
	AttachedManagedPolicies []*AwsIamAttachedManagedPolicy `type:"list"`

	// Indicates when the IAM group was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreateDate *string `type:"string"`

	// The identifier of the IAM group.
	GroupId *string `type:"string"`

	// The name of the IAM group.
	GroupName *string `type:"string"`

	// The list of inline policies that are embedded in the group.
	GroupPolicyList []*AwsIamGroupPolicy `type:"list"`

	// The path to the group.
	Path *string `type:"string"`
	// contains filtered or unexported fields
}

Contains details about an IAM group.

func (AwsIamGroupDetails) GoString

func (s AwsIamGroupDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamGroupDetails) SetAttachedManagedPolicies

func (s *AwsIamGroupDetails) SetAttachedManagedPolicies(v []*AwsIamAttachedManagedPolicy) *AwsIamGroupDetails

SetAttachedManagedPolicies sets the AttachedManagedPolicies field's value.

func (*AwsIamGroupDetails) SetCreateDate

func (s *AwsIamGroupDetails) SetCreateDate(v string) *AwsIamGroupDetails

SetCreateDate sets the CreateDate field's value.

func (*AwsIamGroupDetails) SetGroupId

func (s *AwsIamGroupDetails) SetGroupId(v string) *AwsIamGroupDetails

SetGroupId sets the GroupId field's value.

func (*AwsIamGroupDetails) SetGroupName

func (s *AwsIamGroupDetails) SetGroupName(v string) *AwsIamGroupDetails

SetGroupName sets the GroupName field's value.

func (*AwsIamGroupDetails) SetGroupPolicyList

func (s *AwsIamGroupDetails) SetGroupPolicyList(v []*AwsIamGroupPolicy) *AwsIamGroupDetails

SetGroupPolicyList sets the GroupPolicyList field's value.

func (*AwsIamGroupDetails) SetPath

SetPath sets the Path field's value.

func (AwsIamGroupDetails) String

func (s AwsIamGroupDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsIamGroupPolicy

type AwsIamGroupPolicy struct {

	// The name of the policy.
	PolicyName *string `type:"string"`
	// contains filtered or unexported fields
}

A managed policy that is attached to the IAM group.

func (AwsIamGroupPolicy) GoString

func (s AwsIamGroupPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamGroupPolicy) SetPolicyName

func (s *AwsIamGroupPolicy) SetPolicyName(v string) *AwsIamGroupPolicy

SetPolicyName sets the PolicyName field's value.

func (AwsIamGroupPolicy) String

func (s AwsIamGroupPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsIamInstanceProfile

type AwsIamInstanceProfile struct {

	// The ARN of the instance profile.
	Arn *string `type:"string"`

	// Indicates when the instance profile was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreateDate *string `type:"string"`

	// The identifier of the instance profile.
	InstanceProfileId *string `type:"string"`

	// The name of the instance profile.
	InstanceProfileName *string `type:"string"`

	// The path to the instance profile.
	Path *string `type:"string"`

	// The roles associated with the instance profile.
	Roles []*AwsIamInstanceProfileRole `type:"list"`
	// contains filtered or unexported fields
}

Information about an instance profile.

func (AwsIamInstanceProfile) GoString

func (s AwsIamInstanceProfile) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamInstanceProfile) SetArn

SetArn sets the Arn field's value.

func (*AwsIamInstanceProfile) SetCreateDate

func (s *AwsIamInstanceProfile) SetCreateDate(v string) *AwsIamInstanceProfile

SetCreateDate sets the CreateDate field's value.

func (*AwsIamInstanceProfile) SetInstanceProfileId

func (s *AwsIamInstanceProfile) SetInstanceProfileId(v string) *AwsIamInstanceProfile

SetInstanceProfileId sets the InstanceProfileId field's value.

func (*AwsIamInstanceProfile) SetInstanceProfileName

func (s *AwsIamInstanceProfile) SetInstanceProfileName(v string) *AwsIamInstanceProfile

SetInstanceProfileName sets the InstanceProfileName field's value.

func (*AwsIamInstanceProfile) SetPath

SetPath sets the Path field's value.

func (*AwsIamInstanceProfile) SetRoles

SetRoles sets the Roles field's value.

func (AwsIamInstanceProfile) String

func (s AwsIamInstanceProfile) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamInstanceProfile) Validate

func (s *AwsIamInstanceProfile) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AwsIamInstanceProfileRole

type AwsIamInstanceProfileRole struct {

	// The ARN of the role.
	Arn *string `type:"string"`

	// The policy that grants an entity permission to assume the role.
	AssumeRolePolicyDocument *string `min:"1" type:"string"`

	// Indicates when the role was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreateDate *string `type:"string"`

	// The path to the role.
	Path *string `type:"string"`

	// The identifier of the role.
	RoleId *string `type:"string"`

	// The name of the role.
	RoleName *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a role associated with an instance profile.

func (AwsIamInstanceProfileRole) GoString

func (s AwsIamInstanceProfileRole) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamInstanceProfileRole) SetArn

SetArn sets the Arn field's value.

func (*AwsIamInstanceProfileRole) SetAssumeRolePolicyDocument

func (s *AwsIamInstanceProfileRole) SetAssumeRolePolicyDocument(v string) *AwsIamInstanceProfileRole

SetAssumeRolePolicyDocument sets the AssumeRolePolicyDocument field's value.

func (*AwsIamInstanceProfileRole) SetCreateDate

SetCreateDate sets the CreateDate field's value.

func (*AwsIamInstanceProfileRole) SetPath

SetPath sets the Path field's value.

func (*AwsIamInstanceProfileRole) SetRoleId

SetRoleId sets the RoleId field's value.

func (*AwsIamInstanceProfileRole) SetRoleName

SetRoleName sets the RoleName field's value.

func (AwsIamInstanceProfileRole) String

func (s AwsIamInstanceProfileRole) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamInstanceProfileRole) Validate

func (s *AwsIamInstanceProfileRole) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AwsIamPermissionsBoundary

type AwsIamPermissionsBoundary struct {

	// The ARN of the policy used to set the permissions boundary.
	PermissionsBoundaryArn *string `type:"string"`

	// The usage type for the permissions boundary.
	PermissionsBoundaryType *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the policy used to set the permissions boundary for an IAM principal.

func (AwsIamPermissionsBoundary) GoString

func (s AwsIamPermissionsBoundary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamPermissionsBoundary) SetPermissionsBoundaryArn

func (s *AwsIamPermissionsBoundary) SetPermissionsBoundaryArn(v string) *AwsIamPermissionsBoundary

SetPermissionsBoundaryArn sets the PermissionsBoundaryArn field's value.

func (*AwsIamPermissionsBoundary) SetPermissionsBoundaryType

func (s *AwsIamPermissionsBoundary) SetPermissionsBoundaryType(v string) *AwsIamPermissionsBoundary

SetPermissionsBoundaryType sets the PermissionsBoundaryType field's value.

func (AwsIamPermissionsBoundary) String

func (s AwsIamPermissionsBoundary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsIamPolicyDetails

type AwsIamPolicyDetails struct {

	// The number of users, groups, and roles that the policy is attached to.
	AttachmentCount *int64 `type:"integer"`

	// When the policy was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreateDate *string `type:"string"`

	// The identifier of the default version of the policy.
	DefaultVersionId *string `type:"string"`

	// A description of the policy.
	Description *string `type:"string"`

	// Whether the policy can be attached to a user, group, or role.
	IsAttachable *bool `type:"boolean"`

	// The path to the policy.
	Path *string `type:"string"`

	// The number of users and roles that use the policy to set the permissions
	// boundary.
	PermissionsBoundaryUsageCount *int64 `type:"integer"`

	// The unique identifier of the policy.
	PolicyId *string `type:"string"`

	// The name of the policy.
	PolicyName *string `type:"string"`

	// List of versions of the policy.
	PolicyVersionList []*AwsIamPolicyVersion `type:"list"`

	// When the policy was most recently updated.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	UpdateDate *string `type:"string"`
	// contains filtered or unexported fields
}

Represents an IAM permissions policy.

func (AwsIamPolicyDetails) GoString

func (s AwsIamPolicyDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamPolicyDetails) SetAttachmentCount

func (s *AwsIamPolicyDetails) SetAttachmentCount(v int64) *AwsIamPolicyDetails

SetAttachmentCount sets the AttachmentCount field's value.

func (*AwsIamPolicyDetails) SetCreateDate

func (s *AwsIamPolicyDetails) SetCreateDate(v string) *AwsIamPolicyDetails

SetCreateDate sets the CreateDate field's value.

func (*AwsIamPolicyDetails) SetDefaultVersionId

func (s *AwsIamPolicyDetails) SetDefaultVersionId(v string) *AwsIamPolicyDetails

SetDefaultVersionId sets the DefaultVersionId field's value.

func (*AwsIamPolicyDetails) SetDescription

func (s *AwsIamPolicyDetails) SetDescription(v string) *AwsIamPolicyDetails

SetDescription sets the Description field's value.

func (*AwsIamPolicyDetails) SetIsAttachable

func (s *AwsIamPolicyDetails) SetIsAttachable(v bool) *AwsIamPolicyDetails

SetIsAttachable sets the IsAttachable field's value.

func (*AwsIamPolicyDetails) SetPath

SetPath sets the Path field's value.

func (*AwsIamPolicyDetails) SetPermissionsBoundaryUsageCount

func (s *AwsIamPolicyDetails) SetPermissionsBoundaryUsageCount(v int64) *AwsIamPolicyDetails

SetPermissionsBoundaryUsageCount sets the PermissionsBoundaryUsageCount field's value.

func (*AwsIamPolicyDetails) SetPolicyId

func (s *AwsIamPolicyDetails) SetPolicyId(v string) *AwsIamPolicyDetails

SetPolicyId sets the PolicyId field's value.

func (*AwsIamPolicyDetails) SetPolicyName

func (s *AwsIamPolicyDetails) SetPolicyName(v string) *AwsIamPolicyDetails

SetPolicyName sets the PolicyName field's value.

func (*AwsIamPolicyDetails) SetPolicyVersionList

func (s *AwsIamPolicyDetails) SetPolicyVersionList(v []*AwsIamPolicyVersion) *AwsIamPolicyDetails

SetPolicyVersionList sets the PolicyVersionList field's value.

func (*AwsIamPolicyDetails) SetUpdateDate

func (s *AwsIamPolicyDetails) SetUpdateDate(v string) *AwsIamPolicyDetails

SetUpdateDate sets the UpdateDate field's value.

func (AwsIamPolicyDetails) String

func (s AwsIamPolicyDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsIamPolicyVersion

type AwsIamPolicyVersion struct {

	// Indicates when the version was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreateDate *string `type:"string"`

	// Whether the version is the default version.
	IsDefaultVersion *bool `type:"boolean"`

	// The identifier of the policy version.
	VersionId *string `type:"string"`
	// contains filtered or unexported fields
}

A version of an IAM policy.

func (AwsIamPolicyVersion) GoString

func (s AwsIamPolicyVersion) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamPolicyVersion) SetCreateDate

func (s *AwsIamPolicyVersion) SetCreateDate(v string) *AwsIamPolicyVersion

SetCreateDate sets the CreateDate field's value.

func (*AwsIamPolicyVersion) SetIsDefaultVersion

func (s *AwsIamPolicyVersion) SetIsDefaultVersion(v bool) *AwsIamPolicyVersion

SetIsDefaultVersion sets the IsDefaultVersion field's value.

func (*AwsIamPolicyVersion) SetVersionId

func (s *AwsIamPolicyVersion) SetVersionId(v string) *AwsIamPolicyVersion

SetVersionId sets the VersionId field's value.

func (AwsIamPolicyVersion) String

func (s AwsIamPolicyVersion) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsIamRoleDetails

type AwsIamRoleDetails struct {

	// The trust policy that grants permission to assume the role.
	AssumeRolePolicyDocument *string `min:"1" type:"string"`

	// The list of the managed policies that are attached to the role.
	AttachedManagedPolicies []*AwsIamAttachedManagedPolicy `type:"list"`

	// Indicates when the role was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreateDate *string `type:"string"`

	// The list of instance profiles that contain this role.
	InstanceProfileList []*AwsIamInstanceProfile `type:"list"`

	// The maximum session duration (in seconds) that you want to set for the specified
	// role.
	MaxSessionDuration *int64 `type:"integer"`

	// The path to the role.
	Path *string `type:"string"`

	// Information about the policy used to set the permissions boundary for an
	// IAM principal.
	PermissionsBoundary *AwsIamPermissionsBoundary `type:"structure"`

	// The stable and unique string identifying the role.
	RoleId *string `type:"string"`

	// The friendly name that identifies the role.
	RoleName *string `type:"string"`

	// The list of inline policies that are embedded in the role.
	RolePolicyList []*AwsIamRolePolicy `type:"list"`
	// contains filtered or unexported fields
}

Contains information about an IAM role, including all of the role's policies.

func (AwsIamRoleDetails) GoString

func (s AwsIamRoleDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamRoleDetails) SetAssumeRolePolicyDocument

func (s *AwsIamRoleDetails) SetAssumeRolePolicyDocument(v string) *AwsIamRoleDetails

SetAssumeRolePolicyDocument sets the AssumeRolePolicyDocument field's value.

func (*AwsIamRoleDetails) SetAttachedManagedPolicies

func (s *AwsIamRoleDetails) SetAttachedManagedPolicies(v []*AwsIamAttachedManagedPolicy) *AwsIamRoleDetails

SetAttachedManagedPolicies sets the AttachedManagedPolicies field's value.

func (*AwsIamRoleDetails) SetCreateDate

func (s *AwsIamRoleDetails) SetCreateDate(v string) *AwsIamRoleDetails

SetCreateDate sets the CreateDate field's value.

func (*AwsIamRoleDetails) SetInstanceProfileList

func (s *AwsIamRoleDetails) SetInstanceProfileList(v []*AwsIamInstanceProfile) *AwsIamRoleDetails

SetInstanceProfileList sets the InstanceProfileList field's value.

func (*AwsIamRoleDetails) SetMaxSessionDuration

func (s *AwsIamRoleDetails) SetMaxSessionDuration(v int64) *AwsIamRoleDetails

SetMaxSessionDuration sets the MaxSessionDuration field's value.

func (*AwsIamRoleDetails) SetPath

SetPath sets the Path field's value.

func (*AwsIamRoleDetails) SetPermissionsBoundary

func (s *AwsIamRoleDetails) SetPermissionsBoundary(v *AwsIamPermissionsBoundary) *AwsIamRoleDetails

SetPermissionsBoundary sets the PermissionsBoundary field's value.

func (*AwsIamRoleDetails) SetRoleId

func (s *AwsIamRoleDetails) SetRoleId(v string) *AwsIamRoleDetails

SetRoleId sets the RoleId field's value.

func (*AwsIamRoleDetails) SetRoleName

func (s *AwsIamRoleDetails) SetRoleName(v string) *AwsIamRoleDetails

SetRoleName sets the RoleName field's value.

func (*AwsIamRoleDetails) SetRolePolicyList

func (s *AwsIamRoleDetails) SetRolePolicyList(v []*AwsIamRolePolicy) *AwsIamRoleDetails

SetRolePolicyList sets the RolePolicyList field's value.

func (AwsIamRoleDetails) String

func (s AwsIamRoleDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamRoleDetails) Validate

func (s *AwsIamRoleDetails) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AwsIamRolePolicy

type AwsIamRolePolicy struct {

	// The name of the policy.
	PolicyName *string `type:"string"`
	// contains filtered or unexported fields
}

An inline policy that is embedded in the role.

func (AwsIamRolePolicy) GoString

func (s AwsIamRolePolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamRolePolicy) SetPolicyName

func (s *AwsIamRolePolicy) SetPolicyName(v string) *AwsIamRolePolicy

SetPolicyName sets the PolicyName field's value.

func (AwsIamRolePolicy) String

func (s AwsIamRolePolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsIamUserDetails

type AwsIamUserDetails struct {

	// A list of the managed policies that are attached to the user.
	AttachedManagedPolicies []*AwsIamAttachedManagedPolicy `type:"list"`

	// Indicates when the user was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreateDate *string `type:"string"`

	// A list of IAM groups that the user belongs to.
	GroupList []*string `type:"list"`

	// The path to the user.
	Path *string `type:"string"`

	// The permissions boundary for the user.
	PermissionsBoundary *AwsIamPermissionsBoundary `type:"structure"`

	// The unique identifier for the user.
	UserId *string `type:"string"`

	// The name of the user.
	UserName *string `type:"string"`

	// The list of inline policies that are embedded in the user.
	UserPolicyList []*AwsIamUserPolicy `type:"list"`
	// contains filtered or unexported fields
}

Information about an IAM user.

func (AwsIamUserDetails) GoString

func (s AwsIamUserDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamUserDetails) SetAttachedManagedPolicies

func (s *AwsIamUserDetails) SetAttachedManagedPolicies(v []*AwsIamAttachedManagedPolicy) *AwsIamUserDetails

SetAttachedManagedPolicies sets the AttachedManagedPolicies field's value.

func (*AwsIamUserDetails) SetCreateDate

func (s *AwsIamUserDetails) SetCreateDate(v string) *AwsIamUserDetails

SetCreateDate sets the CreateDate field's value.

func (*AwsIamUserDetails) SetGroupList

func (s *AwsIamUserDetails) SetGroupList(v []*string) *AwsIamUserDetails

SetGroupList sets the GroupList field's value.

func (*AwsIamUserDetails) SetPath

SetPath sets the Path field's value.

func (*AwsIamUserDetails) SetPermissionsBoundary

func (s *AwsIamUserDetails) SetPermissionsBoundary(v *AwsIamPermissionsBoundary) *AwsIamUserDetails

SetPermissionsBoundary sets the PermissionsBoundary field's value.

func (*AwsIamUserDetails) SetUserId

func (s *AwsIamUserDetails) SetUserId(v string) *AwsIamUserDetails

SetUserId sets the UserId field's value.

func (*AwsIamUserDetails) SetUserName

func (s *AwsIamUserDetails) SetUserName(v string) *AwsIamUserDetails

SetUserName sets the UserName field's value.

func (*AwsIamUserDetails) SetUserPolicyList

func (s *AwsIamUserDetails) SetUserPolicyList(v []*AwsIamUserPolicy) *AwsIamUserDetails

SetUserPolicyList sets the UserPolicyList field's value.

func (AwsIamUserDetails) String

func (s AwsIamUserDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsIamUserPolicy

type AwsIamUserPolicy struct {

	// The name of the policy.
	PolicyName *string `type:"string"`
	// contains filtered or unexported fields
}

Information about an inline policy that is embedded in the user.

func (AwsIamUserPolicy) GoString

func (s AwsIamUserPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsIamUserPolicy) SetPolicyName

func (s *AwsIamUserPolicy) SetPolicyName(v string) *AwsIamUserPolicy

SetPolicyName sets the PolicyName field's value.

func (AwsIamUserPolicy) String

func (s AwsIamUserPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsKinesisStreamDetails added in v1.42.9

type AwsKinesisStreamDetails struct {

	// The Amazon Resource Name (ARN) of the Kinesis data stream.
	Arn *string `type:"string"`

	// The name of the Kinesis stream. If you don't specify a name, CloudFront generates
	// a unique physical ID and uses that ID for the stream name.
	Name *string `type:"string"`

	// The number of hours for the data records that are stored in shards to remain
	// accessible.
	RetentionPeriodHours *int64 `type:"integer"`

	// The number of shards that the stream uses.
	ShardCount *int64 `type:"integer"`

	// When specified, enables or updates server-side encryption using an KMS key
	// for a specified stream. Removing this property from your stack template and
	// updating your stack disables encryption.
	StreamEncryption *AwsKinesisStreamStreamEncryptionDetails `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about an Amazon Kinesis data stream.

func (AwsKinesisStreamDetails) GoString added in v1.42.9

func (s AwsKinesisStreamDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsKinesisStreamDetails) SetArn added in v1.42.9

SetArn sets the Arn field's value.

func (*AwsKinesisStreamDetails) SetName added in v1.42.9

SetName sets the Name field's value.

func (*AwsKinesisStreamDetails) SetRetentionPeriodHours added in v1.42.9

func (s *AwsKinesisStreamDetails) SetRetentionPeriodHours(v int64) *AwsKinesisStreamDetails

SetRetentionPeriodHours sets the RetentionPeriodHours field's value.

func (*AwsKinesisStreamDetails) SetShardCount added in v1.42.9

SetShardCount sets the ShardCount field's value.

func (*AwsKinesisStreamDetails) SetStreamEncryption added in v1.42.9

SetStreamEncryption sets the StreamEncryption field's value.

func (AwsKinesisStreamDetails) String added in v1.42.9

func (s AwsKinesisStreamDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsKinesisStreamStreamEncryptionDetails added in v1.42.9

type AwsKinesisStreamStreamEncryptionDetails struct {

	// The encryption type to use.
	EncryptionType *string `type:"string"`

	// The globally unique identifier for the customer-managed KMS key to use for
	// encryption.
	KeyId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about stream encryption.

func (AwsKinesisStreamStreamEncryptionDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsKinesisStreamStreamEncryptionDetails) SetEncryptionType added in v1.42.9

SetEncryptionType sets the EncryptionType field's value.

func (*AwsKinesisStreamStreamEncryptionDetails) SetKeyId added in v1.42.9

SetKeyId sets the KeyId field's value.

func (AwsKinesisStreamStreamEncryptionDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsKmsKeyDetails

type AwsKmsKeyDetails struct {

	// The twelve-digit account ID of the Amazon Web Services account that owns
	// the KMS key.
	AWSAccountId *string `type:"string"`

	// Indicates when the KMS key was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreationDate *float64 `type:"double"`

	// A description of the KMS key.
	Description *string `type:"string"`

	// The globally unique identifier for the KMS key.
	KeyId *string `type:"string"`

	// The manager of the KMS key. KMS keys in your Amazon Web Services account
	// are either customer managed or Amazon Web Services managed.
	KeyManager *string `type:"string"`

	// Whether the key has key rotation enabled.
	KeyRotationStatus *bool `type:"boolean"`

	// The state of the KMS key. Valid values are as follows:
	//
	//    * Disabled
	//
	//    * Enabled
	//
	//    * PendingDeletion
	//
	//    * PendingImport
	//
	//    * Unavailable
	KeyState *string `type:"string"`

	// The source of the KMS key material.
	//
	// When this value is AWS_KMS, KMS created the key material.
	//
	// When this value is EXTERNAL, the key material was imported from your existing
	// key management infrastructure or the KMS key lacks key material.
	//
	// When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM
	// cluster associated with a custom key store.
	Origin *string `type:"string"`
	// contains filtered or unexported fields
}

Contains metadata about an KMS key.

func (AwsKmsKeyDetails) GoString

func (s AwsKmsKeyDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsKmsKeyDetails) SetAWSAccountId

func (s *AwsKmsKeyDetails) SetAWSAccountId(v string) *AwsKmsKeyDetails

SetAWSAccountId sets the AWSAccountId field's value.

func (*AwsKmsKeyDetails) SetCreationDate

func (s *AwsKmsKeyDetails) SetCreationDate(v float64) *AwsKmsKeyDetails

SetCreationDate sets the CreationDate field's value.

func (*AwsKmsKeyDetails) SetDescription

func (s *AwsKmsKeyDetails) SetDescription(v string) *AwsKmsKeyDetails

SetDescription sets the Description field's value.

func (*AwsKmsKeyDetails) SetKeyId

func (s *AwsKmsKeyDetails) SetKeyId(v string) *AwsKmsKeyDetails

SetKeyId sets the KeyId field's value.

func (*AwsKmsKeyDetails) SetKeyManager

func (s *AwsKmsKeyDetails) SetKeyManager(v string) *AwsKmsKeyDetails

SetKeyManager sets the KeyManager field's value.

func (*AwsKmsKeyDetails) SetKeyRotationStatus

func (s *AwsKmsKeyDetails) SetKeyRotationStatus(v bool) *AwsKmsKeyDetails

SetKeyRotationStatus sets the KeyRotationStatus field's value.

func (*AwsKmsKeyDetails) SetKeyState

func (s *AwsKmsKeyDetails) SetKeyState(v string) *AwsKmsKeyDetails

SetKeyState sets the KeyState field's value.

func (*AwsKmsKeyDetails) SetOrigin

func (s *AwsKmsKeyDetails) SetOrigin(v string) *AwsKmsKeyDetails

SetOrigin sets the Origin field's value.

func (AwsKmsKeyDetails) String

func (s AwsKmsKeyDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsLambdaFunctionCode

type AwsLambdaFunctionCode struct {

	// An Amazon S3 bucket in the same Amazon Web Services Region as your function.
	// The bucket can be in a different Amazon Web Services account.
	S3Bucket *string `type:"string"`

	// The Amazon S3 key of the deployment package.
	S3Key *string `type:"string"`

	// For versioned objects, the version of the deployment package object to use.
	S3ObjectVersion *string `type:"string"`

	// The base64-encoded contents of the deployment package. Amazon Web Services
	// SDK and Amazon Web Services CLI clients handle the encoding for you.
	ZipFile *string `type:"string"`
	// contains filtered or unexported fields
}

The code for the Lambda function. You can specify either an object in Amazon S3, or upload a deployment package directly.

func (AwsLambdaFunctionCode) GoString

func (s AwsLambdaFunctionCode) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsLambdaFunctionCode) SetS3Bucket

SetS3Bucket sets the S3Bucket field's value.

func (*AwsLambdaFunctionCode) SetS3Key

SetS3Key sets the S3Key field's value.

func (*AwsLambdaFunctionCode) SetS3ObjectVersion

func (s *AwsLambdaFunctionCode) SetS3ObjectVersion(v string) *AwsLambdaFunctionCode

SetS3ObjectVersion sets the S3ObjectVersion field's value.

func (*AwsLambdaFunctionCode) SetZipFile

SetZipFile sets the ZipFile field's value.

func (AwsLambdaFunctionCode) String

func (s AwsLambdaFunctionCode) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsLambdaFunctionDeadLetterConfig

type AwsLambdaFunctionDeadLetterConfig struct {

	// The ARN of an SQS queue or SNS topic.
	TargetArn *string `type:"string"`
	// contains filtered or unexported fields
}

The dead-letter queue for failed asynchronous invocations.

func (AwsLambdaFunctionDeadLetterConfig) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsLambdaFunctionDeadLetterConfig) SetTargetArn

SetTargetArn sets the TargetArn field's value.

func (AwsLambdaFunctionDeadLetterConfig) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsLambdaFunctionDetails

type AwsLambdaFunctionDetails struct {

	// The instruction set architecture that the function uses. Valid values are
	// x86_64 or arm64.
	Architectures []*string `type:"list"`

	// An AwsLambdaFunctionCode object.
	Code *AwsLambdaFunctionCode `type:"structure"`

	// The SHA256 hash of the function's deployment package.
	CodeSha256 *string `type:"string"`

	// The function's dead letter queue.
	DeadLetterConfig *AwsLambdaFunctionDeadLetterConfig `type:"structure"`

	// The function's environment variables.
	Environment *AwsLambdaFunctionEnvironment `type:"structure"`

	// The name of the function.
	FunctionName *string `type:"string"`

	// The function that Lambda calls to begin executing your function.
	Handler *string `type:"string"`

	// The KMS key that is used to encrypt the function's environment variables.
	// This key is only returned if you've configured a customer managed customer
	// managed key.
	KmsKeyArn *string `type:"string"`

	// Indicates when the function was last updated.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	LastModified *string `type:"string"`

	// The function's layers.
	Layers []*AwsLambdaFunctionLayer `type:"list"`

	// For Lambda@Edge functions, the ARN of the master function.
	MasterArn *string `type:"string"`

	// The memory that is allocated to the function.
	MemorySize *int64 `type:"integer"`

	// The type of deployment package that's used to deploy the function code to
	// Lambda. Set to Image for a container image and Zip for a .zip file archive.
	PackageType *string `type:"string"`

	// The latest updated revision of the function or alias.
	RevisionId *string `type:"string"`

	// The function's execution role.
	Role *string `type:"string"`

	// The runtime environment for the Lambda function.
	Runtime *string `type:"string"`

	// The amount of time that Lambda allows a function to run before stopping it.
	Timeout *int64 `type:"integer"`

	// The function's X-Ray tracing configuration.
	TracingConfig *AwsLambdaFunctionTracingConfig `type:"structure"`

	// The version of the Lambda function.
	Version *string `type:"string"`

	// The function's networking configuration.
	VpcConfig *AwsLambdaFunctionVpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Details about an Lambda function's configuration.

func (AwsLambdaFunctionDetails) GoString

func (s AwsLambdaFunctionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsLambdaFunctionDetails) SetArchitectures added in v1.42.9

func (s *AwsLambdaFunctionDetails) SetArchitectures(v []*string) *AwsLambdaFunctionDetails

SetArchitectures sets the Architectures field's value.

func (*AwsLambdaFunctionDetails) SetCode

SetCode sets the Code field's value.

func (*AwsLambdaFunctionDetails) SetCodeSha256

SetCodeSha256 sets the CodeSha256 field's value.

func (*AwsLambdaFunctionDetails) SetDeadLetterConfig

SetDeadLetterConfig sets the DeadLetterConfig field's value.

func (*AwsLambdaFunctionDetails) SetEnvironment

SetEnvironment sets the Environment field's value.

func (*AwsLambdaFunctionDetails) SetFunctionName

SetFunctionName sets the FunctionName field's value.

func (*AwsLambdaFunctionDetails) SetHandler

SetHandler sets the Handler field's value.

func (*AwsLambdaFunctionDetails) SetKmsKeyArn

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*AwsLambdaFunctionDetails) SetLastModified

SetLastModified sets the LastModified field's value.

func (*AwsLambdaFunctionDetails) SetLayers

SetLayers sets the Layers field's value.

func (*AwsLambdaFunctionDetails) SetMasterArn

SetMasterArn sets the MasterArn field's value.

func (*AwsLambdaFunctionDetails) SetMemorySize

SetMemorySize sets the MemorySize field's value.

func (*AwsLambdaFunctionDetails) SetPackageType added in v1.42.9

SetPackageType sets the PackageType field's value.

func (*AwsLambdaFunctionDetails) SetRevisionId

SetRevisionId sets the RevisionId field's value.

func (*AwsLambdaFunctionDetails) SetRole

SetRole sets the Role field's value.

func (*AwsLambdaFunctionDetails) SetRuntime

SetRuntime sets the Runtime field's value.

func (*AwsLambdaFunctionDetails) SetTimeout

SetTimeout sets the Timeout field's value.

func (*AwsLambdaFunctionDetails) SetTracingConfig

SetTracingConfig sets the TracingConfig field's value.

func (*AwsLambdaFunctionDetails) SetVersion

SetVersion sets the Version field's value.

func (*AwsLambdaFunctionDetails) SetVpcConfig

SetVpcConfig sets the VpcConfig field's value.

func (AwsLambdaFunctionDetails) String

func (s AwsLambdaFunctionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsLambdaFunctionEnvironment

type AwsLambdaFunctionEnvironment struct {

	// An AwsLambdaFunctionEnvironmentError object.
	Error *AwsLambdaFunctionEnvironmentError `type:"structure"`

	// Environment variable key-value pairs.
	Variables map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

A function's environment variable settings.

func (AwsLambdaFunctionEnvironment) GoString

func (s AwsLambdaFunctionEnvironment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsLambdaFunctionEnvironment) SetError

SetError sets the Error field's value.

func (*AwsLambdaFunctionEnvironment) SetVariables

SetVariables sets the Variables field's value.

func (AwsLambdaFunctionEnvironment) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsLambdaFunctionEnvironmentError

type AwsLambdaFunctionEnvironmentError struct {

	// The error code.
	ErrorCode *string `type:"string"`

	// The error message.
	Message *string `type:"string"`
	// contains filtered or unexported fields
}

Error messages for environment variables that could not be applied.

func (AwsLambdaFunctionEnvironmentError) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsLambdaFunctionEnvironmentError) SetErrorCode

SetErrorCode sets the ErrorCode field's value.

func (*AwsLambdaFunctionEnvironmentError) SetMessage

SetMessage sets the Message field's value.

func (AwsLambdaFunctionEnvironmentError) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsLambdaFunctionLayer

type AwsLambdaFunctionLayer struct {

	// The ARN of the function layer.
	Arn *string `type:"string"`

	// The size of the layer archive in bytes.
	CodeSize *int64 `type:"integer"`
	// contains filtered or unexported fields
}

An Lambda layer.

func (AwsLambdaFunctionLayer) GoString

func (s AwsLambdaFunctionLayer) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsLambdaFunctionLayer) SetArn

SetArn sets the Arn field's value.

func (*AwsLambdaFunctionLayer) SetCodeSize

SetCodeSize sets the CodeSize field's value.

func (AwsLambdaFunctionLayer) String

func (s AwsLambdaFunctionLayer) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsLambdaFunctionTracingConfig

type AwsLambdaFunctionTracingConfig struct {

	// The tracing mode.
	Mode *string `type:"string"`
	// contains filtered or unexported fields
}

The function's X-Ray tracing configuration.

func (AwsLambdaFunctionTracingConfig) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsLambdaFunctionTracingConfig) SetMode

SetMode sets the Mode field's value.

func (AwsLambdaFunctionTracingConfig) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsLambdaFunctionVpcConfig

type AwsLambdaFunctionVpcConfig struct {

	// A list of VPC security groups IDs.
	SecurityGroupIds []*string `type:"list"`

	// A list of VPC subnet IDs.
	SubnetIds []*string `type:"list"`

	// The ID of the VPC.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

The VPC security groups and subnets that are attached to a Lambda function.

func (AwsLambdaFunctionVpcConfig) GoString

func (s AwsLambdaFunctionVpcConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsLambdaFunctionVpcConfig) SetSecurityGroupIds

func (s *AwsLambdaFunctionVpcConfig) SetSecurityGroupIds(v []*string) *AwsLambdaFunctionVpcConfig

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*AwsLambdaFunctionVpcConfig) SetSubnetIds

SetSubnetIds sets the SubnetIds field's value.

func (*AwsLambdaFunctionVpcConfig) SetVpcId

SetVpcId sets the VpcId field's value.

func (AwsLambdaFunctionVpcConfig) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsLambdaLayerVersionDetails

type AwsLambdaLayerVersionDetails struct {

	// The layer's compatible runtimes. Maximum number of five items.
	//
	// Valid values: nodejs10.x | nodejs12.x | java8 | java11 | python2.7 | python3.6
	// | python3.7 | python3.8 | dotnetcore1.0 | dotnetcore2.1 | go1.x | ruby2.5
	// | provided
	CompatibleRuntimes []*string `type:"list"`

	// Indicates when the version was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreatedDate *string `type:"string"`

	// The version number.
	Version *int64 `type:"long"`
	// contains filtered or unexported fields
}

Details about a Lambda layer version.

func (AwsLambdaLayerVersionDetails) GoString

func (s AwsLambdaLayerVersionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsLambdaLayerVersionDetails) SetCompatibleRuntimes

func (s *AwsLambdaLayerVersionDetails) SetCompatibleRuntimes(v []*string) *AwsLambdaLayerVersionDetails

SetCompatibleRuntimes sets the CompatibleRuntimes field's value.

func (*AwsLambdaLayerVersionDetails) SetCreatedDate

SetCreatedDate sets the CreatedDate field's value.

func (*AwsLambdaLayerVersionDetails) SetVersion

SetVersion sets the Version field's value.

func (AwsLambdaLayerVersionDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsMountPoint added in v1.42.9

type AwsMountPoint struct {

	// The path on the container to mount the host volume at.
	ContainerPath *string `type:"string"`

	// The name of the volume to mount. Must be a volume name referenced in the
	// name parameter of task definition volume.
	SourceVolume *string `type:"string"`
	// contains filtered or unexported fields
}

Details for a volume mount point that's used in a container definition.

func (AwsMountPoint) GoString added in v1.42.9

func (s AwsMountPoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsMountPoint) SetContainerPath added in v1.42.9

func (s *AwsMountPoint) SetContainerPath(v string) *AwsMountPoint

SetContainerPath sets the ContainerPath field's value.

func (*AwsMountPoint) SetSourceVolume added in v1.42.9

func (s *AwsMountPoint) SetSourceVolume(v string) *AwsMountPoint

SetSourceVolume sets the SourceVolume field's value.

func (AwsMountPoint) String added in v1.42.9

func (s AwsMountPoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsNetworkFirewallFirewallDetails added in v1.42.9

type AwsNetworkFirewallFirewallDetails struct {

	// Whether the firewall is protected from deletion. If set to true, then the
	// firewall cannot be deleted.
	DeleteProtection *bool `type:"boolean"`

	// A description of the firewall.
	Description *string `type:"string"`

	// The ARN of the firewall.
	FirewallArn *string `type:"string"`

	// The identifier of the firewall.
	FirewallId *string `type:"string"`

	// A descriptive name of the firewall.
	FirewallName *string `type:"string"`

	// The ARN of the firewall policy.
	FirewallPolicyArn *string `type:"string"`

	// Whether the firewall is protected from a change to the firewall policy. If
	// set to true, you cannot associate a different policy with the firewall.
	FirewallPolicyChangeProtection *bool `type:"boolean"`

	// Whether the firewall is protected from a change to the subnet associations.
	// If set to true, you cannot map different subnets to the firewall.
	SubnetChangeProtection *bool `type:"boolean"`

	// The public subnets that Network Firewall uses for the firewall. Each subnet
	// must belong to a different Availability Zone.
	SubnetMappings []*AwsNetworkFirewallFirewallSubnetMappingsDetails `type:"list"`

	// The identifier of the VPC where the firewall is used.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Details about an Network Firewall firewall.

func (AwsNetworkFirewallFirewallDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsNetworkFirewallFirewallDetails) SetDeleteProtection added in v1.42.9

SetDeleteProtection sets the DeleteProtection field's value.

func (*AwsNetworkFirewallFirewallDetails) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*AwsNetworkFirewallFirewallDetails) SetFirewallArn added in v1.42.9

SetFirewallArn sets the FirewallArn field's value.

func (*AwsNetworkFirewallFirewallDetails) SetFirewallId added in v1.42.9

SetFirewallId sets the FirewallId field's value.

func (*AwsNetworkFirewallFirewallDetails) SetFirewallName added in v1.42.9

SetFirewallName sets the FirewallName field's value.

func (*AwsNetworkFirewallFirewallDetails) SetFirewallPolicyArn added in v1.42.9

SetFirewallPolicyArn sets the FirewallPolicyArn field's value.

func (*AwsNetworkFirewallFirewallDetails) SetFirewallPolicyChangeProtection added in v1.42.9

func (s *AwsNetworkFirewallFirewallDetails) SetFirewallPolicyChangeProtection(v bool) *AwsNetworkFirewallFirewallDetails

SetFirewallPolicyChangeProtection sets the FirewallPolicyChangeProtection field's value.

func (*AwsNetworkFirewallFirewallDetails) SetSubnetChangeProtection added in v1.42.9

SetSubnetChangeProtection sets the SubnetChangeProtection field's value.

func (*AwsNetworkFirewallFirewallDetails) SetSubnetMappings added in v1.42.9

SetSubnetMappings sets the SubnetMappings field's value.

func (*AwsNetworkFirewallFirewallDetails) SetVpcId added in v1.42.9

SetVpcId sets the VpcId field's value.

func (AwsNetworkFirewallFirewallDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsNetworkFirewallFirewallPolicyDetails added in v1.42.9

type AwsNetworkFirewallFirewallPolicyDetails struct {

	// A description of the firewall policy.
	Description *string `type:"string"`

	// The firewall policy configuration.
	FirewallPolicy *FirewallPolicyDetails `type:"structure"`

	// The ARN of the firewall policy.
	FirewallPolicyArn *string `type:"string"`

	// The identifier of the firewall policy.
	FirewallPolicyId *string `type:"string"`

	// The name of the firewall policy.
	FirewallPolicyName *string `type:"string"`
	// contains filtered or unexported fields
}

Details about a firewall policy. A firewall policy defines the behavior of a network firewall.

func (AwsNetworkFirewallFirewallPolicyDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsNetworkFirewallFirewallPolicyDetails) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*AwsNetworkFirewallFirewallPolicyDetails) SetFirewallPolicy added in v1.42.9

SetFirewallPolicy sets the FirewallPolicy field's value.

func (*AwsNetworkFirewallFirewallPolicyDetails) SetFirewallPolicyArn added in v1.42.9

SetFirewallPolicyArn sets the FirewallPolicyArn field's value.

func (*AwsNetworkFirewallFirewallPolicyDetails) SetFirewallPolicyId added in v1.42.9

SetFirewallPolicyId sets the FirewallPolicyId field's value.

func (*AwsNetworkFirewallFirewallPolicyDetails) SetFirewallPolicyName added in v1.42.9

SetFirewallPolicyName sets the FirewallPolicyName field's value.

func (AwsNetworkFirewallFirewallPolicyDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsNetworkFirewallFirewallSubnetMappingsDetails added in v1.42.9

type AwsNetworkFirewallFirewallSubnetMappingsDetails struct {

	// The identifier of the subnet
	SubnetId *string `type:"string"`
	// contains filtered or unexported fields
}

A public subnet that Network Firewall uses for the firewall.

func (AwsNetworkFirewallFirewallSubnetMappingsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsNetworkFirewallFirewallSubnetMappingsDetails) SetSubnetId added in v1.42.9

SetSubnetId sets the SubnetId field's value.

func (AwsNetworkFirewallFirewallSubnetMappingsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsNetworkFirewallRuleGroupDetails added in v1.42.9

type AwsNetworkFirewallRuleGroupDetails struct {

	// The maximum number of operating resources that this rule group can use.
	Capacity *int64 `type:"integer"`

	// A description of the rule group.
	Description *string `type:"string"`

	// Details about the rule group.
	RuleGroup *RuleGroupDetails `type:"structure"`

	// The ARN of the rule group.
	RuleGroupArn *string `type:"string"`

	// The identifier of the rule group.
	RuleGroupId *string `type:"string"`

	// The descriptive name of the rule group.
	RuleGroupName *string `type:"string"`

	// The type of rule group. A rule group can be stateful or stateless.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Details about an Network Firewall rule group. Rule groups are used to inspect and control network traffic. Stateless rule groups apply to individual packets. Stateful rule groups apply to packets in the context of their traffic flow.

Rule groups are referenced in firewall policies.

func (AwsNetworkFirewallRuleGroupDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsNetworkFirewallRuleGroupDetails) SetCapacity added in v1.42.9

SetCapacity sets the Capacity field's value.

func (*AwsNetworkFirewallRuleGroupDetails) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*AwsNetworkFirewallRuleGroupDetails) SetRuleGroup added in v1.42.9

SetRuleGroup sets the RuleGroup field's value.

func (*AwsNetworkFirewallRuleGroupDetails) SetRuleGroupArn added in v1.42.9

SetRuleGroupArn sets the RuleGroupArn field's value.

func (*AwsNetworkFirewallRuleGroupDetails) SetRuleGroupId added in v1.42.9

SetRuleGroupId sets the RuleGroupId field's value.

func (*AwsNetworkFirewallRuleGroupDetails) SetRuleGroupName added in v1.42.9

SetRuleGroupName sets the RuleGroupName field's value.

func (*AwsNetworkFirewallRuleGroupDetails) SetType added in v1.42.9

SetType sets the Type field's value.

func (AwsNetworkFirewallRuleGroupDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails added in v1.42.9

type AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails struct {

	// Enables fine-grained access control.
	Enabled *bool `type:"boolean"`

	// Enables the internal user database.
	InternalUserDatabaseEnabled *bool `type:"boolean"`

	// Specifies information about the master user of the domain.
	MasterUserOptions *AwsOpenSearchServiceDomainMasterUserOptionsDetails `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about domain access control options.

func (AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails) SetEnabled added in v1.42.9

SetEnabled sets the Enabled field's value.

func (*AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails) SetInternalUserDatabaseEnabled added in v1.42.9

SetInternalUserDatabaseEnabled sets the InternalUserDatabaseEnabled field's value.

func (*AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails) SetMasterUserOptions added in v1.42.9

SetMasterUserOptions sets the MasterUserOptions field's value.

func (AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsOpenSearchServiceDomainClusterConfigDetails

type AwsOpenSearchServiceDomainClusterConfigDetails struct {

	// The number of instances to use for the master node. If this attribute is
	// specified, then DedicatedMasterEnabled must be true.
	DedicatedMasterCount *int64 `type:"integer"`

	// Whether to use a dedicated master node for the OpenSearch domain. A dedicated
	// master node performs cluster management tasks, but does not hold data or
	// respond to data upload requests.
	DedicatedMasterEnabled *bool `type:"boolean"`

	// The hardware configuration of the computer that hosts the dedicated master
	// node.
	//
	// If this attribute is specified, then DedicatedMasterEnabled must be true.
	DedicatedMasterType *string `type:"string"`

	// The number of data nodes to use in the OpenSearch domain.
	InstanceCount *int64 `type:"integer"`

	// The instance type for your data nodes.
	//
	// For a list of valid values, see Supported instance types in Amazon OpenSearch
	// Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html)
	// in the Amazon OpenSearch Service Developer Guide.
	InstanceType *string `type:"string"`

	// The number of UltraWarm instances.
	WarmCount *int64 `type:"integer"`

	// Whether UltraWarm is enabled.
	WarmEnabled *bool `type:"boolean"`

	// The type of UltraWarm instance.
	WarmType *string `type:"string"`

	// Configuration options for zone awareness. Provided if ZoneAwarenessEnabled
	// is true.
	ZoneAwarenessConfig *AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails `type:"structure"`

	// Whether to enable zone awareness for the OpenSearch domain. When zone awareness
	// is enabled, OpenSearch Service allocates the cluster's nodes and replica
	// index shards across Availability Zones (AZs) in the same Region. This prevents
	// data loss and minimizes downtime if a node or data center fails.
	ZoneAwarenessEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Details about the configuration of an OpenSearch cluster.

func (AwsOpenSearchServiceDomainClusterConfigDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetDedicatedMasterCount

SetDedicatedMasterCount sets the DedicatedMasterCount field's value.

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetDedicatedMasterEnabled

SetDedicatedMasterEnabled sets the DedicatedMasterEnabled field's value.

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetDedicatedMasterType

SetDedicatedMasterType sets the DedicatedMasterType field's value.

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetInstanceCount

SetInstanceCount sets the InstanceCount field's value.

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetInstanceType

SetInstanceType sets the InstanceType field's value.

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetWarmCount

SetWarmCount sets the WarmCount field's value.

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetWarmEnabled

SetWarmEnabled sets the WarmEnabled field's value.

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetWarmType

SetWarmType sets the WarmType field's value.

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetZoneAwarenessConfig

SetZoneAwarenessConfig sets the ZoneAwarenessConfig field's value.

func (*AwsOpenSearchServiceDomainClusterConfigDetails) SetZoneAwarenessEnabled

SetZoneAwarenessEnabled sets the ZoneAwarenessEnabled field's value.

func (AwsOpenSearchServiceDomainClusterConfigDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails

type AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails struct {

	// The number of Availability Zones that the domain uses. Valid values are 2
	// or 3. The default is 2.
	AvailabilityZoneCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Configuration options for zone awareness.

func (AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails) SetAvailabilityZoneCount

SetAvailabilityZoneCount sets the AvailabilityZoneCount field's value.

func (AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsOpenSearchServiceDomainDetails

type AwsOpenSearchServiceDomainDetails struct {

	// IAM policy document that specifies the access policies for the OpenSearch
	// Service domain.
	AccessPolicies *string `type:"string"`

	// Specifies options for fine-grained access control.
	AdvancedSecurityOptions *AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails `type:"structure"`

	// The ARN of the OpenSearch Service domain.
	Arn *string `type:"string"`

	// Details about the configuration of an OpenSearch cluster.
	ClusterConfig *AwsOpenSearchServiceDomainClusterConfigDetails `type:"structure"`

	// The domain endpoint.
	DomainEndpoint *string `type:"string"`

	// Additional options for the domain endpoint.
	DomainEndpointOptions *AwsOpenSearchServiceDomainDomainEndpointOptionsDetails `type:"structure"`

	// The domain endpoints. Used if the OpenSearch domain resides in a VPC.
	//
	// This is a map of key-value pairs. The key is always vpc. The value is the
	// endpoint.
	DomainEndpoints map[string]*string `type:"map"`

	// The name of the endpoint.
	DomainName *string `type:"string"`

	// Details about the configuration for encryption at rest.
	EncryptionAtRestOptions *AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails `type:"structure"`

	// The version of the domain engine.
	EngineVersion *string `type:"string"`

	// The identifier of the domain.
	Id *string `type:"string"`

	// Configures the CloudWatch Logs to publish for the OpenSearch domain.
	LogPublishingOptions *AwsOpenSearchServiceDomainLogPublishingOptionsDetails `type:"structure"`

	// Details about the configuration for node-to-node encryption.
	NodeToNodeEncryptionOptions *AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails `type:"structure"`

	// Information about the status of a domain relative to the latest service software.
	ServiceSoftwareOptions *AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails `type:"structure"`

	// Information that OpenSearch Service derives based on VPCOptions for the domain.
	VpcOptions *AwsOpenSearchServiceDomainVpcOptionsDetails `type:"structure"`
	// contains filtered or unexported fields
}

Information about an Amazon OpenSearch Service domain.

func (AwsOpenSearchServiceDomainDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsOpenSearchServiceDomainDetails) SetAccessPolicies

SetAccessPolicies sets the AccessPolicies field's value.

func (*AwsOpenSearchServiceDomainDetails) SetAdvancedSecurityOptions added in v1.42.9

SetAdvancedSecurityOptions sets the AdvancedSecurityOptions field's value.

func (*AwsOpenSearchServiceDomainDetails) SetArn

SetArn sets the Arn field's value.

func (*AwsOpenSearchServiceDomainDetails) SetClusterConfig

SetClusterConfig sets the ClusterConfig field's value.

func (*AwsOpenSearchServiceDomainDetails) SetDomainEndpoint

SetDomainEndpoint sets the DomainEndpoint field's value.

func (*AwsOpenSearchServiceDomainDetails) SetDomainEndpointOptions

SetDomainEndpointOptions sets the DomainEndpointOptions field's value.

func (*AwsOpenSearchServiceDomainDetails) SetDomainEndpoints

SetDomainEndpoints sets the DomainEndpoints field's value.

func (*AwsOpenSearchServiceDomainDetails) SetDomainName

SetDomainName sets the DomainName field's value.

func (*AwsOpenSearchServiceDomainDetails) SetEncryptionAtRestOptions

SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.

func (*AwsOpenSearchServiceDomainDetails) SetEngineVersion

SetEngineVersion sets the EngineVersion field's value.

func (*AwsOpenSearchServiceDomainDetails) SetId

SetId sets the Id field's value.

func (*AwsOpenSearchServiceDomainDetails) SetLogPublishingOptions

SetLogPublishingOptions sets the LogPublishingOptions field's value.

func (*AwsOpenSearchServiceDomainDetails) SetNodeToNodeEncryptionOptions

SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.

func (*AwsOpenSearchServiceDomainDetails) SetServiceSoftwareOptions

SetServiceSoftwareOptions sets the ServiceSoftwareOptions field's value.

func (*AwsOpenSearchServiceDomainDetails) SetVpcOptions

SetVpcOptions sets the VpcOptions field's value.

func (AwsOpenSearchServiceDomainDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsOpenSearchServiceDomainDomainEndpointOptionsDetails

type AwsOpenSearchServiceDomainDomainEndpointOptionsDetails struct {

	// The fully qualified URL for the custom endpoint.
	CustomEndpoint *string `type:"string"`

	// The ARN for the security certificate. The certificate is managed in ACM.
	CustomEndpointCertificateArn *string `type:"string"`

	// Whether to enable a custom endpoint for the domain.
	CustomEndpointEnabled *bool `type:"boolean"`

	// Whether to require that all traffic to the domain arrive over HTTPS.
	EnforceHTTPS *bool `type:"boolean"`

	// The TLS security policy to apply to the HTTPS endpoint of the OpenSearch
	// domain.
	TLSSecurityPolicy *string `type:"string"`
	// contains filtered or unexported fields
}

Information about additional options for the domain endpoint.

func (AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) SetCustomEndpoint

SetCustomEndpoint sets the CustomEndpoint field's value.

func (*AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) SetCustomEndpointCertificateArn

SetCustomEndpointCertificateArn sets the CustomEndpointCertificateArn field's value.

func (*AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) SetCustomEndpointEnabled

SetCustomEndpointEnabled sets the CustomEndpointEnabled field's value.

func (*AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) SetEnforceHTTPS

SetEnforceHTTPS sets the EnforceHTTPS field's value.

func (*AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) SetTLSSecurityPolicy

SetTLSSecurityPolicy sets the TLSSecurityPolicy field's value.

func (AwsOpenSearchServiceDomainDomainEndpointOptionsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails

type AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails struct {

	// Whether encryption at rest is enabled.
	Enabled *bool `type:"boolean"`

	// The KMS key ID.
	KmsKeyId *string `type:"string"`
	// contains filtered or unexported fields
}

Details about the configuration for encryption at rest for the OpenSearch domain.

func (AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails) SetEnabled

SetEnabled sets the Enabled field's value.

func (*AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails) SetKmsKeyId

SetKmsKeyId sets the KmsKeyId field's value.

func (AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsOpenSearchServiceDomainLogPublishingOption

type AwsOpenSearchServiceDomainLogPublishingOption struct {

	// The ARN of the CloudWatch Logs group to publish the logs to.
	CloudWatchLogsLogGroupArn *string `type:"string"`

	// Whether the log publishing is enabled.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Configuration details for a log publishing option.

func (AwsOpenSearchServiceDomainLogPublishingOption) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsOpenSearchServiceDomainLogPublishingOption) SetCloudWatchLogsLogGroupArn

SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value.

func (*AwsOpenSearchServiceDomainLogPublishingOption) SetEnabled

SetEnabled sets the Enabled field's value.

func (AwsOpenSearchServiceDomainLogPublishingOption) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsOpenSearchServiceDomainLogPublishingOptionsDetails

type AwsOpenSearchServiceDomainLogPublishingOptionsDetails struct {

	// Configures the OpenSearch audit logs publishing.
	AuditLogs *AwsOpenSearchServiceDomainLogPublishingOption `type:"structure"`

	// Configures the OpenSearch index logs publishing.
	IndexSlowLogs *AwsOpenSearchServiceDomainLogPublishingOption `type:"structure"`

	// Configures the OpenSearch search slow log publishing.
	SearchSlowLogs *AwsOpenSearchServiceDomainLogPublishingOption `type:"structure"`
	// contains filtered or unexported fields
}

Configures the CloudWatch Logs to publish for the OpenSearch domain.

func (AwsOpenSearchServiceDomainLogPublishingOptionsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsOpenSearchServiceDomainLogPublishingOptionsDetails) SetAuditLogs

SetAuditLogs sets the AuditLogs field's value.

func (*AwsOpenSearchServiceDomainLogPublishingOptionsDetails) SetIndexSlowLogs

SetIndexSlowLogs sets the IndexSlowLogs field's value.

func (*AwsOpenSearchServiceDomainLogPublishingOptionsDetails) SetSearchSlowLogs

SetSearchSlowLogs sets the SearchSlowLogs field's value.

func (AwsOpenSearchServiceDomainLogPublishingOptionsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsOpenSearchServiceDomainMasterUserOptionsDetails added in v1.42.9

type AwsOpenSearchServiceDomainMasterUserOptionsDetails struct {

	// The Amazon Resource Name (ARN) for the master user.
	MasterUserArn *string `type:"string"`

	// The username for the master user.
	MasterUserName *string `type:"string"`

	// The password for the master user.
	MasterUserPassword *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies information about the master user of the domain.

func (AwsOpenSearchServiceDomainMasterUserOptionsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsOpenSearchServiceDomainMasterUserOptionsDetails) SetMasterUserArn added in v1.42.9

SetMasterUserArn sets the MasterUserArn field's value.

func (*AwsOpenSearchServiceDomainMasterUserOptionsDetails) SetMasterUserName added in v1.42.9

SetMasterUserName sets the MasterUserName field's value.

func (*AwsOpenSearchServiceDomainMasterUserOptionsDetails) SetMasterUserPassword added in v1.42.9

SetMasterUserPassword sets the MasterUserPassword field's value.

func (AwsOpenSearchServiceDomainMasterUserOptionsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails

type AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails struct {

	// Whether node-to-node encryption is enabled.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Provides details about the configuration for node-to-node encryption.

func (AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails) SetEnabled

SetEnabled sets the Enabled field's value.

func (AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails

type AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails struct {

	// The epoch time when the deployment window closes for required updates. After
	// this time, OpenSearch Service schedules the software upgrade automatically.
	AutomatedUpdateDate *string `type:"string"`

	// Whether a request to update the domain can be canceled.
	Cancellable *bool `type:"boolean"`

	// The version of the service software that is currently installed on the domain.
	CurrentVersion *string `type:"string"`

	// A more detailed description of the service software status.
	Description *string `type:"string"`

	// The most recent version of the service software.
	NewVersion *string `type:"string"`

	// Whether the service software update is optional.
	OptionalDeployment *bool `type:"boolean"`

	// Whether a service software update is available for the domain.
	UpdateAvailable *bool `type:"boolean"`

	// The status of the service software update. Valid values are as follows:
	//
	//    * COMPLETED
	//
	//    * ELIGIBLE
	//
	//    * IN_PROGRESS
	//
	//    * NOT_ELIGIBLE
	//
	//    * PENDING_UPDATE
	UpdateStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the state of the domain relative to the latest service software.

func (AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetAutomatedUpdateDate

SetAutomatedUpdateDate sets the AutomatedUpdateDate field's value.

func (*AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetCancellable

SetCancellable sets the Cancellable field's value.

func (*AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetCurrentVersion

SetCurrentVersion sets the CurrentVersion field's value.

func (*AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetDescription

SetDescription sets the Description field's value.

func (*AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetNewVersion

SetNewVersion sets the NewVersion field's value.

func (*AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetOptionalDeployment

SetOptionalDeployment sets the OptionalDeployment field's value.

func (*AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetUpdateAvailable

SetUpdateAvailable sets the UpdateAvailable field's value.

func (*AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) SetUpdateStatus

SetUpdateStatus sets the UpdateStatus field's value.

func (AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsOpenSearchServiceDomainVpcOptionsDetails

type AwsOpenSearchServiceDomainVpcOptionsDetails struct {

	// The list of security group IDs that are associated with the VPC endpoints
	// for the domain.
	SecurityGroupIds []*string `type:"list"`

	// A list of subnet IDs that are associated with the VPC endpoints for the domain.
	SubnetIds []*string `type:"list"`
	// contains filtered or unexported fields
}

Contains information that OpenSearch Service derives based on the VPCOptions for the domain.

func (AwsOpenSearchServiceDomainVpcOptionsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsOpenSearchServiceDomainVpcOptionsDetails) SetSecurityGroupIds

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*AwsOpenSearchServiceDomainVpcOptionsDetails) SetSubnetIds

SetSubnetIds sets the SubnetIds field's value.

func (AwsOpenSearchServiceDomainVpcOptionsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbClusterAssociatedRole

type AwsRdsDbClusterAssociatedRole struct {

	// The ARN of the IAM role.
	RoleArn *string `type:"string"`

	// The status of the association between the IAM role and the DB cluster. Valid
	// values are as follows:
	//
	//    * ACTIVE
	//
	//    * INVALID
	//
	//    * PENDING
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

An IAM role that is associated with the Amazon RDS DB cluster.

func (AwsRdsDbClusterAssociatedRole) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbClusterAssociatedRole) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*AwsRdsDbClusterAssociatedRole) SetStatus

SetStatus sets the Status field's value.

func (AwsRdsDbClusterAssociatedRole) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbClusterDetails

type AwsRdsDbClusterDetails struct {

	// The status of the database activity stream. Valid values are as follows:
	//
	//    * started
	//
	//    * starting
	//
	//    * stopped
	//
	//    * stopping
	ActivityStreamStatus *string `type:"string"`

	// For all database engines except Aurora, specifies the allocated storage size
	// in gibibytes (GiB).
	AllocatedStorage *int64 `type:"integer"`

	// A list of the IAM roles that are associated with the DB cluster.
	AssociatedRoles []*AwsRdsDbClusterAssociatedRole `type:"list"`

	// A list of Availability Zones (AZs) where instances in the DB cluster can
	// be created.
	AvailabilityZones []*string `type:"list"`

	// The number of days for which automated backups are retained.
	BackupRetentionPeriod *int64 `type:"integer"`

	// Indicates when the DB cluster was created, in Universal Coordinated Time
	// (UTC).
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	ClusterCreateTime *string `type:"string"`

	// Whether tags are copied from the DB cluster to snapshots of the DB cluster.
	CopyTagsToSnapshot *bool `type:"boolean"`

	// Whether the DB cluster is a clone of a DB cluster owned by a different Amazon
	// Web Services account.
	CrossAccountClone *bool `type:"boolean"`

	// A list of custom endpoints for the DB cluster.
	CustomEndpoints []*string `type:"list"`

	// The name of the database.
	DatabaseName *string `type:"string"`

	// The DB cluster identifier that the user assigned to the cluster. This identifier
	// is the unique key that identifies a DB cluster.
	DbClusterIdentifier *string `type:"string"`

	// The list of instances that make up the DB cluster.
	DbClusterMembers []*AwsRdsDbClusterMember `type:"list"`

	// The list of option group memberships for this DB cluster.
	DbClusterOptionGroupMemberships []*AwsRdsDbClusterOptionGroupMembership `type:"list"`

	// The name of the DB cluster parameter group for the DB cluster.
	DbClusterParameterGroup *string `type:"string"`

	// The identifier of the DB cluster. The identifier must be unique within each
	// Amazon Web Services Region and is immutable.
	DbClusterResourceId *string `type:"string"`

	// The subnet group that is associated with the DB cluster, including the name,
	// description, and subnets in the subnet group.
	DbSubnetGroup *string `type:"string"`

	// Whether the DB cluster has deletion protection enabled.
	DeletionProtection *bool `type:"boolean"`

	// The Active Directory domain membership records that are associated with the
	// DB cluster.
	DomainMemberships []*AwsRdsDbDomainMembership `type:"list"`

	// A list of log types that this DB cluster is configured to export to CloudWatch
	// Logs.
	EnabledCloudWatchLogsExports []*string `type:"list"`

	// The connection endpoint for the primary instance of the DB cluster.
	Endpoint *string `type:"string"`

	// The name of the database engine to use for this DB cluster. Valid values
	// are as follows:
	//
	//    * aurora
	//
	//    * aurora-mysql
	//
	//    * aurora-postgresql
	Engine *string `type:"string"`

	// The database engine mode of the DB cluster.Valid values are as follows:
	//
	//    * global
	//
	//    * multimaster
	//
	//    * parallelquery
	//
	//    * provisioned
	//
	//    * serverless
	EngineMode *string `type:"string"`

	// The version number of the database engine to use.
	EngineVersion *string `type:"string"`

	// Specifies the identifier that Amazon Route 53 assigns when you create a hosted
	// zone.
	HostedZoneId *string `type:"string"`

	// Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
	HttpEndpointEnabled *bool `type:"boolean"`

	// Whether the mapping of IAM accounts to database accounts is enabled.
	IamDatabaseAuthenticationEnabled *bool `type:"boolean"`

	// The ARN of the KMS master key that is used to encrypt the database instances
	// in the DB cluster.
	KmsKeyId *string `type:"string"`

	// The name of the master user for the DB cluster.
	MasterUsername *string `type:"string"`

	// Whether the DB cluster has instances in multiple Availability Zones.
	MultiAz *bool `type:"boolean"`

	// The port number on which the DB instances in the DB cluster accept connections.
	Port *int64 `type:"integer"`

	// The range of time each day when automated backups are created, if automated
	// backups are enabled.
	//
	// Uses the format HH:MM-HH:MM. For example, 04:52-05:22.
	PreferredBackupWindow *string `type:"string"`

	// The weekly time range during which system maintenance can occur, in Universal
	// Coordinated Time (UTC).
	//
	// Uses the format <day>:HH:MM-<day>:HH:MM.
	//
	// For the day values, use mon|tue|wed|thu|fri|sat|sun.
	//
	// For example, sun:09:32-sun:10:02.
	PreferredMaintenanceWindow *string `type:"string"`

	// The identifiers of the read replicas that are associated with this DB cluster.
	ReadReplicaIdentifiers []*string `type:"list"`

	// The reader endpoint for the DB cluster.
	ReaderEndpoint *string `type:"string"`

	// The current status of this DB cluster.
	Status *string `type:"string"`

	// Whether the DB cluster is encrypted.
	StorageEncrypted *bool `type:"boolean"`

	// A list of VPC security groups that the DB cluster belongs to.
	VpcSecurityGroups []*AwsRdsDbInstanceVpcSecurityGroup `type:"list"`
	// contains filtered or unexported fields
}

Information about an Amazon RDS DB cluster.

func (AwsRdsDbClusterDetails) GoString

func (s AwsRdsDbClusterDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbClusterDetails) SetActivityStreamStatus

func (s *AwsRdsDbClusterDetails) SetActivityStreamStatus(v string) *AwsRdsDbClusterDetails

SetActivityStreamStatus sets the ActivityStreamStatus field's value.

func (*AwsRdsDbClusterDetails) SetAllocatedStorage

func (s *AwsRdsDbClusterDetails) SetAllocatedStorage(v int64) *AwsRdsDbClusterDetails

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*AwsRdsDbClusterDetails) SetAssociatedRoles

SetAssociatedRoles sets the AssociatedRoles field's value.

func (*AwsRdsDbClusterDetails) SetAvailabilityZones

func (s *AwsRdsDbClusterDetails) SetAvailabilityZones(v []*string) *AwsRdsDbClusterDetails

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*AwsRdsDbClusterDetails) SetBackupRetentionPeriod

func (s *AwsRdsDbClusterDetails) SetBackupRetentionPeriod(v int64) *AwsRdsDbClusterDetails

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*AwsRdsDbClusterDetails) SetClusterCreateTime

func (s *AwsRdsDbClusterDetails) SetClusterCreateTime(v string) *AwsRdsDbClusterDetails

SetClusterCreateTime sets the ClusterCreateTime field's value.

func (*AwsRdsDbClusterDetails) SetCopyTagsToSnapshot

func (s *AwsRdsDbClusterDetails) SetCopyTagsToSnapshot(v bool) *AwsRdsDbClusterDetails

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*AwsRdsDbClusterDetails) SetCrossAccountClone

func (s *AwsRdsDbClusterDetails) SetCrossAccountClone(v bool) *AwsRdsDbClusterDetails

SetCrossAccountClone sets the CrossAccountClone field's value.

func (*AwsRdsDbClusterDetails) SetCustomEndpoints

func (s *AwsRdsDbClusterDetails) SetCustomEndpoints(v []*string) *AwsRdsDbClusterDetails

SetCustomEndpoints sets the CustomEndpoints field's value.

func (*AwsRdsDbClusterDetails) SetDatabaseName

func (s *AwsRdsDbClusterDetails) SetDatabaseName(v string) *AwsRdsDbClusterDetails

SetDatabaseName sets the DatabaseName field's value.

func (*AwsRdsDbClusterDetails) SetDbClusterIdentifier

func (s *AwsRdsDbClusterDetails) SetDbClusterIdentifier(v string) *AwsRdsDbClusterDetails

SetDbClusterIdentifier sets the DbClusterIdentifier field's value.

func (*AwsRdsDbClusterDetails) SetDbClusterMembers

SetDbClusterMembers sets the DbClusterMembers field's value.

func (*AwsRdsDbClusterDetails) SetDbClusterOptionGroupMemberships

func (s *AwsRdsDbClusterDetails) SetDbClusterOptionGroupMemberships(v []*AwsRdsDbClusterOptionGroupMembership) *AwsRdsDbClusterDetails

SetDbClusterOptionGroupMemberships sets the DbClusterOptionGroupMemberships field's value.

func (*AwsRdsDbClusterDetails) SetDbClusterParameterGroup

func (s *AwsRdsDbClusterDetails) SetDbClusterParameterGroup(v string) *AwsRdsDbClusterDetails

SetDbClusterParameterGroup sets the DbClusterParameterGroup field's value.

func (*AwsRdsDbClusterDetails) SetDbClusterResourceId

func (s *AwsRdsDbClusterDetails) SetDbClusterResourceId(v string) *AwsRdsDbClusterDetails

SetDbClusterResourceId sets the DbClusterResourceId field's value.

func (*AwsRdsDbClusterDetails) SetDbSubnetGroup

func (s *AwsRdsDbClusterDetails) SetDbSubnetGroup(v string) *AwsRdsDbClusterDetails

SetDbSubnetGroup sets the DbSubnetGroup field's value.

func (*AwsRdsDbClusterDetails) SetDeletionProtection

func (s *AwsRdsDbClusterDetails) SetDeletionProtection(v bool) *AwsRdsDbClusterDetails

SetDeletionProtection sets the DeletionProtection field's value.

func (*AwsRdsDbClusterDetails) SetDomainMemberships

SetDomainMemberships sets the DomainMemberships field's value.

func (*AwsRdsDbClusterDetails) SetEnabledCloudWatchLogsExports

func (s *AwsRdsDbClusterDetails) SetEnabledCloudWatchLogsExports(v []*string) *AwsRdsDbClusterDetails

SetEnabledCloudWatchLogsExports sets the EnabledCloudWatchLogsExports field's value.

func (*AwsRdsDbClusterDetails) SetEndpoint

SetEndpoint sets the Endpoint field's value.

func (*AwsRdsDbClusterDetails) SetEngine

SetEngine sets the Engine field's value.

func (*AwsRdsDbClusterDetails) SetEngineMode

SetEngineMode sets the EngineMode field's value.

func (*AwsRdsDbClusterDetails) SetEngineVersion

func (s *AwsRdsDbClusterDetails) SetEngineVersion(v string) *AwsRdsDbClusterDetails

SetEngineVersion sets the EngineVersion field's value.

func (*AwsRdsDbClusterDetails) SetHostedZoneId

func (s *AwsRdsDbClusterDetails) SetHostedZoneId(v string) *AwsRdsDbClusterDetails

SetHostedZoneId sets the HostedZoneId field's value.

func (*AwsRdsDbClusterDetails) SetHttpEndpointEnabled

func (s *AwsRdsDbClusterDetails) SetHttpEndpointEnabled(v bool) *AwsRdsDbClusterDetails

SetHttpEndpointEnabled sets the HttpEndpointEnabled field's value.

func (*AwsRdsDbClusterDetails) SetIamDatabaseAuthenticationEnabled

func (s *AwsRdsDbClusterDetails) SetIamDatabaseAuthenticationEnabled(v bool) *AwsRdsDbClusterDetails

SetIamDatabaseAuthenticationEnabled sets the IamDatabaseAuthenticationEnabled field's value.

func (*AwsRdsDbClusterDetails) SetKmsKeyId

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsRdsDbClusterDetails) SetMasterUsername

func (s *AwsRdsDbClusterDetails) SetMasterUsername(v string) *AwsRdsDbClusterDetails

SetMasterUsername sets the MasterUsername field's value.

func (*AwsRdsDbClusterDetails) SetMultiAz

SetMultiAz sets the MultiAz field's value.

func (*AwsRdsDbClusterDetails) SetPort

SetPort sets the Port field's value.

func (*AwsRdsDbClusterDetails) SetPreferredBackupWindow

func (s *AwsRdsDbClusterDetails) SetPreferredBackupWindow(v string) *AwsRdsDbClusterDetails

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*AwsRdsDbClusterDetails) SetPreferredMaintenanceWindow

func (s *AwsRdsDbClusterDetails) SetPreferredMaintenanceWindow(v string) *AwsRdsDbClusterDetails

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*AwsRdsDbClusterDetails) SetReadReplicaIdentifiers

func (s *AwsRdsDbClusterDetails) SetReadReplicaIdentifiers(v []*string) *AwsRdsDbClusterDetails

SetReadReplicaIdentifiers sets the ReadReplicaIdentifiers field's value.

func (*AwsRdsDbClusterDetails) SetReaderEndpoint

func (s *AwsRdsDbClusterDetails) SetReaderEndpoint(v string) *AwsRdsDbClusterDetails

SetReaderEndpoint sets the ReaderEndpoint field's value.

func (*AwsRdsDbClusterDetails) SetStatus

SetStatus sets the Status field's value.

func (*AwsRdsDbClusterDetails) SetStorageEncrypted

func (s *AwsRdsDbClusterDetails) SetStorageEncrypted(v bool) *AwsRdsDbClusterDetails

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*AwsRdsDbClusterDetails) SetVpcSecurityGroups

SetVpcSecurityGroups sets the VpcSecurityGroups field's value.

func (AwsRdsDbClusterDetails) String

func (s AwsRdsDbClusterDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbClusterMember

type AwsRdsDbClusterMember struct {

	// The status of the DB cluster parameter group for this member of the DB cluster.
	DbClusterParameterGroupStatus *string `type:"string"`

	// The instance identifier for this member of the DB cluster.
	DbInstanceIdentifier *string `type:"string"`

	// Whether the cluster member is the primary instance for the DB cluster.
	IsClusterWriter *bool `type:"boolean"`

	// Specifies the order in which an Aurora replica is promoted to the primary
	// instance when the existing primary instance fails.
	PromotionTier *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Information about an instance in the DB cluster.

func (AwsRdsDbClusterMember) GoString

func (s AwsRdsDbClusterMember) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbClusterMember) SetDbClusterParameterGroupStatus

func (s *AwsRdsDbClusterMember) SetDbClusterParameterGroupStatus(v string) *AwsRdsDbClusterMember

SetDbClusterParameterGroupStatus sets the DbClusterParameterGroupStatus field's value.

func (*AwsRdsDbClusterMember) SetDbInstanceIdentifier

func (s *AwsRdsDbClusterMember) SetDbInstanceIdentifier(v string) *AwsRdsDbClusterMember

SetDbInstanceIdentifier sets the DbInstanceIdentifier field's value.

func (*AwsRdsDbClusterMember) SetIsClusterWriter

func (s *AwsRdsDbClusterMember) SetIsClusterWriter(v bool) *AwsRdsDbClusterMember

SetIsClusterWriter sets the IsClusterWriter field's value.

func (*AwsRdsDbClusterMember) SetPromotionTier

func (s *AwsRdsDbClusterMember) SetPromotionTier(v int64) *AwsRdsDbClusterMember

SetPromotionTier sets the PromotionTier field's value.

func (AwsRdsDbClusterMember) String

func (s AwsRdsDbClusterMember) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbClusterOptionGroupMembership

type AwsRdsDbClusterOptionGroupMembership struct {

	// The name of the DB cluster option group.
	DbClusterOptionGroupName *string `type:"string"`

	// The status of the DB cluster option group.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Information about an option group membership for a DB cluster.

func (AwsRdsDbClusterOptionGroupMembership) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbClusterOptionGroupMembership) SetDbClusterOptionGroupName

SetDbClusterOptionGroupName sets the DbClusterOptionGroupName field's value.

func (*AwsRdsDbClusterOptionGroupMembership) SetStatus

SetStatus sets the Status field's value.

func (AwsRdsDbClusterOptionGroupMembership) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute added in v1.42.9

type AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute struct {

	// The name of the manual DB cluster snapshot attribute. The attribute named
	// restore refers to the list of Amazon Web Services accounts that have permission
	// to copy or restore the manual DB cluster snapshot.
	AttributeName *string `type:"string"`

	// The value(s) for the manual DB cluster snapshot attribute. If the AttributeName
	// field is set to restore, then this element returns a list of IDs of the Amazon
	// Web Services accounts that are authorized to copy or restore the manual DB
	// cluster snapshot. If a value of all is in the list, then the manual DB cluster
	// snapshot is public and available for any Amazon Web Services account to copy
	// or restore.
	AttributeValues []*string `type:"list"`
	// contains filtered or unexported fields
}

Contains the name and values of a manual Amazon Relational Database Service (RDS) DB cluster snapshot attribute.

func (AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute) SetAttributeName added in v1.42.9

SetAttributeName sets the AttributeName field's value.

func (*AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute) SetAttributeValues added in v1.42.9

SetAttributeValues sets the AttributeValues field's value.

func (AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbClusterSnapshotDetails

type AwsRdsDbClusterSnapshotDetails struct {

	// Specifies the allocated storage size in gibibytes (GiB).
	AllocatedStorage *int64 `type:"integer"`

	// A list of Availability Zones where instances in the DB cluster can be created.
	AvailabilityZones []*string `type:"list"`

	// Indicates when the DB cluster was created, in Universal Coordinated Time
	// (UTC).
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	ClusterCreateTime *string `type:"string"`

	// The DB cluster identifier.
	DbClusterIdentifier *string `type:"string"`

	// Contains the name and values of a manual DB cluster snapshot attribute.
	DbClusterSnapshotAttributes []*AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute `type:"list"`

	// The identifier of the DB cluster snapshot.
	DbClusterSnapshotIdentifier *string `type:"string"`

	// The name of the database engine that you want to use for this DB instance.
	Engine *string `type:"string"`

	// The version of the database engine to use.
	EngineVersion *string `type:"string"`

	// Whether mapping of IAM accounts to database accounts is enabled.
	IamDatabaseAuthenticationEnabled *bool `type:"boolean"`

	// The ARN of the KMS master key that is used to encrypt the database instances
	// in the DB cluster.
	KmsKeyId *string `type:"string"`

	// The license model information for this DB cluster snapshot.
	LicenseModel *string `type:"string"`

	// The name of the master user for the DB cluster.
	MasterUsername *string `type:"string"`

	// Specifies the percentage of the estimated data that has been transferred.
	PercentProgress *int64 `type:"integer"`

	// The port number on which the DB instances in the DB cluster accept connections.
	Port *int64 `type:"integer"`

	// Indicates when the snapshot was taken.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	SnapshotCreateTime *string `type:"string"`

	// The type of DB cluster snapshot.
	SnapshotType *string `type:"string"`

	// The status of this DB cluster snapshot.
	Status *string `type:"string"`

	// Whether the DB cluster is encrypted.
	StorageEncrypted *bool `type:"boolean"`

	// The VPC ID that is associated with the DB cluster snapshot.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Information about an Amazon RDS DB cluster snapshot.

func (AwsRdsDbClusterSnapshotDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbClusterSnapshotDetails) SetAllocatedStorage

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetAvailabilityZones

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetClusterCreateTime

SetClusterCreateTime sets the ClusterCreateTime field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetDbClusterIdentifier

SetDbClusterIdentifier sets the DbClusterIdentifier field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetDbClusterSnapshotAttributes added in v1.42.9

SetDbClusterSnapshotAttributes sets the DbClusterSnapshotAttributes field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetDbClusterSnapshotIdentifier

func (s *AwsRdsDbClusterSnapshotDetails) SetDbClusterSnapshotIdentifier(v string) *AwsRdsDbClusterSnapshotDetails

SetDbClusterSnapshotIdentifier sets the DbClusterSnapshotIdentifier field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetEngine

SetEngine sets the Engine field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetEngineVersion

SetEngineVersion sets the EngineVersion field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetIamDatabaseAuthenticationEnabled

func (s *AwsRdsDbClusterSnapshotDetails) SetIamDatabaseAuthenticationEnabled(v bool) *AwsRdsDbClusterSnapshotDetails

SetIamDatabaseAuthenticationEnabled sets the IamDatabaseAuthenticationEnabled field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetKmsKeyId

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetLicenseModel

SetLicenseModel sets the LicenseModel field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetMasterUsername

SetMasterUsername sets the MasterUsername field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetPercentProgress

SetPercentProgress sets the PercentProgress field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetPort

SetPort sets the Port field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetSnapshotCreateTime

SetSnapshotCreateTime sets the SnapshotCreateTime field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetSnapshotType

SetSnapshotType sets the SnapshotType field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetStatus

SetStatus sets the Status field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetStorageEncrypted

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*AwsRdsDbClusterSnapshotDetails) SetVpcId

SetVpcId sets the VpcId field's value.

func (AwsRdsDbClusterSnapshotDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbDomainMembership

type AwsRdsDbDomainMembership struct {

	// The identifier of the Active Directory domain.
	Domain *string `type:"string"`

	// The fully qualified domain name of the Active Directory domain.
	Fqdn *string `type:"string"`

	// The name of the IAM role to use when making API calls to the Directory Service.
	IamRoleName *string `type:"string"`

	// The status of the Active Directory Domain membership for the DB instance.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Information about an Active Directory domain membership record associated with the DB instance.

func (AwsRdsDbDomainMembership) GoString

func (s AwsRdsDbDomainMembership) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbDomainMembership) SetDomain

SetDomain sets the Domain field's value.

func (*AwsRdsDbDomainMembership) SetFqdn

SetFqdn sets the Fqdn field's value.

func (*AwsRdsDbDomainMembership) SetIamRoleName

SetIamRoleName sets the IamRoleName field's value.

func (*AwsRdsDbDomainMembership) SetStatus

SetStatus sets the Status field's value.

func (AwsRdsDbDomainMembership) String

func (s AwsRdsDbDomainMembership) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbInstanceAssociatedRole

type AwsRdsDbInstanceAssociatedRole struct {

	// The name of the feature associated with the IAM role.
	FeatureName *string `type:"string"`

	// The ARN of the IAM role that is associated with the DB instance.
	RoleArn *string `type:"string"`

	// Describes the state of the association between the IAM role and the DB instance.
	// The Status property returns one of the following values:
	//
	//    * ACTIVE - The IAM role ARN is associated with the DB instance and can
	//    be used to access other Amazon Web Services services on your behalf.
	//
	//    * PENDING - The IAM role ARN is being associated with the DB instance.
	//
	//    * INVALID - The IAM role ARN is associated with the DB instance. But the
	//    DB instance is unable to assume the IAM role in order to access other
	//    Amazon Web Services services on your behalf.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

An IAM role associated with the DB instance.

func (AwsRdsDbInstanceAssociatedRole) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbInstanceAssociatedRole) SetFeatureName

SetFeatureName sets the FeatureName field's value.

func (*AwsRdsDbInstanceAssociatedRole) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*AwsRdsDbInstanceAssociatedRole) SetStatus

SetStatus sets the Status field's value.

func (AwsRdsDbInstanceAssociatedRole) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbInstanceDetails

type AwsRdsDbInstanceDetails struct {

	// The amount of storage (in gigabytes) to initially allocate for the DB instance.
	AllocatedStorage *int64 `type:"integer"`

	// The IAM roles associated with the DB instance.
	AssociatedRoles []*AwsRdsDbInstanceAssociatedRole `type:"list"`

	// Indicates whether minor version patches are applied automatically.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// The Availability Zone where the DB instance will be created.
	AvailabilityZone *string `type:"string"`

	// The number of days for which to retain automated backups.
	BackupRetentionPeriod *int64 `type:"integer"`

	// The identifier of the CA certificate for this DB instance.
	CACertificateIdentifier *string `type:"string"`

	// The name of the character set that this DB instance is associated with.
	CharacterSetName *string `type:"string"`

	// Whether to copy resource tags to snapshots of the DB instance.
	CopyTagsToSnapshot *bool `type:"boolean"`

	// If the DB instance is a member of a DB cluster, contains the name of the
	// DB cluster that the DB instance is a member of.
	DBClusterIdentifier *string `type:"string"`

	// Contains the name of the compute and memory capacity class of the DB instance.
	DBInstanceClass *string `type:"string"`

	// Contains a user-supplied database identifier. This identifier is the unique
	// key that identifies a DB instance.
	DBInstanceIdentifier *string `type:"string"`

	// The meaning of this parameter differs according to the database engine you
	// use.
	//
	// MySQL, MariaDB, SQL Server, PostgreSQL
	//
	// Contains the name of the initial database of this instance that was provided
	// at create time, if one was specified when the DB instance was created. This
	// same name is returned for the life of the DB instance.
	//
	// Oracle
	//
	// Contains the Oracle System ID (SID) of the created DB instance. Not shown
	// when the returned parameters do not apply to an Oracle DB instance.
	DBName *string `type:"string"`

	// Specifies the port that the DB instance listens on. If the DB instance is
	// part of a DB cluster, this can be a different port than the DB cluster port.
	DbInstancePort *int64 `type:"integer"`

	// The current status of the DB instance.
	DbInstanceStatus *string `type:"string"`

	// A list of the DB parameter groups to assign to the DB instance.
	DbParameterGroups []*AwsRdsDbParameterGroup `type:"list"`

	// A list of the DB security groups to assign to the DB instance.
	DbSecurityGroups []*string `type:"list"`

	// Information about the subnet group that is associated with the DB instance.
	DbSubnetGroup *AwsRdsDbSubnetGroup `type:"structure"`

	// The Amazon Web Services Region-unique, immutable identifier for the DB instance.
	// This identifier is found in CloudTrail log entries whenever the KMS key for
	// the DB instance is accessed.
	DbiResourceId *string `type:"string"`

	// Indicates whether the DB instance has deletion protection enabled.
	//
	// When deletion protection is enabled, the database cannot be deleted.
	DeletionProtection *bool `type:"boolean"`

	// The Active Directory domain membership records associated with the DB instance.
	DomainMemberships []*AwsRdsDbDomainMembership `type:"list"`

	// A list of log types that this DB instance is configured to export to CloudWatch
	// Logs.
	EnabledCloudWatchLogsExports []*string `type:"list"`

	// Specifies the connection endpoint.
	Endpoint *AwsRdsDbInstanceEndpoint `type:"structure"`

	// Provides the name of the database engine to use for this DB instance.
	Engine *string `type:"string"`

	// Indicates the database engine version.
	EngineVersion *string `type:"string"`

	// The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring
	// metrics data for the DB instance.
	EnhancedMonitoringResourceArn *string `type:"string"`

	// True if mapping of IAM accounts to database accounts is enabled, and otherwise
	// false.
	//
	// IAM database authentication can be enabled for the following database engines.
	//
	//    * For MySQL 5.6, minor version 5.6.34 or higher
	//
	//    * For MySQL 5.7, minor version 5.7.16 or higher
	//
	//    * Aurora 5.6 or higher
	IAMDatabaseAuthenticationEnabled *bool `type:"boolean"`

	// Indicates when the DB instance was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	InstanceCreateTime *string `type:"string"`

	// Specifies the provisioned IOPS (I/O operations per second) for this DB instance.
	Iops *int64 `type:"integer"`

	// If StorageEncrypted is true, the KMS key identifier for the encrypted DB
	// instance.
	KmsKeyId *string `type:"string"`

	// Specifies the latest time to which a database can be restored with point-in-time
	// restore.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	LatestRestorableTime *string `type:"string"`

	// License model information for this DB instance.
	LicenseModel *string `type:"string"`

	// Specifies the connection endpoint.
	ListenerEndpoint *AwsRdsDbInstanceEndpoint `type:"structure"`

	// The master user name of the DB instance.
	MasterUsername *string `type:"string"`

	// The upper limit to which Amazon RDS can automatically scale the storage of
	// the DB instance.
	MaxAllocatedStorage *int64 `type:"integer"`

	// The interval, in seconds, between points when enhanced monitoring metrics
	// are collected for the DB instance.
	MonitoringInterval *int64 `type:"integer"`

	// The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring
	// metrics to CloudWatch Logs.
	MonitoringRoleArn *string `type:"string"`

	// Whether the DB instance is a multiple Availability Zone deployment.
	MultiAz *bool `type:"boolean"`

	// The list of option group memberships for this DB instance.
	OptionGroupMemberships []*AwsRdsDbOptionGroupMembership `type:"list"`

	// Changes to the DB instance that are currently pending.
	PendingModifiedValues *AwsRdsDbPendingModifiedValues `type:"structure"`

	// Indicates whether Performance Insights is enabled for the DB instance.
	PerformanceInsightsEnabled *bool `type:"boolean"`

	// The identifier of the KMS key used to encrypt the Performance Insights data.
	PerformanceInsightsKmsKeyId *string `type:"string"`

	// The number of days to retain Performance Insights data.
	PerformanceInsightsRetentionPeriod *int64 `type:"integer"`

	// The range of time each day when automated backups are created, if automated
	// backups are enabled.
	//
	// Uses the format HH:MM-HH:MM. For example, 04:52-05:22.
	PreferredBackupWindow *string `type:"string"`

	// The weekly time range during which system maintenance can occur, in Universal
	// Coordinated Time (UTC).
	//
	// Uses the format <day>:HH:MM-<day>:HH:MM.
	//
	// For the day values, use mon|tue|wed|thu|fri|sat|sun.
	//
	// For example, sun:09:32-sun:10:02.
	PreferredMaintenanceWindow *string `type:"string"`

	// The number of CPU cores and the number of threads per core for the DB instance
	// class of the DB instance.
	ProcessorFeatures []*AwsRdsDbProcessorFeature `type:"list"`

	// The order in which to promote an Aurora replica to the primary instance after
	// a failure of the existing primary instance.
	PromotionTier *int64 `type:"integer"`

	// Specifies the accessibility options for the DB instance.
	//
	// A value of true specifies an Internet-facing instance with a publicly resolvable
	// DNS name, which resolves to a public IP address.
	//
	// A value of false specifies an internal instance with a DNS name that resolves
	// to a private IP address.
	PubliclyAccessible *bool `type:"boolean"`

	// List of identifiers of Aurora DB clusters to which the RDS DB instance is
	// replicated as a read replica.
	ReadReplicaDBClusterIdentifiers []*string `type:"list"`

	// List of identifiers of the read replicas associated with this DB instance.
	ReadReplicaDBInstanceIdentifiers []*string `type:"list"`

	// If this DB instance is a read replica, contains the identifier of the source
	// DB instance.
	ReadReplicaSourceDBInstanceIdentifier *string `type:"string"`

	// For a DB instance with multi-Availability Zone support, the name of the secondary
	// Availability Zone.
	SecondaryAvailabilityZone *string `type:"string"`

	// The status of a read replica. If the instance isn't a read replica, this
	// is empty.
	StatusInfos []*AwsRdsDbStatusInfo `type:"list"`

	// Specifies whether the DB instance is encrypted.
	StorageEncrypted *bool `type:"boolean"`

	// The storage type for the DB instance.
	StorageType *string `type:"string"`

	// The ARN from the key store with which the instance is associated for TDE
	// encryption.
	TdeCredentialArn *string `type:"string"`

	// The time zone of the DB instance.
	Timezone *string `type:"string"`

	// A list of VPC security groups that the DB instance belongs to.
	VpcSecurityGroups []*AwsRdsDbInstanceVpcSecurityGroup `type:"list"`
	// contains filtered or unexported fields
}

Contains the details of an Amazon RDS DB instance.

func (AwsRdsDbInstanceDetails) GoString

func (s AwsRdsDbInstanceDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbInstanceDetails) SetAllocatedStorage

func (s *AwsRdsDbInstanceDetails) SetAllocatedStorage(v int64) *AwsRdsDbInstanceDetails

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*AwsRdsDbInstanceDetails) SetAssociatedRoles

SetAssociatedRoles sets the AssociatedRoles field's value.

func (*AwsRdsDbInstanceDetails) SetAutoMinorVersionUpgrade

func (s *AwsRdsDbInstanceDetails) SetAutoMinorVersionUpgrade(v bool) *AwsRdsDbInstanceDetails

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*AwsRdsDbInstanceDetails) SetAvailabilityZone

func (s *AwsRdsDbInstanceDetails) SetAvailabilityZone(v string) *AwsRdsDbInstanceDetails

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*AwsRdsDbInstanceDetails) SetBackupRetentionPeriod

func (s *AwsRdsDbInstanceDetails) SetBackupRetentionPeriod(v int64) *AwsRdsDbInstanceDetails

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*AwsRdsDbInstanceDetails) SetCACertificateIdentifier

func (s *AwsRdsDbInstanceDetails) SetCACertificateIdentifier(v string) *AwsRdsDbInstanceDetails

SetCACertificateIdentifier sets the CACertificateIdentifier field's value.

func (*AwsRdsDbInstanceDetails) SetCharacterSetName

func (s *AwsRdsDbInstanceDetails) SetCharacterSetName(v string) *AwsRdsDbInstanceDetails

SetCharacterSetName sets the CharacterSetName field's value.

func (*AwsRdsDbInstanceDetails) SetCopyTagsToSnapshot

func (s *AwsRdsDbInstanceDetails) SetCopyTagsToSnapshot(v bool) *AwsRdsDbInstanceDetails

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*AwsRdsDbInstanceDetails) SetDBClusterIdentifier

func (s *AwsRdsDbInstanceDetails) SetDBClusterIdentifier(v string) *AwsRdsDbInstanceDetails

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*AwsRdsDbInstanceDetails) SetDBInstanceClass

func (s *AwsRdsDbInstanceDetails) SetDBInstanceClass(v string) *AwsRdsDbInstanceDetails

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*AwsRdsDbInstanceDetails) SetDBInstanceIdentifier

func (s *AwsRdsDbInstanceDetails) SetDBInstanceIdentifier(v string) *AwsRdsDbInstanceDetails

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*AwsRdsDbInstanceDetails) SetDBName

SetDBName sets the DBName field's value.

func (*AwsRdsDbInstanceDetails) SetDbInstancePort

func (s *AwsRdsDbInstanceDetails) SetDbInstancePort(v int64) *AwsRdsDbInstanceDetails

SetDbInstancePort sets the DbInstancePort field's value.

func (*AwsRdsDbInstanceDetails) SetDbInstanceStatus

func (s *AwsRdsDbInstanceDetails) SetDbInstanceStatus(v string) *AwsRdsDbInstanceDetails

SetDbInstanceStatus sets the DbInstanceStatus field's value.

func (*AwsRdsDbInstanceDetails) SetDbParameterGroups

SetDbParameterGroups sets the DbParameterGroups field's value.

func (*AwsRdsDbInstanceDetails) SetDbSecurityGroups

func (s *AwsRdsDbInstanceDetails) SetDbSecurityGroups(v []*string) *AwsRdsDbInstanceDetails

SetDbSecurityGroups sets the DbSecurityGroups field's value.

func (*AwsRdsDbInstanceDetails) SetDbSubnetGroup

SetDbSubnetGroup sets the DbSubnetGroup field's value.

func (*AwsRdsDbInstanceDetails) SetDbiResourceId

func (s *AwsRdsDbInstanceDetails) SetDbiResourceId(v string) *AwsRdsDbInstanceDetails

SetDbiResourceId sets the DbiResourceId field's value.

func (*AwsRdsDbInstanceDetails) SetDeletionProtection

func (s *AwsRdsDbInstanceDetails) SetDeletionProtection(v bool) *AwsRdsDbInstanceDetails

SetDeletionProtection sets the DeletionProtection field's value.

func (*AwsRdsDbInstanceDetails) SetDomainMemberships

SetDomainMemberships sets the DomainMemberships field's value.

func (*AwsRdsDbInstanceDetails) SetEnabledCloudWatchLogsExports

func (s *AwsRdsDbInstanceDetails) SetEnabledCloudWatchLogsExports(v []*string) *AwsRdsDbInstanceDetails

SetEnabledCloudWatchLogsExports sets the EnabledCloudWatchLogsExports field's value.

func (*AwsRdsDbInstanceDetails) SetEndpoint

SetEndpoint sets the Endpoint field's value.

func (*AwsRdsDbInstanceDetails) SetEngine

SetEngine sets the Engine field's value.

func (*AwsRdsDbInstanceDetails) SetEngineVersion

func (s *AwsRdsDbInstanceDetails) SetEngineVersion(v string) *AwsRdsDbInstanceDetails

SetEngineVersion sets the EngineVersion field's value.

func (*AwsRdsDbInstanceDetails) SetEnhancedMonitoringResourceArn

func (s *AwsRdsDbInstanceDetails) SetEnhancedMonitoringResourceArn(v string) *AwsRdsDbInstanceDetails

SetEnhancedMonitoringResourceArn sets the EnhancedMonitoringResourceArn field's value.

func (*AwsRdsDbInstanceDetails) SetIAMDatabaseAuthenticationEnabled

func (s *AwsRdsDbInstanceDetails) SetIAMDatabaseAuthenticationEnabled(v bool) *AwsRdsDbInstanceDetails

SetIAMDatabaseAuthenticationEnabled sets the IAMDatabaseAuthenticationEnabled field's value.

func (*AwsRdsDbInstanceDetails) SetInstanceCreateTime

func (s *AwsRdsDbInstanceDetails) SetInstanceCreateTime(v string) *AwsRdsDbInstanceDetails

SetInstanceCreateTime sets the InstanceCreateTime field's value.

func (*AwsRdsDbInstanceDetails) SetIops

SetIops sets the Iops field's value.

func (*AwsRdsDbInstanceDetails) SetKmsKeyId

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsRdsDbInstanceDetails) SetLatestRestorableTime

func (s *AwsRdsDbInstanceDetails) SetLatestRestorableTime(v string) *AwsRdsDbInstanceDetails

SetLatestRestorableTime sets the LatestRestorableTime field's value.

func (*AwsRdsDbInstanceDetails) SetLicenseModel

SetLicenseModel sets the LicenseModel field's value.

func (*AwsRdsDbInstanceDetails) SetListenerEndpoint

SetListenerEndpoint sets the ListenerEndpoint field's value.

func (*AwsRdsDbInstanceDetails) SetMasterUsername

func (s *AwsRdsDbInstanceDetails) SetMasterUsername(v string) *AwsRdsDbInstanceDetails

SetMasterUsername sets the MasterUsername field's value.

func (*AwsRdsDbInstanceDetails) SetMaxAllocatedStorage

func (s *AwsRdsDbInstanceDetails) SetMaxAllocatedStorage(v int64) *AwsRdsDbInstanceDetails

SetMaxAllocatedStorage sets the MaxAllocatedStorage field's value.

func (*AwsRdsDbInstanceDetails) SetMonitoringInterval

func (s *AwsRdsDbInstanceDetails) SetMonitoringInterval(v int64) *AwsRdsDbInstanceDetails

SetMonitoringInterval sets the MonitoringInterval field's value.

func (*AwsRdsDbInstanceDetails) SetMonitoringRoleArn

func (s *AwsRdsDbInstanceDetails) SetMonitoringRoleArn(v string) *AwsRdsDbInstanceDetails

SetMonitoringRoleArn sets the MonitoringRoleArn field's value.

func (*AwsRdsDbInstanceDetails) SetMultiAz

SetMultiAz sets the MultiAz field's value.

func (*AwsRdsDbInstanceDetails) SetOptionGroupMemberships

SetOptionGroupMemberships sets the OptionGroupMemberships field's value.

func (*AwsRdsDbInstanceDetails) SetPendingModifiedValues

SetPendingModifiedValues sets the PendingModifiedValues field's value.

func (*AwsRdsDbInstanceDetails) SetPerformanceInsightsEnabled

func (s *AwsRdsDbInstanceDetails) SetPerformanceInsightsEnabled(v bool) *AwsRdsDbInstanceDetails

SetPerformanceInsightsEnabled sets the PerformanceInsightsEnabled field's value.

func (*AwsRdsDbInstanceDetails) SetPerformanceInsightsKmsKeyId

func (s *AwsRdsDbInstanceDetails) SetPerformanceInsightsKmsKeyId(v string) *AwsRdsDbInstanceDetails

SetPerformanceInsightsKmsKeyId sets the PerformanceInsightsKmsKeyId field's value.

func (*AwsRdsDbInstanceDetails) SetPerformanceInsightsRetentionPeriod

func (s *AwsRdsDbInstanceDetails) SetPerformanceInsightsRetentionPeriod(v int64) *AwsRdsDbInstanceDetails

SetPerformanceInsightsRetentionPeriod sets the PerformanceInsightsRetentionPeriod field's value.

func (*AwsRdsDbInstanceDetails) SetPreferredBackupWindow

func (s *AwsRdsDbInstanceDetails) SetPreferredBackupWindow(v string) *AwsRdsDbInstanceDetails

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*AwsRdsDbInstanceDetails) SetPreferredMaintenanceWindow

func (s *AwsRdsDbInstanceDetails) SetPreferredMaintenanceWindow(v string) *AwsRdsDbInstanceDetails

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*AwsRdsDbInstanceDetails) SetProcessorFeatures

SetProcessorFeatures sets the ProcessorFeatures field's value.

func (*AwsRdsDbInstanceDetails) SetPromotionTier

func (s *AwsRdsDbInstanceDetails) SetPromotionTier(v int64) *AwsRdsDbInstanceDetails

SetPromotionTier sets the PromotionTier field's value.

func (*AwsRdsDbInstanceDetails) SetPubliclyAccessible

func (s *AwsRdsDbInstanceDetails) SetPubliclyAccessible(v bool) *AwsRdsDbInstanceDetails

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*AwsRdsDbInstanceDetails) SetReadReplicaDBClusterIdentifiers

func (s *AwsRdsDbInstanceDetails) SetReadReplicaDBClusterIdentifiers(v []*string) *AwsRdsDbInstanceDetails

SetReadReplicaDBClusterIdentifiers sets the ReadReplicaDBClusterIdentifiers field's value.

func (*AwsRdsDbInstanceDetails) SetReadReplicaDBInstanceIdentifiers

func (s *AwsRdsDbInstanceDetails) SetReadReplicaDBInstanceIdentifiers(v []*string) *AwsRdsDbInstanceDetails

SetReadReplicaDBInstanceIdentifiers sets the ReadReplicaDBInstanceIdentifiers field's value.

func (*AwsRdsDbInstanceDetails) SetReadReplicaSourceDBInstanceIdentifier

func (s *AwsRdsDbInstanceDetails) SetReadReplicaSourceDBInstanceIdentifier(v string) *AwsRdsDbInstanceDetails

SetReadReplicaSourceDBInstanceIdentifier sets the ReadReplicaSourceDBInstanceIdentifier field's value.

func (*AwsRdsDbInstanceDetails) SetSecondaryAvailabilityZone

func (s *AwsRdsDbInstanceDetails) SetSecondaryAvailabilityZone(v string) *AwsRdsDbInstanceDetails

SetSecondaryAvailabilityZone sets the SecondaryAvailabilityZone field's value.

func (*AwsRdsDbInstanceDetails) SetStatusInfos

SetStatusInfos sets the StatusInfos field's value.

func (*AwsRdsDbInstanceDetails) SetStorageEncrypted

func (s *AwsRdsDbInstanceDetails) SetStorageEncrypted(v bool) *AwsRdsDbInstanceDetails

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*AwsRdsDbInstanceDetails) SetStorageType

SetStorageType sets the StorageType field's value.

func (*AwsRdsDbInstanceDetails) SetTdeCredentialArn

func (s *AwsRdsDbInstanceDetails) SetTdeCredentialArn(v string) *AwsRdsDbInstanceDetails

SetTdeCredentialArn sets the TdeCredentialArn field's value.

func (*AwsRdsDbInstanceDetails) SetTimezone

SetTimezone sets the Timezone field's value.

func (*AwsRdsDbInstanceDetails) SetVpcSecurityGroups

SetVpcSecurityGroups sets the VpcSecurityGroups field's value.

func (AwsRdsDbInstanceDetails) String

func (s AwsRdsDbInstanceDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbInstanceEndpoint

type AwsRdsDbInstanceEndpoint struct {

	// Specifies the DNS address of the DB instance.
	Address *string `type:"string"`

	// Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
	HostedZoneId *string `type:"string"`

	// Specifies the port that the database engine is listening on.
	Port *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies the connection endpoint.

func (AwsRdsDbInstanceEndpoint) GoString

func (s AwsRdsDbInstanceEndpoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbInstanceEndpoint) SetAddress

SetAddress sets the Address field's value.

func (*AwsRdsDbInstanceEndpoint) SetHostedZoneId

SetHostedZoneId sets the HostedZoneId field's value.

func (*AwsRdsDbInstanceEndpoint) SetPort

SetPort sets the Port field's value.

func (AwsRdsDbInstanceEndpoint) String

func (s AwsRdsDbInstanceEndpoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbInstanceVpcSecurityGroup

type AwsRdsDbInstanceVpcSecurityGroup struct {

	// The status of the VPC security group.
	Status *string `type:"string"`

	// The name of the VPC security group.
	VpcSecurityGroupId *string `type:"string"`
	// contains filtered or unexported fields
}

A VPC security groups that the DB instance belongs to.

func (AwsRdsDbInstanceVpcSecurityGroup) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbInstanceVpcSecurityGroup) SetStatus

SetStatus sets the Status field's value.

func (*AwsRdsDbInstanceVpcSecurityGroup) SetVpcSecurityGroupId

SetVpcSecurityGroupId sets the VpcSecurityGroupId field's value.

func (AwsRdsDbInstanceVpcSecurityGroup) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbOptionGroupMembership

type AwsRdsDbOptionGroupMembership struct {

	// The name of the option group.
	OptionGroupName *string `type:"string"`

	// The status of the option group membership.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

An option group membership.

func (AwsRdsDbOptionGroupMembership) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbOptionGroupMembership) SetOptionGroupName

SetOptionGroupName sets the OptionGroupName field's value.

func (*AwsRdsDbOptionGroupMembership) SetStatus

SetStatus sets the Status field's value.

func (AwsRdsDbOptionGroupMembership) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbParameterGroup

type AwsRdsDbParameterGroup struct {

	// The name of the parameter group.
	DbParameterGroupName *string `type:"string"`

	// The status of parameter updates.
	ParameterApplyStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a parameter group for a DB instance.

func (AwsRdsDbParameterGroup) GoString

func (s AwsRdsDbParameterGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbParameterGroup) SetDbParameterGroupName

func (s *AwsRdsDbParameterGroup) SetDbParameterGroupName(v string) *AwsRdsDbParameterGroup

SetDbParameterGroupName sets the DbParameterGroupName field's value.

func (*AwsRdsDbParameterGroup) SetParameterApplyStatus

func (s *AwsRdsDbParameterGroup) SetParameterApplyStatus(v string) *AwsRdsDbParameterGroup

SetParameterApplyStatus sets the ParameterApplyStatus field's value.

func (AwsRdsDbParameterGroup) String

func (s AwsRdsDbParameterGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbPendingModifiedValues

type AwsRdsDbPendingModifiedValues struct {

	// The new value of the allocated storage for the DB instance.
	AllocatedStorage *int64 `type:"integer"`

	// The new backup retention period for the DB instance.
	BackupRetentionPeriod *int64 `type:"integer"`

	// The new CA certificate identifier for the DB instance.
	CaCertificateIdentifier *string `type:"string"`

	// The new DB instance class for the DB instance.
	DbInstanceClass *string `type:"string"`

	// The new DB instance identifier for the DB instance.
	DbInstanceIdentifier *string `type:"string"`

	// The name of the new subnet group for the DB instance.
	DbSubnetGroupName *string `type:"string"`

	// The new engine version for the DB instance.
	EngineVersion *string `type:"string"`

	// The new provisioned IOPS value for the DB instance.
	Iops *int64 `type:"integer"`

	// The new license model value for the DB instance.
	LicenseModel *string `type:"string"`

	// The new master user password for the DB instance.
	MasterUserPassword *string `type:"string"`

	// Indicates that a single Availability Zone DB instance is changing to a multiple
	// Availability Zone deployment.
	MultiAZ *bool `type:"boolean"`

	// A list of log types that are being enabled or disabled.
	PendingCloudWatchLogsExports *AwsRdsPendingCloudWatchLogsExports `type:"structure"`

	// The new port for the DB instance.
	Port *int64 `type:"integer"`

	// Processor features that are being updated.
	ProcessorFeatures []*AwsRdsDbProcessorFeature `type:"list"`

	// The new storage type for the DB instance.
	StorageType *string `type:"string"`
	// contains filtered or unexported fields
}

Changes to a DB instance that are currently pending.

func (AwsRdsDbPendingModifiedValues) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbPendingModifiedValues) SetAllocatedStorage

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*AwsRdsDbPendingModifiedValues) SetBackupRetentionPeriod

func (s *AwsRdsDbPendingModifiedValues) SetBackupRetentionPeriod(v int64) *AwsRdsDbPendingModifiedValues

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*AwsRdsDbPendingModifiedValues) SetCaCertificateIdentifier

func (s *AwsRdsDbPendingModifiedValues) SetCaCertificateIdentifier(v string) *AwsRdsDbPendingModifiedValues

SetCaCertificateIdentifier sets the CaCertificateIdentifier field's value.

func (*AwsRdsDbPendingModifiedValues) SetDbInstanceClass

SetDbInstanceClass sets the DbInstanceClass field's value.

func (*AwsRdsDbPendingModifiedValues) SetDbInstanceIdentifier

SetDbInstanceIdentifier sets the DbInstanceIdentifier field's value.

func (*AwsRdsDbPendingModifiedValues) SetDbSubnetGroupName

SetDbSubnetGroupName sets the DbSubnetGroupName field's value.

func (*AwsRdsDbPendingModifiedValues) SetEngineVersion

SetEngineVersion sets the EngineVersion field's value.

func (*AwsRdsDbPendingModifiedValues) SetIops

SetIops sets the Iops field's value.

func (*AwsRdsDbPendingModifiedValues) SetLicenseModel

SetLicenseModel sets the LicenseModel field's value.

func (*AwsRdsDbPendingModifiedValues) SetMasterUserPassword

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*AwsRdsDbPendingModifiedValues) SetMultiAZ

SetMultiAZ sets the MultiAZ field's value.

func (*AwsRdsDbPendingModifiedValues) SetPendingCloudWatchLogsExports

SetPendingCloudWatchLogsExports sets the PendingCloudWatchLogsExports field's value.

func (*AwsRdsDbPendingModifiedValues) SetPort

SetPort sets the Port field's value.

func (*AwsRdsDbPendingModifiedValues) SetProcessorFeatures

SetProcessorFeatures sets the ProcessorFeatures field's value.

func (*AwsRdsDbPendingModifiedValues) SetStorageType

SetStorageType sets the StorageType field's value.

func (AwsRdsDbPendingModifiedValues) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbProcessorFeature

type AwsRdsDbProcessorFeature struct {

	// The name of the processor feature. Valid values are coreCount or threadsPerCore.
	Name *string `type:"string"`

	// The value of the processor feature.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A processor feature.

func (AwsRdsDbProcessorFeature) GoString

func (s AwsRdsDbProcessorFeature) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbProcessorFeature) SetName

SetName sets the Name field's value.

func (*AwsRdsDbProcessorFeature) SetValue

SetValue sets the Value field's value.

func (AwsRdsDbProcessorFeature) String

func (s AwsRdsDbProcessorFeature) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbSecurityGroupDetails added in v1.42.9

type AwsRdsDbSecurityGroupDetails struct {

	// The ARN for the DB security group.
	DbSecurityGroupArn *string `type:"string"`

	// Provides the description of the DB security group.
	DbSecurityGroupDescription *string `type:"string"`

	// Specifies the name of the DB security group.
	DbSecurityGroupName *string `type:"string"`

	// Contains a list of EC2 security groups.
	Ec2SecurityGroups []*AwsRdsDbSecurityGroupEc2SecurityGroup `type:"list"`

	// Contains a list of IP ranges.
	IpRanges []*AwsRdsDbSecurityGroupIpRange `type:"list"`

	// Provides the Amazon Web Services ID of the owner of a specific DB security
	// group.
	OwnerId *string `type:"string"`

	// Provides VPC ID associated with the DB security group.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about an Amazon RDS DB security group.

func (AwsRdsDbSecurityGroupDetails) GoString added in v1.42.9

func (s AwsRdsDbSecurityGroupDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbSecurityGroupDetails) SetDbSecurityGroupArn added in v1.42.9

SetDbSecurityGroupArn sets the DbSecurityGroupArn field's value.

func (*AwsRdsDbSecurityGroupDetails) SetDbSecurityGroupDescription added in v1.42.9

func (s *AwsRdsDbSecurityGroupDetails) SetDbSecurityGroupDescription(v string) *AwsRdsDbSecurityGroupDetails

SetDbSecurityGroupDescription sets the DbSecurityGroupDescription field's value.

func (*AwsRdsDbSecurityGroupDetails) SetDbSecurityGroupName added in v1.42.9

SetDbSecurityGroupName sets the DbSecurityGroupName field's value.

func (*AwsRdsDbSecurityGroupDetails) SetEc2SecurityGroups added in v1.42.9

SetEc2SecurityGroups sets the Ec2SecurityGroups field's value.

func (*AwsRdsDbSecurityGroupDetails) SetIpRanges added in v1.42.9

SetIpRanges sets the IpRanges field's value.

func (*AwsRdsDbSecurityGroupDetails) SetOwnerId added in v1.42.9

SetOwnerId sets the OwnerId field's value.

func (*AwsRdsDbSecurityGroupDetails) SetVpcId added in v1.42.9

SetVpcId sets the VpcId field's value.

func (AwsRdsDbSecurityGroupDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbSecurityGroupEc2SecurityGroup added in v1.42.9

type AwsRdsDbSecurityGroupEc2SecurityGroup struct {

	// Specifies the ID for the EC2 security group.
	Ec2SecurityGroupId *string `type:"string"`

	// Specifies the name of the EC2 security group.
	Ec2SecurityGroupName *string `type:"string"`

	// Provides the Amazon Web Services ID of the owner of the EC2 security group.
	Ec2SecurityGroupOwnerId *string `type:"string"`

	// Provides the status of the EC2 security group.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

EC2 security group information for an RDS DB security group.

func (AwsRdsDbSecurityGroupEc2SecurityGroup) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbSecurityGroupEc2SecurityGroup) SetEc2SecurityGroupId added in v1.42.9

SetEc2SecurityGroupId sets the Ec2SecurityGroupId field's value.

func (*AwsRdsDbSecurityGroupEc2SecurityGroup) SetEc2SecurityGroupName added in v1.42.9

SetEc2SecurityGroupName sets the Ec2SecurityGroupName field's value.

func (*AwsRdsDbSecurityGroupEc2SecurityGroup) SetEc2SecurityGroupOwnerId added in v1.42.9

SetEc2SecurityGroupOwnerId sets the Ec2SecurityGroupOwnerId field's value.

func (*AwsRdsDbSecurityGroupEc2SecurityGroup) SetStatus added in v1.42.9

SetStatus sets the Status field's value.

func (AwsRdsDbSecurityGroupEc2SecurityGroup) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbSecurityGroupIpRange added in v1.42.9

type AwsRdsDbSecurityGroupIpRange struct {

	// Specifies the IP range.
	CidrIp *string `type:"string"`

	// Specifies the status of the IP range.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

IP range information for an RDS DB security group.

func (AwsRdsDbSecurityGroupIpRange) GoString added in v1.42.9

func (s AwsRdsDbSecurityGroupIpRange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbSecurityGroupIpRange) SetCidrIp added in v1.42.9

SetCidrIp sets the CidrIp field's value.

func (*AwsRdsDbSecurityGroupIpRange) SetStatus added in v1.42.9

SetStatus sets the Status field's value.

func (AwsRdsDbSecurityGroupIpRange) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbSnapshotDetails

type AwsRdsDbSnapshotDetails struct {

	// The amount of storage (in gigabytes) to be initially allocated for the database
	// instance.
	AllocatedStorage *int64 `type:"integer"`

	// Specifies the name of the Availability Zone in which the DB instance was
	// located at the time of the DB snapshot.
	AvailabilityZone *string `type:"string"`

	// A name for the DB instance.
	DbInstanceIdentifier *string `type:"string"`

	// The name or ARN of the DB snapshot that is used to restore the DB instance.
	DbSnapshotIdentifier *string `type:"string"`

	// The identifier for the source DB instance.
	DbiResourceId *string `type:"string"`

	// Whether the DB snapshot is encrypted.
	Encrypted *bool `type:"boolean"`

	// The name of the database engine to use for this DB instance. Valid values
	// are as follows:
	//
	//    * aurora
	//
	//    * aurora-mysql
	//
	//    * aurora-postgresql
	//
	//    * c
	//
	//    * mariadb
	//
	//    * mysql
	//
	//    * oracle-ee
	//
	//    * oracle-se
	//
	//    * oracle-se1
	//
	//    * oracle-se2
	//
	//    * sqlserver-ee
	//
	//    * sqlserver-ex
	//
	//    * sqlserver-se
	//
	//    * sqlserver-web
	Engine *string `type:"string"`

	// The version of the database engine.
	EngineVersion *string `type:"string"`

	// Whether mapping of IAM accounts to database accounts is enabled.
	IamDatabaseAuthenticationEnabled *bool `type:"boolean"`

	// Specifies the time in Coordinated Universal Time (UTC) when the DB instance,
	// from which the snapshot was taken, was created.
	InstanceCreateTime *string `type:"string"`

	// The provisioned IOPS (I/O operations per second) value of the DB instance
	// at the time of the snapshot.
	Iops *int64 `type:"integer"`

	// If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.
	KmsKeyId *string `type:"string"`

	// License model information for the restored DB instance.
	LicenseModel *string `type:"string"`

	// The master user name for the DB snapshot.
	MasterUsername *string `type:"string"`

	// The option group name for the DB snapshot.
	OptionGroupName *string `type:"string"`

	// The percentage of the estimated data that has been transferred.
	PercentProgress *int64 `type:"integer"`

	// The port that the database engine was listening on at the time of the snapshot.
	Port *int64 `type:"integer"`

	// The number of CPU cores and the number of threads per core for the DB instance
	// class of the DB instance.
	ProcessorFeatures []*AwsRdsDbProcessorFeature `type:"list"`

	// When the snapshot was taken in Coordinated Universal Time (UTC).
	SnapshotCreateTime *string `type:"string"`

	// The type of the DB snapshot.
	SnapshotType *string `type:"string"`

	// The DB snapshot ARN that the DB snapshot was copied from.
	SourceDbSnapshotIdentifier *string `type:"string"`

	// The Amazon Web Services Region that the DB snapshot was created in or copied
	// from.
	SourceRegion *string `type:"string"`

	// The status of this DB snapshot.
	Status *string `type:"string"`

	// The storage type associated with the DB snapshot. Valid values are as follows:
	//
	//    * gp2
	//
	//    * io1
	//
	//    * standard
	StorageType *string `type:"string"`

	// The ARN from the key store with which to associate the instance for TDE encryption.
	TdeCredentialArn *string `type:"string"`

	// The time zone of the DB snapshot.
	Timezone *string `type:"string"`

	// The VPC ID associated with the DB snapshot.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about an Amazon RDS DB cluster snapshot.

func (AwsRdsDbSnapshotDetails) GoString

func (s AwsRdsDbSnapshotDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbSnapshotDetails) SetAllocatedStorage

func (s *AwsRdsDbSnapshotDetails) SetAllocatedStorage(v int64) *AwsRdsDbSnapshotDetails

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*AwsRdsDbSnapshotDetails) SetAvailabilityZone

func (s *AwsRdsDbSnapshotDetails) SetAvailabilityZone(v string) *AwsRdsDbSnapshotDetails

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*AwsRdsDbSnapshotDetails) SetDbInstanceIdentifier

func (s *AwsRdsDbSnapshotDetails) SetDbInstanceIdentifier(v string) *AwsRdsDbSnapshotDetails

SetDbInstanceIdentifier sets the DbInstanceIdentifier field's value.

func (*AwsRdsDbSnapshotDetails) SetDbSnapshotIdentifier

func (s *AwsRdsDbSnapshotDetails) SetDbSnapshotIdentifier(v string) *AwsRdsDbSnapshotDetails

SetDbSnapshotIdentifier sets the DbSnapshotIdentifier field's value.

func (*AwsRdsDbSnapshotDetails) SetDbiResourceId

func (s *AwsRdsDbSnapshotDetails) SetDbiResourceId(v string) *AwsRdsDbSnapshotDetails

SetDbiResourceId sets the DbiResourceId field's value.

func (*AwsRdsDbSnapshotDetails) SetEncrypted

SetEncrypted sets the Encrypted field's value.

func (*AwsRdsDbSnapshotDetails) SetEngine

SetEngine sets the Engine field's value.

func (*AwsRdsDbSnapshotDetails) SetEngineVersion

func (s *AwsRdsDbSnapshotDetails) SetEngineVersion(v string) *AwsRdsDbSnapshotDetails

SetEngineVersion sets the EngineVersion field's value.

func (*AwsRdsDbSnapshotDetails) SetIamDatabaseAuthenticationEnabled

func (s *AwsRdsDbSnapshotDetails) SetIamDatabaseAuthenticationEnabled(v bool) *AwsRdsDbSnapshotDetails

SetIamDatabaseAuthenticationEnabled sets the IamDatabaseAuthenticationEnabled field's value.

func (*AwsRdsDbSnapshotDetails) SetInstanceCreateTime

func (s *AwsRdsDbSnapshotDetails) SetInstanceCreateTime(v string) *AwsRdsDbSnapshotDetails

SetInstanceCreateTime sets the InstanceCreateTime field's value.

func (*AwsRdsDbSnapshotDetails) SetIops

SetIops sets the Iops field's value.

func (*AwsRdsDbSnapshotDetails) SetKmsKeyId

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsRdsDbSnapshotDetails) SetLicenseModel

SetLicenseModel sets the LicenseModel field's value.

func (*AwsRdsDbSnapshotDetails) SetMasterUsername

func (s *AwsRdsDbSnapshotDetails) SetMasterUsername(v string) *AwsRdsDbSnapshotDetails

SetMasterUsername sets the MasterUsername field's value.

func (*AwsRdsDbSnapshotDetails) SetOptionGroupName

func (s *AwsRdsDbSnapshotDetails) SetOptionGroupName(v string) *AwsRdsDbSnapshotDetails

SetOptionGroupName sets the OptionGroupName field's value.

func (*AwsRdsDbSnapshotDetails) SetPercentProgress

func (s *AwsRdsDbSnapshotDetails) SetPercentProgress(v int64) *AwsRdsDbSnapshotDetails

SetPercentProgress sets the PercentProgress field's value.

func (*AwsRdsDbSnapshotDetails) SetPort

SetPort sets the Port field's value.

func (*AwsRdsDbSnapshotDetails) SetProcessorFeatures

SetProcessorFeatures sets the ProcessorFeatures field's value.

func (*AwsRdsDbSnapshotDetails) SetSnapshotCreateTime

func (s *AwsRdsDbSnapshotDetails) SetSnapshotCreateTime(v string) *AwsRdsDbSnapshotDetails

SetSnapshotCreateTime sets the SnapshotCreateTime field's value.

func (*AwsRdsDbSnapshotDetails) SetSnapshotType

SetSnapshotType sets the SnapshotType field's value.

func (*AwsRdsDbSnapshotDetails) SetSourceDbSnapshotIdentifier

func (s *AwsRdsDbSnapshotDetails) SetSourceDbSnapshotIdentifier(v string) *AwsRdsDbSnapshotDetails

SetSourceDbSnapshotIdentifier sets the SourceDbSnapshotIdentifier field's value.

func (*AwsRdsDbSnapshotDetails) SetSourceRegion

SetSourceRegion sets the SourceRegion field's value.

func (*AwsRdsDbSnapshotDetails) SetStatus

SetStatus sets the Status field's value.

func (*AwsRdsDbSnapshotDetails) SetStorageType

SetStorageType sets the StorageType field's value.

func (*AwsRdsDbSnapshotDetails) SetTdeCredentialArn

func (s *AwsRdsDbSnapshotDetails) SetTdeCredentialArn(v string) *AwsRdsDbSnapshotDetails

SetTdeCredentialArn sets the TdeCredentialArn field's value.

func (*AwsRdsDbSnapshotDetails) SetTimezone

SetTimezone sets the Timezone field's value.

func (*AwsRdsDbSnapshotDetails) SetVpcId

SetVpcId sets the VpcId field's value.

func (AwsRdsDbSnapshotDetails) String

func (s AwsRdsDbSnapshotDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbStatusInfo

type AwsRdsDbStatusInfo struct {

	// If the read replica is currently in an error state, provides the error details.
	Message *string `type:"string"`

	// Whether the read replica instance is operating normally.
	Normal *bool `type:"boolean"`

	// The status of the read replica instance.
	Status *string `type:"string"`

	// The type of status. For a read replica, the status type is read replication.
	StatusType *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the status of a read replica.

func (AwsRdsDbStatusInfo) GoString

func (s AwsRdsDbStatusInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbStatusInfo) SetMessage

func (s *AwsRdsDbStatusInfo) SetMessage(v string) *AwsRdsDbStatusInfo

SetMessage sets the Message field's value.

func (*AwsRdsDbStatusInfo) SetNormal

func (s *AwsRdsDbStatusInfo) SetNormal(v bool) *AwsRdsDbStatusInfo

SetNormal sets the Normal field's value.

func (*AwsRdsDbStatusInfo) SetStatus

func (s *AwsRdsDbStatusInfo) SetStatus(v string) *AwsRdsDbStatusInfo

SetStatus sets the Status field's value.

func (*AwsRdsDbStatusInfo) SetStatusType

func (s *AwsRdsDbStatusInfo) SetStatusType(v string) *AwsRdsDbStatusInfo

SetStatusType sets the StatusType field's value.

func (AwsRdsDbStatusInfo) String

func (s AwsRdsDbStatusInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbSubnetGroup

type AwsRdsDbSubnetGroup struct {

	// The ARN of the subnet group.
	DbSubnetGroupArn *string `type:"string"`

	// The description of the subnet group.
	DbSubnetGroupDescription *string `type:"string"`

	// The name of the subnet group.
	DbSubnetGroupName *string `type:"string"`

	// The status of the subnet group.
	SubnetGroupStatus *string `type:"string"`

	// A list of subnets in the subnet group.
	Subnets []*AwsRdsDbSubnetGroupSubnet `type:"list"`

	// The VPC ID of the subnet group.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the subnet group for the database instance.

func (AwsRdsDbSubnetGroup) GoString

func (s AwsRdsDbSubnetGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbSubnetGroup) SetDbSubnetGroupArn

func (s *AwsRdsDbSubnetGroup) SetDbSubnetGroupArn(v string) *AwsRdsDbSubnetGroup

SetDbSubnetGroupArn sets the DbSubnetGroupArn field's value.

func (*AwsRdsDbSubnetGroup) SetDbSubnetGroupDescription

func (s *AwsRdsDbSubnetGroup) SetDbSubnetGroupDescription(v string) *AwsRdsDbSubnetGroup

SetDbSubnetGroupDescription sets the DbSubnetGroupDescription field's value.

func (*AwsRdsDbSubnetGroup) SetDbSubnetGroupName

func (s *AwsRdsDbSubnetGroup) SetDbSubnetGroupName(v string) *AwsRdsDbSubnetGroup

SetDbSubnetGroupName sets the DbSubnetGroupName field's value.

func (*AwsRdsDbSubnetGroup) SetSubnetGroupStatus

func (s *AwsRdsDbSubnetGroup) SetSubnetGroupStatus(v string) *AwsRdsDbSubnetGroup

SetSubnetGroupStatus sets the SubnetGroupStatus field's value.

func (*AwsRdsDbSubnetGroup) SetSubnets

SetSubnets sets the Subnets field's value.

func (*AwsRdsDbSubnetGroup) SetVpcId

SetVpcId sets the VpcId field's value.

func (AwsRdsDbSubnetGroup) String

func (s AwsRdsDbSubnetGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbSubnetGroupSubnet

type AwsRdsDbSubnetGroupSubnet struct {

	// Information about the Availability Zone for a subnet in the subnet group.
	SubnetAvailabilityZone *AwsRdsDbSubnetGroupSubnetAvailabilityZone `type:"structure"`

	// The identifier of a subnet in the subnet group.
	SubnetIdentifier *string `type:"string"`

	// The status of a subnet in the subnet group.
	SubnetStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a subnet in a subnet group.

func (AwsRdsDbSubnetGroupSubnet) GoString

func (s AwsRdsDbSubnetGroupSubnet) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbSubnetGroupSubnet) SetSubnetAvailabilityZone

SetSubnetAvailabilityZone sets the SubnetAvailabilityZone field's value.

func (*AwsRdsDbSubnetGroupSubnet) SetSubnetIdentifier

func (s *AwsRdsDbSubnetGroupSubnet) SetSubnetIdentifier(v string) *AwsRdsDbSubnetGroupSubnet

SetSubnetIdentifier sets the SubnetIdentifier field's value.

func (*AwsRdsDbSubnetGroupSubnet) SetSubnetStatus

SetSubnetStatus sets the SubnetStatus field's value.

func (AwsRdsDbSubnetGroupSubnet) String

func (s AwsRdsDbSubnetGroupSubnet) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsDbSubnetGroupSubnetAvailabilityZone

type AwsRdsDbSubnetGroupSubnetAvailabilityZone struct {

	// The name of the Availability Zone for a subnet in the subnet group.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

An Availability Zone for a subnet in a subnet group.

func (AwsRdsDbSubnetGroupSubnetAvailabilityZone) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsDbSubnetGroupSubnetAvailabilityZone) SetName

SetName sets the Name field's value.

func (AwsRdsDbSubnetGroupSubnetAvailabilityZone) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsEventSubscriptionDetails

type AwsRdsEventSubscriptionDetails struct {

	// The identifier of the account that is associated with the event notification
	// subscription.
	CustSubscriptionId *string `type:"string"`

	// The identifier of the event notification subscription.
	CustomerAwsId *string `type:"string"`

	// Whether the event notification subscription is enabled.
	Enabled *bool `type:"boolean"`

	// The list of event categories for the event notification subscription.
	EventCategoriesList []*string `type:"list"`

	// The ARN of the event notification subscription.
	EventSubscriptionArn *string `type:"string"`

	// The ARN of the SNS topic to post the event notifications to.
	SnsTopicArn *string `type:"string"`

	// A list of source identifiers for the event notification subscription.
	SourceIdsList []*string `type:"list"`

	// The source type for the event notification subscription.
	SourceType *string `type:"string"`

	// The status of the event notification subscription.
	//
	// Valid values: creating | modifying | deleting | active | no-permission |
	// topic-not-exist
	Status *string `type:"string"`

	// The datetime when the event notification subscription was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	SubscriptionCreationTime *string `type:"string"`
	// contains filtered or unexported fields
}

Details about an Amazon RDS event notification subscription. The subscription allows Amazon RDS to post events to an SNS topic.

func (AwsRdsEventSubscriptionDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsEventSubscriptionDetails) SetCustSubscriptionId

SetCustSubscriptionId sets the CustSubscriptionId field's value.

func (*AwsRdsEventSubscriptionDetails) SetCustomerAwsId

SetCustomerAwsId sets the CustomerAwsId field's value.

func (*AwsRdsEventSubscriptionDetails) SetEnabled

SetEnabled sets the Enabled field's value.

func (*AwsRdsEventSubscriptionDetails) SetEventCategoriesList

func (s *AwsRdsEventSubscriptionDetails) SetEventCategoriesList(v []*string) *AwsRdsEventSubscriptionDetails

SetEventCategoriesList sets the EventCategoriesList field's value.

func (*AwsRdsEventSubscriptionDetails) SetEventSubscriptionArn

SetEventSubscriptionArn sets the EventSubscriptionArn field's value.

func (*AwsRdsEventSubscriptionDetails) SetSnsTopicArn

SetSnsTopicArn sets the SnsTopicArn field's value.

func (*AwsRdsEventSubscriptionDetails) SetSourceIdsList

SetSourceIdsList sets the SourceIdsList field's value.

func (*AwsRdsEventSubscriptionDetails) SetSourceType

SetSourceType sets the SourceType field's value.

func (*AwsRdsEventSubscriptionDetails) SetStatus

SetStatus sets the Status field's value.

func (*AwsRdsEventSubscriptionDetails) SetSubscriptionCreationTime

func (s *AwsRdsEventSubscriptionDetails) SetSubscriptionCreationTime(v string) *AwsRdsEventSubscriptionDetails

SetSubscriptionCreationTime sets the SubscriptionCreationTime field's value.

func (AwsRdsEventSubscriptionDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRdsPendingCloudWatchLogsExports

type AwsRdsPendingCloudWatchLogsExports struct {

	// A list of log types that are being disabled.
	LogTypesToDisable []*string `type:"list"`

	// A list of log types that are being enabled.
	LogTypesToEnable []*string `type:"list"`
	// contains filtered or unexported fields
}

Identifies the log types to enable and disable.

func (AwsRdsPendingCloudWatchLogsExports) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRdsPendingCloudWatchLogsExports) SetLogTypesToDisable

SetLogTypesToDisable sets the LogTypesToDisable field's value.

func (*AwsRdsPendingCloudWatchLogsExports) SetLogTypesToEnable

SetLogTypesToEnable sets the LogTypesToEnable field's value.

func (AwsRdsPendingCloudWatchLogsExports) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRedshiftClusterClusterNode

type AwsRedshiftClusterClusterNode struct {

	// The role of the node. A node might be a leader node or a compute node.
	NodeRole *string `type:"string"`

	// The private IP address of the node.
	PrivateIpAddress *string `type:"string"`

	// The public IP address of the node.
	PublicIpAddress *string `type:"string"`
	// contains filtered or unexported fields
}

A node in an Amazon Redshift cluster.

func (AwsRedshiftClusterClusterNode) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRedshiftClusterClusterNode) SetNodeRole

SetNodeRole sets the NodeRole field's value.

func (*AwsRedshiftClusterClusterNode) SetPrivateIpAddress

SetPrivateIpAddress sets the PrivateIpAddress field's value.

func (*AwsRedshiftClusterClusterNode) SetPublicIpAddress

SetPublicIpAddress sets the PublicIpAddress field's value.

func (AwsRedshiftClusterClusterNode) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRedshiftClusterClusterParameterGroup

type AwsRedshiftClusterClusterParameterGroup struct {

	// The list of parameter statuses.
	ClusterParameterStatusList []*AwsRedshiftClusterClusterParameterStatus `type:"list"`

	// The status of updates to the parameters.
	ParameterApplyStatus *string `type:"string"`

	// The name of the parameter group.
	ParameterGroupName *string `type:"string"`
	// contains filtered or unexported fields
}

A cluster parameter group that is associated with an Amazon Redshift cluster.

func (AwsRedshiftClusterClusterParameterGroup) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRedshiftClusterClusterParameterGroup) SetClusterParameterStatusList

SetClusterParameterStatusList sets the ClusterParameterStatusList field's value.

func (*AwsRedshiftClusterClusterParameterGroup) SetParameterApplyStatus

SetParameterApplyStatus sets the ParameterApplyStatus field's value.

func (*AwsRedshiftClusterClusterParameterGroup) SetParameterGroupName

SetParameterGroupName sets the ParameterGroupName field's value.

func (AwsRedshiftClusterClusterParameterGroup) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRedshiftClusterClusterParameterStatus

type AwsRedshiftClusterClusterParameterStatus struct {

	// The error that prevented the parameter from being applied to the database.
	ParameterApplyErrorDescription *string `type:"string"`

	// The status of the parameter. Indicates whether the parameter is in sync with
	// the database, waiting for a cluster reboot, or encountered an error when
	// it was applied.
	//
	// Valid values: in-sync | pending-reboot | applying | invalid-parameter | apply-deferred
	// | apply-error | unknown-error
	ParameterApplyStatus *string `type:"string"`

	// The name of the parameter.
	ParameterName *string `type:"string"`
	// contains filtered or unexported fields
}

The status of a parameter in a cluster parameter group for an Amazon Redshift cluster.

func (AwsRedshiftClusterClusterParameterStatus) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRedshiftClusterClusterParameterStatus) SetParameterApplyErrorDescription

SetParameterApplyErrorDescription sets the ParameterApplyErrorDescription field's value.

func (*AwsRedshiftClusterClusterParameterStatus) SetParameterApplyStatus

SetParameterApplyStatus sets the ParameterApplyStatus field's value.

func (*AwsRedshiftClusterClusterParameterStatus) SetParameterName

SetParameterName sets the ParameterName field's value.

func (AwsRedshiftClusterClusterParameterStatus) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRedshiftClusterClusterSecurityGroup

type AwsRedshiftClusterClusterSecurityGroup struct {

	// The name of the cluster security group.
	ClusterSecurityGroupName *string `type:"string"`

	// The status of the cluster security group.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

A security group that is associated with the cluster.

func (AwsRedshiftClusterClusterSecurityGroup) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRedshiftClusterClusterSecurityGroup) SetClusterSecurityGroupName

SetClusterSecurityGroupName sets the ClusterSecurityGroupName field's value.

func (*AwsRedshiftClusterClusterSecurityGroup) SetStatus

SetStatus sets the Status field's value.

func (AwsRedshiftClusterClusterSecurityGroup) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRedshiftClusterClusterSnapshotCopyStatus

type AwsRedshiftClusterClusterSnapshotCopyStatus struct {

	// The destination Region that snapshots are automatically copied to when cross-Region
	// snapshot copy is enabled.
	DestinationRegion *string `type:"string"`

	// The number of days that manual snapshots are retained in the destination
	// Region after they are copied from a source Region.
	//
	// If the value is -1, then the manual snapshot is retained indefinitely.
	//
	// Valid values: Either -1 or an integer between 1 and 3,653
	ManualSnapshotRetentionPeriod *int64 `type:"integer"`

	// The number of days to retain automated snapshots in the destination Region
	// after they are copied from a source Region.
	RetentionPeriod *int64 `type:"integer"`

	// The name of the snapshot copy grant.
	SnapshotCopyGrantName *string `type:"string"`
	// contains filtered or unexported fields
}

You can configure Amazon Redshift to copy snapshots for a cluster to another Amazon Web Services Region. This parameter provides information about a cross-Region snapshot copy.

func (AwsRedshiftClusterClusterSnapshotCopyStatus) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRedshiftClusterClusterSnapshotCopyStatus) SetDestinationRegion

SetDestinationRegion sets the DestinationRegion field's value.

func (*AwsRedshiftClusterClusterSnapshotCopyStatus) SetManualSnapshotRetentionPeriod

SetManualSnapshotRetentionPeriod sets the ManualSnapshotRetentionPeriod field's value.

func (*AwsRedshiftClusterClusterSnapshotCopyStatus) SetRetentionPeriod

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*AwsRedshiftClusterClusterSnapshotCopyStatus) SetSnapshotCopyGrantName

SetSnapshotCopyGrantName sets the SnapshotCopyGrantName field's value.

func (AwsRedshiftClusterClusterSnapshotCopyStatus) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRedshiftClusterDeferredMaintenanceWindow

type AwsRedshiftClusterDeferredMaintenanceWindow struct {

	// The end of the time window for which maintenance was deferred.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	DeferMaintenanceEndTime *string `type:"string"`

	// The identifier of the maintenance window.
	DeferMaintenanceIdentifier *string `type:"string"`

	// The start of the time window for which maintenance was deferred.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	DeferMaintenanceStartTime *string `type:"string"`
	// contains filtered or unexported fields
}

A time windows during which maintenance was deferred for an Amazon Redshift cluster.

func (AwsRedshiftClusterDeferredMaintenanceWindow) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRedshiftClusterDeferredMaintenanceWindow) SetDeferMaintenanceEndTime

SetDeferMaintenanceEndTime sets the DeferMaintenanceEndTime field's value.

func (*AwsRedshiftClusterDeferredMaintenanceWindow) SetDeferMaintenanceIdentifier

SetDeferMaintenanceIdentifier sets the DeferMaintenanceIdentifier field's value.

func (*AwsRedshiftClusterDeferredMaintenanceWindow) SetDeferMaintenanceStartTime

SetDeferMaintenanceStartTime sets the DeferMaintenanceStartTime field's value.

func (AwsRedshiftClusterDeferredMaintenanceWindow) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRedshiftClusterDetails

type AwsRedshiftClusterDetails struct {

	// Indicates whether major version upgrades are applied automatically to the
	// cluster during the maintenance window.
	AllowVersionUpgrade *bool `type:"boolean"`

	// The number of days that automatic cluster snapshots are retained.
	AutomatedSnapshotRetentionPeriod *int64 `type:"integer"`

	// The name of the Availability Zone in which the cluster is located.
	AvailabilityZone *string `type:"string"`

	// The availability status of the cluster for queries. Possible values are the
	// following:
	//
	//    * Available - The cluster is available for queries.
	//
	//    * Unavailable - The cluster is not available for queries.
	//
	//    * Maintenance - The cluster is intermittently available for queries due
	//    to maintenance activities.
	//
	//    * Modifying -The cluster is intermittently available for queries due to
	//    changes that modify the cluster.
	//
	//    * Failed - The cluster failed and is not available for queries.
	ClusterAvailabilityStatus *string `type:"string"`

	// Indicates when the cluster was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	ClusterCreateTime *string `type:"string"`

	// The unique identifier of the cluster.
	ClusterIdentifier *string `type:"string"`

	// The nodes in the cluster.
	ClusterNodes []*AwsRedshiftClusterClusterNode `type:"list"`

	// The list of cluster parameter groups that are associated with this cluster.
	ClusterParameterGroups []*AwsRedshiftClusterClusterParameterGroup `type:"list"`

	// The public key for the cluster.
	ClusterPublicKey *string `type:"string"`

	// The specific revision number of the database in the cluster.
	ClusterRevisionNumber *string `type:"string"`

	// A list of cluster security groups that are associated with the cluster.
	ClusterSecurityGroups []*AwsRedshiftClusterClusterSecurityGroup `type:"list"`

	// Information about the destination Region and retention period for the cross-Region
	// snapshot copy.
	ClusterSnapshotCopyStatus *AwsRedshiftClusterClusterSnapshotCopyStatus `type:"structure"`

	// The current status of the cluster.
	//
	// Valid values: available | available, prep-for-resize | available, resize-cleanup
	// |cancelling-resize | creating | deleting | final-snapshot | hardware-failure
	// | incompatible-hsm |incompatible-network | incompatible-parameters | incompatible-restore
	// | modifying | paused | rebooting | renaming | resizing | rotating-keys |
	// storage-full | updating-hsm
	ClusterStatus *string `type:"string"`

	// The name of the subnet group that is associated with the cluster. This parameter
	// is valid only when the cluster is in a VPC.
	ClusterSubnetGroupName *string `type:"string"`

	// The version ID of the Amazon Redshift engine that runs on the cluster.
	ClusterVersion *string `type:"string"`

	// The name of the initial database that was created when the cluster was created.
	//
	// The same name is returned for the life of the cluster.
	//
	// If an initial database is not specified, a database named devdev is created
	// by default.
	DBName *string `type:"string"`

	// List of time windows during which maintenance was deferred.
	DeferredMaintenanceWindows []*AwsRedshiftClusterDeferredMaintenanceWindow `type:"list"`

	// Information about the status of the Elastic IP (EIP) address.
	ElasticIpStatus *AwsRedshiftClusterElasticIpStatus `type:"structure"`

	// The number of nodes that you can use the elastic resize method to resize
	// the cluster to.
	ElasticResizeNumberOfNodeOptions *string `type:"string"`

	// Indicates whether the data in the cluster is encrypted at rest.
	Encrypted *bool `type:"boolean"`

	// The connection endpoint.
	Endpoint *AwsRedshiftClusterEndpoint `type:"structure"`

	// Indicates whether to create the cluster with enhanced VPC routing enabled.
	EnhancedVpcRouting *bool `type:"boolean"`

	// Indicates when the next snapshot is expected to be taken. The cluster must
	// have a valid snapshot schedule and have backups enabled.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	ExpectedNextSnapshotScheduleTime *string `type:"string"`

	// The status of the next expected snapshot.
	//
	// Valid values: OnTrack | Pending
	ExpectedNextSnapshotScheduleTimeStatus *string `type:"string"`

	// Information about whether the Amazon Redshift cluster finished applying any
	// changes to hardware security module (HSM) settings that were specified in
	// a modify cluster command.
	HsmStatus *AwsRedshiftClusterHsmStatus `type:"structure"`

	// A list of IAM roles that the cluster can use to access other Amazon Web Services
	// services.
	IamRoles []*AwsRedshiftClusterIamRole `type:"list"`

	// The identifier of the KMS encryption key that is used to encrypt data in
	// the cluster.
	KmsKeyId *string `type:"string"`

	// Information about the logging status of the cluster.
	LoggingStatus *AwsRedshiftClusterLoggingStatus `type:"structure"`

	// The name of the maintenance track for the cluster.
	MaintenanceTrackName *string `type:"string"`

	// The default number of days to retain a manual snapshot.
	//
	// If the value is -1, the snapshot is retained indefinitely.
	//
	// This setting doesn't change the retention period of existing snapshots.
	//
	// Valid values: Either -1 or an integer between 1 and 3,653
	ManualSnapshotRetentionPeriod *int64 `type:"integer"`

	// The master user name for the cluster. This name is used to connect to the
	// database that is specified in as the value of DBName.
	MasterUsername *string `type:"string"`

	// Indicates the start of the next maintenance window.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	NextMaintenanceWindowStartTime *string `type:"string"`

	// The node type for the nodes in the cluster.
	NodeType *string `type:"string"`

	// The number of compute nodes in the cluster.
	NumberOfNodes *int64 `type:"integer"`

	// A list of cluster operations that are waiting to start.
	PendingActions []*string `type:"list"`

	// A list of changes to the cluster that are currently pending.
	PendingModifiedValues *AwsRedshiftClusterPendingModifiedValues `type:"structure"`

	// The weekly time range, in Universal Coordinated Time (UTC), during which
	// system maintenance can occur.
	//
	// Format: <day>:HH:MM-<day>:HH:MM
	//
	// For the day values, use mon | tue | wed | thu | fri | sat | sun
	//
	// For example, sun:09:32-sun:10:02
	PreferredMaintenanceWindow *string `type:"string"`

	// Whether the cluster can be accessed from a public network.
	PubliclyAccessible *bool `type:"boolean"`

	// Information about the resize operation for the cluster.
	ResizeInfo *AwsRedshiftClusterResizeInfo `type:"structure"`

	// Information about the status of a cluster restore action. Only applies to
	// a cluster that was created by restoring a snapshot.
	RestoreStatus *AwsRedshiftClusterRestoreStatus `type:"structure"`

	// A unique identifier for the cluster snapshot schedule.
	SnapshotScheduleIdentifier *string `type:"string"`

	// The current state of the cluster snapshot schedule.
	//
	// Valid values: MODIFYING | ACTIVE | FAILED
	SnapshotScheduleState *string `type:"string"`

	// The identifier of the VPC that the cluster is in, if the cluster is in a
	// VPC.
	VpcId *string `type:"string"`

	// The list of VPC security groups that the cluster belongs to, if the cluster
	// is in a VPC.
	VpcSecurityGroups []*AwsRedshiftClusterVpcSecurityGroup `type:"list"`
	// contains filtered or unexported fields
}

Details about an Amazon Redshift cluster.

func (AwsRedshiftClusterDetails) GoString

func (s AwsRedshiftClusterDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRedshiftClusterDetails) SetAllowVersionUpgrade

func (s *AwsRedshiftClusterDetails) SetAllowVersionUpgrade(v bool) *AwsRedshiftClusterDetails

SetAllowVersionUpgrade sets the AllowVersionUpgrade field's value.

func (*AwsRedshiftClusterDetails) SetAutomatedSnapshotRetentionPeriod

func (s *AwsRedshiftClusterDetails) SetAutomatedSnapshotRetentionPeriod(v int64) *AwsRedshiftClusterDetails

SetAutomatedSnapshotRetentionPeriod sets the AutomatedSnapshotRetentionPeriod field's value.

func (*AwsRedshiftClusterDetails) SetAvailabilityZone

func (s *AwsRedshiftClusterDetails) SetAvailabilityZone(v string) *AwsRedshiftClusterDetails

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*AwsRedshiftClusterDetails) SetClusterAvailabilityStatus

func (s *AwsRedshiftClusterDetails) SetClusterAvailabilityStatus(v string) *AwsRedshiftClusterDetails

SetClusterAvailabilityStatus sets the ClusterAvailabilityStatus field's value.

func (*AwsRedshiftClusterDetails) SetClusterCreateTime

func (s *AwsRedshiftClusterDetails) SetClusterCreateTime(v string) *AwsRedshiftClusterDetails

SetClusterCreateTime sets the ClusterCreateTime field's value.

func (*AwsRedshiftClusterDetails) SetClusterIdentifier

func (s *AwsRedshiftClusterDetails) SetClusterIdentifier(v string) *AwsRedshiftClusterDetails

SetClusterIdentifier sets the ClusterIdentifier field's value.

func (*AwsRedshiftClusterDetails) SetClusterNodes

SetClusterNodes sets the ClusterNodes field's value.

func (*AwsRedshiftClusterDetails) SetClusterParameterGroups

SetClusterParameterGroups sets the ClusterParameterGroups field's value.

func (*AwsRedshiftClusterDetails) SetClusterPublicKey

func (s *AwsRedshiftClusterDetails) SetClusterPublicKey(v string) *AwsRedshiftClusterDetails

SetClusterPublicKey sets the ClusterPublicKey field's value.

func (*AwsRedshiftClusterDetails) SetClusterRevisionNumber

func (s *AwsRedshiftClusterDetails) SetClusterRevisionNumber(v string) *AwsRedshiftClusterDetails

SetClusterRevisionNumber sets the ClusterRevisionNumber field's value.

func (*AwsRedshiftClusterDetails) SetClusterSecurityGroups

SetClusterSecurityGroups sets the ClusterSecurityGroups field's value.

func (*AwsRedshiftClusterDetails) SetClusterSnapshotCopyStatus

SetClusterSnapshotCopyStatus sets the ClusterSnapshotCopyStatus field's value.

func (*AwsRedshiftClusterDetails) SetClusterStatus

SetClusterStatus sets the ClusterStatus field's value.

func (*AwsRedshiftClusterDetails) SetClusterSubnetGroupName

func (s *AwsRedshiftClusterDetails) SetClusterSubnetGroupName(v string) *AwsRedshiftClusterDetails

SetClusterSubnetGroupName sets the ClusterSubnetGroupName field's value.

func (*AwsRedshiftClusterDetails) SetClusterVersion

SetClusterVersion sets the ClusterVersion field's value.

func (*AwsRedshiftClusterDetails) SetDBName

SetDBName sets the DBName field's value.

func (*AwsRedshiftClusterDetails) SetDeferredMaintenanceWindows

SetDeferredMaintenanceWindows sets the DeferredMaintenanceWindows field's value.

func (*AwsRedshiftClusterDetails) SetElasticIpStatus

SetElasticIpStatus sets the ElasticIpStatus field's value.

func (*AwsRedshiftClusterDetails) SetElasticResizeNumberOfNodeOptions

func (s *AwsRedshiftClusterDetails) SetElasticResizeNumberOfNodeOptions(v string) *AwsRedshiftClusterDetails

SetElasticResizeNumberOfNodeOptions sets the ElasticResizeNumberOfNodeOptions field's value.

func (*AwsRedshiftClusterDetails) SetEncrypted

SetEncrypted sets the Encrypted field's value.

func (*AwsRedshiftClusterDetails) SetEndpoint

SetEndpoint sets the Endpoint field's value.

func (*AwsRedshiftClusterDetails) SetEnhancedVpcRouting

func (s *AwsRedshiftClusterDetails) SetEnhancedVpcRouting(v bool) *AwsRedshiftClusterDetails

SetEnhancedVpcRouting sets the EnhancedVpcRouting field's value.

func (*AwsRedshiftClusterDetails) SetExpectedNextSnapshotScheduleTime

func (s *AwsRedshiftClusterDetails) SetExpectedNextSnapshotScheduleTime(v string) *AwsRedshiftClusterDetails

SetExpectedNextSnapshotScheduleTime sets the ExpectedNextSnapshotScheduleTime field's value.

func (*AwsRedshiftClusterDetails) SetExpectedNextSnapshotScheduleTimeStatus

func (s *AwsRedshiftClusterDetails) SetExpectedNextSnapshotScheduleTimeStatus(v string) *AwsRedshiftClusterDetails

SetExpectedNextSnapshotScheduleTimeStatus sets the ExpectedNextSnapshotScheduleTimeStatus field's value.

func (*AwsRedshiftClusterDetails) SetHsmStatus

SetHsmStatus sets the HsmStatus field's value.

func (*AwsRedshiftClusterDetails) SetIamRoles

SetIamRoles sets the IamRoles field's value.

func (*AwsRedshiftClusterDetails) SetKmsKeyId

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsRedshiftClusterDetails) SetLoggingStatus added in v1.42.9

SetLoggingStatus sets the LoggingStatus field's value.

func (*AwsRedshiftClusterDetails) SetMaintenanceTrackName

func (s *AwsRedshiftClusterDetails) SetMaintenanceTrackName(v string) *AwsRedshiftClusterDetails

SetMaintenanceTrackName sets the MaintenanceTrackName field's value.

func (*AwsRedshiftClusterDetails) SetManualSnapshotRetentionPeriod

func (s *AwsRedshiftClusterDetails) SetManualSnapshotRetentionPeriod(v int64) *AwsRedshiftClusterDetails

SetManualSnapshotRetentionPeriod sets the ManualSnapshotRetentionPeriod field's value.

func (*AwsRedshiftClusterDetails) SetMasterUsername

SetMasterUsername sets the MasterUsername field's value.

func (*AwsRedshiftClusterDetails) SetNextMaintenanceWindowStartTime

func (s *AwsRedshiftClusterDetails) SetNextMaintenanceWindowStartTime(v string) *AwsRedshiftClusterDetails

SetNextMaintenanceWindowStartTime sets the NextMaintenanceWindowStartTime field's value.

func (*AwsRedshiftClusterDetails) SetNodeType

SetNodeType sets the NodeType field's value.

func (*AwsRedshiftClusterDetails) SetNumberOfNodes

SetNumberOfNodes sets the NumberOfNodes field's value.

func (*AwsRedshiftClusterDetails) SetPendingActions

func (s *AwsRedshiftClusterDetails) SetPendingActions(v []*string) *AwsRedshiftClusterDetails

SetPendingActions sets the PendingActions field's value.

func (*AwsRedshiftClusterDetails) SetPendingModifiedValues

SetPendingModifiedValues sets the PendingModifiedValues field's value.

func (*AwsRedshiftClusterDetails) SetPreferredMaintenanceWindow

func (s *AwsRedshiftClusterDetails) SetPreferredMaintenanceWindow(v string) *AwsRedshiftClusterDetails

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*AwsRedshiftClusterDetails) SetPubliclyAccessible

func (s *AwsRedshiftClusterDetails) SetPubliclyAccessible(v bool) *AwsRedshiftClusterDetails

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*AwsRedshiftClusterDetails) SetResizeInfo

SetResizeInfo sets the ResizeInfo field's value.

func (*AwsRedshiftClusterDetails) SetRestoreStatus

SetRestoreStatus sets the RestoreStatus field's value.

func (*AwsRedshiftClusterDetails) SetSnapshotScheduleIdentifier

func (s *AwsRedshiftClusterDetails) SetSnapshotScheduleIdentifier(v string) *AwsRedshiftClusterDetails

SetSnapshotScheduleIdentifier sets the SnapshotScheduleIdentifier field's value.

func (*AwsRedshiftClusterDetails) SetSnapshotScheduleState

func (s *AwsRedshiftClusterDetails) SetSnapshotScheduleState(v string) *AwsRedshiftClusterDetails

SetSnapshotScheduleState sets the SnapshotScheduleState field's value.

func (*AwsRedshiftClusterDetails) SetVpcId

SetVpcId sets the VpcId field's value.

func (*AwsRedshiftClusterDetails) SetVpcSecurityGroups

SetVpcSecurityGroups sets the VpcSecurityGroups field's value.

func (AwsRedshiftClusterDetails) String

func (s AwsRedshiftClusterDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRedshiftClusterElasticIpStatus

type AwsRedshiftClusterElasticIpStatus struct {

	// The elastic IP address for the cluster.
	ElasticIp *string `type:"string"`

	// The status of the elastic IP address.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

The status of the elastic IP (EIP) address for an Amazon Redshift cluster.

func (AwsRedshiftClusterElasticIpStatus) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRedshiftClusterElasticIpStatus) SetElasticIp

SetElasticIp sets the ElasticIp field's value.

func (*AwsRedshiftClusterElasticIpStatus) SetStatus

SetStatus sets the Status field's value.

func (AwsRedshiftClusterElasticIpStatus) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRedshiftClusterEndpoint

type AwsRedshiftClusterEndpoint struct {

	// The DNS address of the cluster.
	Address *string `type:"string"`

	// The port that the database engine listens on.
	Port *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The connection endpoint for an Amazon Redshift cluster.

func (AwsRedshiftClusterEndpoint) GoString

func (s AwsRedshiftClusterEndpoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRedshiftClusterEndpoint) SetAddress

SetAddress sets the Address field's value.

func (*AwsRedshiftClusterEndpoint) SetPort

SetPort sets the Port field's value.

func (AwsRedshiftClusterEndpoint) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRedshiftClusterHsmStatus

type AwsRedshiftClusterHsmStatus struct {

	// The name of the HSM client certificate that the Amazon Redshift cluster uses
	// to retrieve the data encryption keys that are stored in an HSM.
	HsmClientCertificateIdentifier *string `type:"string"`

	// The name of the HSM configuration that contains the information that the
	// Amazon Redshift cluster can use to retrieve and store keys in an HSM.
	HsmConfigurationIdentifier *string `type:"string"`

	// Indicates whether the Amazon Redshift cluster has finished applying any HSM
	// settings changes specified in a modify cluster command.
	//
	// Type: String
	//
	// Valid values: active | applying
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Information about whether an Amazon Redshift cluster finished applying any hardware changes to security module (HSM) settings that were specified in a modify cluster command.

func (AwsRedshiftClusterHsmStatus) GoString

func (s AwsRedshiftClusterHsmStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRedshiftClusterHsmStatus) SetHsmClientCertificateIdentifier

func (s *AwsRedshiftClusterHsmStatus) SetHsmClientCertificateIdentifier(v string) *AwsRedshiftClusterHsmStatus

SetHsmClientCertificateIdentifier sets the HsmClientCertificateIdentifier field's value.

func (*AwsRedshiftClusterHsmStatus) SetHsmConfigurationIdentifier

func (s *AwsRedshiftClusterHsmStatus) SetHsmConfigurationIdentifier(v string) *AwsRedshiftClusterHsmStatus

SetHsmConfigurationIdentifier sets the HsmConfigurationIdentifier field's value.

func (*AwsRedshiftClusterHsmStatus) SetStatus

SetStatus sets the Status field's value.

func (AwsRedshiftClusterHsmStatus) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRedshiftClusterIamRole

type AwsRedshiftClusterIamRole struct {

	// The status of the IAM role's association with the cluster.
	//
	// Valid values: in-sync | adding | removing
	ApplyStatus *string `type:"string"`

	// The ARN of the IAM role.
	IamRoleArn *string `type:"string"`
	// contains filtered or unexported fields
}

An IAM role that the cluster can use to access other Amazon Web Services services.

func (AwsRedshiftClusterIamRole) GoString

func (s AwsRedshiftClusterIamRole) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRedshiftClusterIamRole) SetApplyStatus

SetApplyStatus sets the ApplyStatus field's value.

func (*AwsRedshiftClusterIamRole) SetIamRoleArn

SetIamRoleArn sets the IamRoleArn field's value.

func (AwsRedshiftClusterIamRole) String

func (s AwsRedshiftClusterIamRole) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRedshiftClusterLoggingStatus added in v1.42.9

type AwsRedshiftClusterLoggingStatus struct {

	// The name of the S3 bucket where the log files are stored.
	BucketName *string `type:"string"`

	// The message indicating that the logs failed to be delivered.
	LastFailureMessage *string `type:"string"`

	// The last time when logs failed to be delivered.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	LastFailureTime *string `type:"string"`

	// The last time that logs were delivered successfully.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	LastSuccessfulDeliveryTime *string `type:"string"`

	// Indicates whether logging is enabled.
	LoggingEnabled *bool `type:"boolean"`

	// Provides the prefix applied to the log file names.
	S3KeyPrefix *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the logging status of the cluster.

func (AwsRedshiftClusterLoggingStatus) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRedshiftClusterLoggingStatus) SetBucketName added in v1.42.9

SetBucketName sets the BucketName field's value.

func (*AwsRedshiftClusterLoggingStatus) SetLastFailureMessage added in v1.42.9

SetLastFailureMessage sets the LastFailureMessage field's value.

func (*AwsRedshiftClusterLoggingStatus) SetLastFailureTime added in v1.42.9

SetLastFailureTime sets the LastFailureTime field's value.

func (*AwsRedshiftClusterLoggingStatus) SetLastSuccessfulDeliveryTime added in v1.42.9

func (s *AwsRedshiftClusterLoggingStatus) SetLastSuccessfulDeliveryTime(v string) *AwsRedshiftClusterLoggingStatus

SetLastSuccessfulDeliveryTime sets the LastSuccessfulDeliveryTime field's value.

func (*AwsRedshiftClusterLoggingStatus) SetLoggingEnabled added in v1.42.9

SetLoggingEnabled sets the LoggingEnabled field's value.

func (*AwsRedshiftClusterLoggingStatus) SetS3KeyPrefix added in v1.42.9

SetS3KeyPrefix sets the S3KeyPrefix field's value.

func (AwsRedshiftClusterLoggingStatus) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRedshiftClusterPendingModifiedValues

type AwsRedshiftClusterPendingModifiedValues struct {

	// The pending or in-progress change to the automated snapshot retention period.
	AutomatedSnapshotRetentionPeriod *int64 `type:"integer"`

	// The pending or in-progress change to the identifier for the cluster.
	ClusterIdentifier *string `type:"string"`

	// The pending or in-progress change to the cluster type.
	ClusterType *string `type:"string"`

	// The pending or in-progress change to the service version.
	ClusterVersion *string `type:"string"`

	// The encryption type for a cluster.
	EncryptionType *string `type:"string"`

	// Indicates whether to create the cluster with enhanced VPC routing enabled.
	EnhancedVpcRouting *bool `type:"boolean"`

	// The name of the maintenance track that the cluster changes to during the
	// next maintenance window.
	MaintenanceTrackName *string `type:"string"`

	// The pending or in-progress change to the master user password for the cluster.
	MasterUserPassword *string `type:"string"`

	// The pending or in-progress change to the cluster's node type.
	NodeType *string `type:"string"`

	// The pending or in-progress change to the number of nodes in the cluster.
	NumberOfNodes *int64 `type:"integer"`

	// The pending or in-progress change to whether the cluster can be connected
	// to from the public network.
	PubliclyAccessible *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Changes to the Amazon Redshift cluster that are currently pending.

func (AwsRedshiftClusterPendingModifiedValues) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRedshiftClusterPendingModifiedValues) SetAutomatedSnapshotRetentionPeriod

SetAutomatedSnapshotRetentionPeriod sets the AutomatedSnapshotRetentionPeriod field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetClusterIdentifier

SetClusterIdentifier sets the ClusterIdentifier field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetClusterType

SetClusterType sets the ClusterType field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetClusterVersion

SetClusterVersion sets the ClusterVersion field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetEncryptionType

SetEncryptionType sets the EncryptionType field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetEnhancedVpcRouting

SetEnhancedVpcRouting sets the EnhancedVpcRouting field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetMaintenanceTrackName

SetMaintenanceTrackName sets the MaintenanceTrackName field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetMasterUserPassword

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetNodeType

SetNodeType sets the NodeType field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetNumberOfNodes

SetNumberOfNodes sets the NumberOfNodes field's value.

func (*AwsRedshiftClusterPendingModifiedValues) SetPubliclyAccessible

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (AwsRedshiftClusterPendingModifiedValues) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRedshiftClusterResizeInfo

type AwsRedshiftClusterResizeInfo struct {

	// Indicates whether the resize operation can be canceled.
	AllowCancelResize *bool `type:"boolean"`

	// The type of resize operation.
	//
	// Valid values: ClassicResize
	ResizeType *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the resize operation for the cluster.

func (AwsRedshiftClusterResizeInfo) GoString

func (s AwsRedshiftClusterResizeInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRedshiftClusterResizeInfo) SetAllowCancelResize

SetAllowCancelResize sets the AllowCancelResize field's value.

func (*AwsRedshiftClusterResizeInfo) SetResizeType

SetResizeType sets the ResizeType field's value.

func (AwsRedshiftClusterResizeInfo) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRedshiftClusterRestoreStatus

type AwsRedshiftClusterRestoreStatus struct {

	// The number of megabytes per second being transferred from the backup storage.
	// Returns the average rate for a completed backup.
	//
	// This field is only updated when you restore to DC2 and DS2 node types.
	CurrentRestoreRateInMegaBytesPerSecond *float64 `type:"double"`

	// The amount of time an in-progress restore has been running, or the amount
	// of time it took a completed restore to finish.
	//
	// This field is only updated when you restore to DC2 and DS2 node types.
	ElapsedTimeInSeconds *int64 `type:"long"`

	// The estimate of the time remaining before the restore is complete. Returns
	// 0 for a completed restore.
	//
	// This field is only updated when you restore to DC2 and DS2 node types.
	EstimatedTimeToCompletionInSeconds *int64 `type:"long"`

	// The number of megabytes that were transferred from snapshot storage.
	//
	// This field is only updated when you restore to DC2 and DS2 node types.
	ProgressInMegaBytes *int64 `type:"long"`

	// The size of the set of snapshot data that was used to restore the cluster.
	//
	// This field is only updated when you restore to DC2 and DS2 node types.
	SnapshotSizeInMegaBytes *int64 `type:"long"`

	// The status of the restore action.
	//
	// Valid values: starting | restoring | completed | failed
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the status of a cluster restore action. It only applies if the cluster was created by restoring a snapshot.

func (AwsRedshiftClusterRestoreStatus) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRedshiftClusterRestoreStatus) SetCurrentRestoreRateInMegaBytesPerSecond

func (s *AwsRedshiftClusterRestoreStatus) SetCurrentRestoreRateInMegaBytesPerSecond(v float64) *AwsRedshiftClusterRestoreStatus

SetCurrentRestoreRateInMegaBytesPerSecond sets the CurrentRestoreRateInMegaBytesPerSecond field's value.

func (*AwsRedshiftClusterRestoreStatus) SetElapsedTimeInSeconds

SetElapsedTimeInSeconds sets the ElapsedTimeInSeconds field's value.

func (*AwsRedshiftClusterRestoreStatus) SetEstimatedTimeToCompletionInSeconds

func (s *AwsRedshiftClusterRestoreStatus) SetEstimatedTimeToCompletionInSeconds(v int64) *AwsRedshiftClusterRestoreStatus

SetEstimatedTimeToCompletionInSeconds sets the EstimatedTimeToCompletionInSeconds field's value.

func (*AwsRedshiftClusterRestoreStatus) SetProgressInMegaBytes

SetProgressInMegaBytes sets the ProgressInMegaBytes field's value.

func (*AwsRedshiftClusterRestoreStatus) SetSnapshotSizeInMegaBytes

func (s *AwsRedshiftClusterRestoreStatus) SetSnapshotSizeInMegaBytes(v int64) *AwsRedshiftClusterRestoreStatus

SetSnapshotSizeInMegaBytes sets the SnapshotSizeInMegaBytes field's value.

func (*AwsRedshiftClusterRestoreStatus) SetStatus

SetStatus sets the Status field's value.

func (AwsRedshiftClusterRestoreStatus) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsRedshiftClusterVpcSecurityGroup

type AwsRedshiftClusterVpcSecurityGroup struct {

	// The status of the VPC security group.
	Status *string `type:"string"`

	// The identifier of the VPC security group.
	VpcSecurityGroupId *string `type:"string"`
	// contains filtered or unexported fields
}

A VPC security group that the cluster belongs to, if the cluster is in a VPC.

func (AwsRedshiftClusterVpcSecurityGroup) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsRedshiftClusterVpcSecurityGroup) SetStatus

SetStatus sets the Status field's value.

func (*AwsRedshiftClusterVpcSecurityGroup) SetVpcSecurityGroupId

SetVpcSecurityGroupId sets the VpcSecurityGroupId field's value.

func (AwsRedshiftClusterVpcSecurityGroup) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3AccountPublicAccessBlockDetails

type AwsS3AccountPublicAccessBlockDetails struct {

	// Indicates whether to reject calls to update an S3 bucket if the calls include
	// a public access control list (ACL).
	BlockPublicAcls *bool `type:"boolean"`

	// Indicates whether to reject calls to update the access policy for an S3 bucket
	// or access point if the policy allows public access.
	BlockPublicPolicy *bool `type:"boolean"`

	// Indicates whether Amazon S3 ignores public ACLs that are associated with
	// an S3 bucket.
	IgnorePublicAcls *bool `type:"boolean"`

	// Indicates whether to restrict access to an access point or S3 bucket that
	// has a public policy to only Amazon Web Services service principals and authorized
	// users within the S3 bucket owner's account.
	RestrictPublicBuckets *bool `type:"boolean"`
	// contains filtered or unexported fields
}

provides information about the Amazon S3 Public Access Block configuration for accounts.

func (AwsS3AccountPublicAccessBlockDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3AccountPublicAccessBlockDetails) SetBlockPublicAcls

SetBlockPublicAcls sets the BlockPublicAcls field's value.

func (*AwsS3AccountPublicAccessBlockDetails) SetBlockPublicPolicy

SetBlockPublicPolicy sets the BlockPublicPolicy field's value.

func (*AwsS3AccountPublicAccessBlockDetails) SetIgnorePublicAcls

SetIgnorePublicAcls sets the IgnorePublicAcls field's value.

func (*AwsS3AccountPublicAccessBlockDetails) SetRestrictPublicBuckets

SetRestrictPublicBuckets sets the RestrictPublicBuckets field's value.

func (AwsS3AccountPublicAccessBlockDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketBucketLifecycleConfigurationDetails

type AwsS3BucketBucketLifecycleConfigurationDetails struct {

	// The lifecycle rules.
	Rules []*AwsS3BucketBucketLifecycleConfigurationRulesDetails `type:"list"`
	// contains filtered or unexported fields
}

The lifecycle configuration for the objects in the S3 bucket.

func (AwsS3BucketBucketLifecycleConfigurationDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketBucketLifecycleConfigurationDetails) SetRules

SetRules sets the Rules field's value.

func (AwsS3BucketBucketLifecycleConfigurationDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails

type AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails struct {

	// The number of days after which Amazon S3 cancels an incomplete multipart
	// upload.
	DaysAfterInitiation *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Information about what Amazon S3 does when a multipart upload is incomplete.

func (AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails) SetDaysAfterInitiation

SetDaysAfterInitiation sets the DaysAfterInitiation field's value.

func (AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketBucketLifecycleConfigurationRulesDetails

type AwsS3BucketBucketLifecycleConfigurationRulesDetails struct {

	// How Amazon S3 responds when a multipart upload is incomplete. Specifically,
	// provides a number of days before Amazon S3 cancels the entire upload.
	AbortIncompleteMultipartUpload *AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails `type:"structure"`

	// The date when objects are moved or deleted.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	ExpirationDate *string `type:"string"`

	// The length in days of the lifetime for objects that are subject to the rule.
	ExpirationInDays *int64 `type:"integer"`

	// Whether Amazon S3 removes a delete marker that has no noncurrent versions.
	// If set to true, the delete marker is expired. If set to false, the policy
	// takes no action.
	//
	// If you provide ExpiredObjectDeleteMarker, you cannot provide ExpirationInDays
	// or ExpirationDate.
	ExpiredObjectDeleteMarker *bool `type:"boolean"`

	// Identifies the objects that a rule applies to.
	Filter *AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails `type:"structure"`

	// The unique identifier of the rule.
	ID *string `type:"string"`

	// The number of days that an object is noncurrent before Amazon S3 can perform
	// the associated action.
	NoncurrentVersionExpirationInDays *int64 `type:"integer"`

	// Transition rules that describe when noncurrent objects transition to a specified
	// storage class.
	NoncurrentVersionTransitions []*AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails `type:"list"`

	// A prefix that identifies one or more objects that the rule applies to.
	Prefix *string `type:"string"`

	// The current status of the rule. Indicates whether the rule is currently being
	// applied.
	Status *string `type:"string"`

	// Transition rules that indicate when objects transition to a specified storage
	// class.
	Transitions []*AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails `type:"list"`
	// contains filtered or unexported fields
}

Configuration for a lifecycle rule.

func (AwsS3BucketBucketLifecycleConfigurationRulesDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetAbortIncompleteMultipartUpload

SetAbortIncompleteMultipartUpload sets the AbortIncompleteMultipartUpload field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetExpirationDate

SetExpirationDate sets the ExpirationDate field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetExpirationInDays

SetExpirationInDays sets the ExpirationInDays field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetExpiredObjectDeleteMarker

SetExpiredObjectDeleteMarker sets the ExpiredObjectDeleteMarker field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetFilter

SetFilter sets the Filter field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetID

SetID sets the ID field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetNoncurrentVersionExpirationInDays

SetNoncurrentVersionExpirationInDays sets the NoncurrentVersionExpirationInDays field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetNoncurrentVersionTransitions

SetNoncurrentVersionTransitions sets the NoncurrentVersionTransitions field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetPrefix

SetPrefix sets the Prefix field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetStatus

SetStatus sets the Status field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetTransitions

SetTransitions sets the Transitions field's value.

func (AwsS3BucketBucketLifecycleConfigurationRulesDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails

type AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails struct {

	// The configuration for the filter.
	Predicate *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails `type:"structure"`
	// contains filtered or unexported fields
}

Identifies the objects that a rule applies to.

func (AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails) SetPredicate

SetPredicate sets the Predicate field's value.

func (AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails

type AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails struct {

	// The values to use for the filter.
	Operands []*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails `type:"list"`

	// A prefix filter.
	Prefix *string `type:"string"`

	// A tag filter.
	Tag *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails `type:"structure"`

	// Whether to use AND or OR to join the operands. Valid values are LifecycleAndOperator
	// or LifecycleOrOperator.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

The configuration for the filter.

func (AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) SetOperands

SetOperands sets the Operands field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) SetPrefix

SetPrefix sets the Prefix field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) SetType

SetType sets the Type field's value.

func (AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails

type AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails struct {

	// Prefix text for matching objects.
	Prefix *string `type:"string"`

	// A tag that is assigned to matching objects.
	Tag *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails `type:"structure"`

	// The type of filter value. Valid values are LifecyclePrefixPredicate or LifecycleTagPredicate.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

A value to use for the filter.

func (AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) SetPrefix

SetPrefix sets the Prefix field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) SetType

SetType sets the Type field's value.

func (AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails

type AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails struct {

	// The tag key.
	Key *string `type:"string"`

	// The tag value.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A tag that is assigned to matching objects.

func (AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails) SetKey

SetKey sets the Key field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails) SetValue

SetValue sets the Value field's value.

func (AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails

type AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails struct {

	// The tag key.
	Key *string `type:"string"`

	// The tag value
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A tag filter.

func (AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails) SetKey

SetKey sets the Key field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails) SetValue

SetValue sets the Value field's value.

func (AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails

type AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails struct {

	// The number of days that an object is noncurrent before Amazon S3 can perform
	// the associated action.
	Days *int64 `type:"integer"`

	// The class of storage to change the object to after the object is noncurrent
	// for the specified number of days.
	StorageClass *string `type:"string"`
	// contains filtered or unexported fields
}

A transition rule that describes when noncurrent objects transition to a specified storage class.

func (AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails) SetDays

SetDays sets the Days field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails) SetStorageClass

SetStorageClass sets the StorageClass field's value.

func (AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails

type AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails struct {

	// A date on which to transition objects to the specified storage class. If
	// you provide Date, you cannot provide Days.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	Date *string `type:"string"`

	// The number of days after which to transition the object to the specified
	// storage class. If you provide Days, you cannot provide Date.
	Days *int64 `type:"integer"`

	// The storage class to transition the object to. Valid values are as follows:
	//
	//    * DEEP_ARCHIVE
	//
	//    * GLACIER
	//
	//    * INTELLIGENT_TIERING
	//
	//    * ONEZONE_IA
	//
	//    * STANDARD_IA
	StorageClass *string `type:"string"`
	// contains filtered or unexported fields
}

A rule for when objects transition to specific storage classes.

func (AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) SetDate

SetDate sets the Date field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) SetDays

SetDays sets the Days field's value.

func (*AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) SetStorageClass

SetStorageClass sets the StorageClass field's value.

func (AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketBucketVersioningConfiguration added in v1.42.9

type AwsS3BucketBucketVersioningConfiguration struct {

	// Specifies whether MFA delete is currently enabled in the S3 bucket versioning
	// configuration. If the S3 bucket was never configured with MFA delete, then
	// this attribute is not included.
	IsMfaDeleteEnabled *bool `type:"boolean"`

	// The versioning status of the S3 bucket. Valid values are Enabled or Suspended.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the versioning state of an S3 bucket.

func (AwsS3BucketBucketVersioningConfiguration) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketBucketVersioningConfiguration) SetIsMfaDeleteEnabled added in v1.42.9

SetIsMfaDeleteEnabled sets the IsMfaDeleteEnabled field's value.

func (*AwsS3BucketBucketVersioningConfiguration) SetStatus added in v1.42.9

SetStatus sets the Status field's value.

func (AwsS3BucketBucketVersioningConfiguration) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketDetails

type AwsS3BucketDetails struct {

	// The access control list for the S3 bucket.
	AccessControlList *string `type:"string"`

	// The lifecycle configuration for objects in the S3 bucket.
	BucketLifecycleConfiguration *AwsS3BucketBucketLifecycleConfigurationDetails `type:"structure"`

	// The logging configuration for the S3 bucket.
	BucketLoggingConfiguration *AwsS3BucketLoggingConfiguration `type:"structure"`

	// The notification configuration for the S3 bucket.
	BucketNotificationConfiguration *AwsS3BucketNotificationConfiguration `type:"structure"`

	// The versioning state of an S3 bucket.
	BucketVersioningConfiguration *AwsS3BucketBucketVersioningConfiguration `type:"structure"`

	// The website configuration parameters for the S3 bucket.
	BucketWebsiteConfiguration *AwsS3BucketWebsiteConfiguration `type:"structure"`

	// Indicates when the S3 bucket was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	CreatedAt *string `type:"string"`

	// Specifies which rule Amazon S3 applies by default to every new object placed
	// in the specified bucket.
	ObjectLockConfiguration *AwsS3BucketObjectLockConfiguration `type:"structure"`

	// The Amazon Web Services account identifier of the account that owns the S3
	// bucket.
	OwnerAccountId *string `type:"string"`

	// The canonical user ID of the owner of the S3 bucket.
	OwnerId *string `type:"string"`

	// The display name of the owner of the S3 bucket.
	OwnerName *string `type:"string"`

	// Provides information about the Amazon S3 Public Access Block configuration
	// for the S3 bucket.
	PublicAccessBlockConfiguration *AwsS3AccountPublicAccessBlockDetails `type:"structure"`

	// The encryption rules that are applied to the S3 bucket.
	ServerSideEncryptionConfiguration *AwsS3BucketServerSideEncryptionConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

The details of an Amazon S3 bucket.

func (AwsS3BucketDetails) GoString

func (s AwsS3BucketDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketDetails) SetAccessControlList

func (s *AwsS3BucketDetails) SetAccessControlList(v string) *AwsS3BucketDetails

SetAccessControlList sets the AccessControlList field's value.

func (*AwsS3BucketDetails) SetBucketLifecycleConfiguration

SetBucketLifecycleConfiguration sets the BucketLifecycleConfiguration field's value.

func (*AwsS3BucketDetails) SetBucketLoggingConfiguration

func (s *AwsS3BucketDetails) SetBucketLoggingConfiguration(v *AwsS3BucketLoggingConfiguration) *AwsS3BucketDetails

SetBucketLoggingConfiguration sets the BucketLoggingConfiguration field's value.

func (*AwsS3BucketDetails) SetBucketNotificationConfiguration

func (s *AwsS3BucketDetails) SetBucketNotificationConfiguration(v *AwsS3BucketNotificationConfiguration) *AwsS3BucketDetails

SetBucketNotificationConfiguration sets the BucketNotificationConfiguration field's value.

func (*AwsS3BucketDetails) SetBucketVersioningConfiguration added in v1.42.9

func (s *AwsS3BucketDetails) SetBucketVersioningConfiguration(v *AwsS3BucketBucketVersioningConfiguration) *AwsS3BucketDetails

SetBucketVersioningConfiguration sets the BucketVersioningConfiguration field's value.

func (*AwsS3BucketDetails) SetBucketWebsiteConfiguration

func (s *AwsS3BucketDetails) SetBucketWebsiteConfiguration(v *AwsS3BucketWebsiteConfiguration) *AwsS3BucketDetails

SetBucketWebsiteConfiguration sets the BucketWebsiteConfiguration field's value.

func (*AwsS3BucketDetails) SetCreatedAt

func (s *AwsS3BucketDetails) SetCreatedAt(v string) *AwsS3BucketDetails

SetCreatedAt sets the CreatedAt field's value.

func (*AwsS3BucketDetails) SetObjectLockConfiguration added in v1.42.9

SetObjectLockConfiguration sets the ObjectLockConfiguration field's value.

func (*AwsS3BucketDetails) SetOwnerAccountId

func (s *AwsS3BucketDetails) SetOwnerAccountId(v string) *AwsS3BucketDetails

SetOwnerAccountId sets the OwnerAccountId field's value.

func (*AwsS3BucketDetails) SetOwnerId

func (s *AwsS3BucketDetails) SetOwnerId(v string) *AwsS3BucketDetails

SetOwnerId sets the OwnerId field's value.

func (*AwsS3BucketDetails) SetOwnerName

func (s *AwsS3BucketDetails) SetOwnerName(v string) *AwsS3BucketDetails

SetOwnerName sets the OwnerName field's value.

func (*AwsS3BucketDetails) SetPublicAccessBlockConfiguration

func (s *AwsS3BucketDetails) SetPublicAccessBlockConfiguration(v *AwsS3AccountPublicAccessBlockDetails) *AwsS3BucketDetails

SetPublicAccessBlockConfiguration sets the PublicAccessBlockConfiguration field's value.

func (*AwsS3BucketDetails) SetServerSideEncryptionConfiguration

func (s *AwsS3BucketDetails) SetServerSideEncryptionConfiguration(v *AwsS3BucketServerSideEncryptionConfiguration) *AwsS3BucketDetails

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (AwsS3BucketDetails) String

func (s AwsS3BucketDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketLoggingConfiguration

type AwsS3BucketLoggingConfiguration struct {

	// The name of the S3 bucket where log files for the S3 bucket are stored.
	DestinationBucketName *string `type:"string"`

	// The prefix added to log files for the S3 bucket.
	LogFilePrefix *string `type:"string"`
	// contains filtered or unexported fields
}

Information about logging for the S3 bucket

func (AwsS3BucketLoggingConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketLoggingConfiguration) SetDestinationBucketName

SetDestinationBucketName sets the DestinationBucketName field's value.

func (*AwsS3BucketLoggingConfiguration) SetLogFilePrefix

SetLogFilePrefix sets the LogFilePrefix field's value.

func (AwsS3BucketLoggingConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketNotificationConfiguration

type AwsS3BucketNotificationConfiguration struct {

	// Configurations for S3 bucket notifications.
	Configurations []*AwsS3BucketNotificationConfigurationDetail `type:"list"`
	// contains filtered or unexported fields
}

The notification configuration for the S3 bucket.

func (AwsS3BucketNotificationConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketNotificationConfiguration) SetConfigurations

SetConfigurations sets the Configurations field's value.

func (AwsS3BucketNotificationConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketNotificationConfigurationDetail

type AwsS3BucketNotificationConfigurationDetail struct {

	// The ARN of the Lambda function, Amazon SQS queue, or Amazon SNS topic that
	// generates the notification.
	Destination *string `type:"string"`

	// The list of events that trigger a notification.
	Events []*string `type:"list"`

	// The filters that determine which S3 buckets generate notifications.
	Filter *AwsS3BucketNotificationConfigurationFilter `type:"structure"`

	// Indicates the type of notification. Notifications can be generated using
	// Lambda functions, Amazon SQS queues, or Amazon SNS topics, with corresponding
	// valid values as follows:
	//
	//    * LambdaConfiguration
	//
	//    * QueueConfiguration
	//
	//    * TopicConfiguration
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Details for an S3 bucket notification configuration.

func (AwsS3BucketNotificationConfigurationDetail) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketNotificationConfigurationDetail) SetDestination

SetDestination sets the Destination field's value.

func (*AwsS3BucketNotificationConfigurationDetail) SetEvents

SetEvents sets the Events field's value.

func (*AwsS3BucketNotificationConfigurationDetail) SetFilter

SetFilter sets the Filter field's value.

func (*AwsS3BucketNotificationConfigurationDetail) SetType

SetType sets the Type field's value.

func (AwsS3BucketNotificationConfigurationDetail) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketNotificationConfigurationFilter

type AwsS3BucketNotificationConfigurationFilter struct {

	// Details for an Amazon S3 filter.
	S3KeyFilter *AwsS3BucketNotificationConfigurationS3KeyFilter `type:"structure"`
	// contains filtered or unexported fields
}

Filtering information for the notifications. The filtering is based on Amazon S3 key names.

func (AwsS3BucketNotificationConfigurationFilter) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketNotificationConfigurationFilter) SetS3KeyFilter

SetS3KeyFilter sets the S3KeyFilter field's value.

func (AwsS3BucketNotificationConfigurationFilter) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketNotificationConfigurationS3KeyFilter

type AwsS3BucketNotificationConfigurationS3KeyFilter struct {

	// The filter rules for the filter.
	FilterRules []*AwsS3BucketNotificationConfigurationS3KeyFilterRule `type:"list"`
	// contains filtered or unexported fields
}

Details for an Amazon S3 filter.

func (AwsS3BucketNotificationConfigurationS3KeyFilter) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketNotificationConfigurationS3KeyFilter) SetFilterRules

SetFilterRules sets the FilterRules field's value.

func (AwsS3BucketNotificationConfigurationS3KeyFilter) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketNotificationConfigurationS3KeyFilterRule

type AwsS3BucketNotificationConfigurationS3KeyFilterRule struct {

	// Indicates whether the filter is based on the prefix or suffix of the Amazon
	// S3 key.
	Name *string `type:"string" enum:"AwsS3BucketNotificationConfigurationS3KeyFilterRuleName"`

	// The filter value.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Details for a filter rule.

func (AwsS3BucketNotificationConfigurationS3KeyFilterRule) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketNotificationConfigurationS3KeyFilterRule) SetName

SetName sets the Name field's value.

func (*AwsS3BucketNotificationConfigurationS3KeyFilterRule) SetValue

SetValue sets the Value field's value.

func (AwsS3BucketNotificationConfigurationS3KeyFilterRule) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketObjectLockConfiguration added in v1.42.9

type AwsS3BucketObjectLockConfiguration struct {

	// Indicates whether the bucket has an Object Lock configuration enabled.
	ObjectLockEnabled *string `type:"string"`

	// Specifies the Object Lock rule for the specified object.
	Rule *AwsS3BucketObjectLockConfigurationRuleDetails `type:"structure"`
	// contains filtered or unexported fields
}

The container element for S3 Object Lock configuration parameters. In Amazon S3, Object Lock can help prevent objects from being deleted or overwritten for a fixed amount of time or indefinitely.

func (AwsS3BucketObjectLockConfiguration) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketObjectLockConfiguration) SetObjectLockEnabled added in v1.42.9

SetObjectLockEnabled sets the ObjectLockEnabled field's value.

func (*AwsS3BucketObjectLockConfiguration) SetRule added in v1.42.9

SetRule sets the Rule field's value.

func (AwsS3BucketObjectLockConfiguration) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails added in v1.42.9

type AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails struct {

	// The number of days that you want to specify for the default retention period.
	Days *int64 `type:"integer"`

	// The default Object Lock retention mode you want to apply to new objects placed
	// in the specified bucket.
	Mode *string `type:"string"`

	// The number of years that you want to specify for the default retention period.
	Years *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The default S3 Object Lock retention mode and period that you want to apply to new objects placed in the specified Amazon S3 bucket.

func (AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) SetDays added in v1.42.9

SetDays sets the Days field's value.

func (*AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) SetMode added in v1.42.9

SetMode sets the Mode field's value.

func (*AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) SetYears added in v1.42.9

SetYears sets the Years field's value.

func (AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketObjectLockConfigurationRuleDetails added in v1.42.9

type AwsS3BucketObjectLockConfigurationRuleDetails struct {

	// The default Object Lock retention mode and period that you want to apply
	// to new objects placed in the specified bucket.
	DefaultRetention *AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the S3 Object Lock rule for the specified object. In Amazon S3, Object Lock can help prevent objects from being deleted or overwritten for a fixed amount of time or indefinitely.

func (AwsS3BucketObjectLockConfigurationRuleDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketObjectLockConfigurationRuleDetails) SetDefaultRetention added in v1.42.9

SetDefaultRetention sets the DefaultRetention field's value.

func (AwsS3BucketObjectLockConfigurationRuleDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketServerSideEncryptionByDefault

type AwsS3BucketServerSideEncryptionByDefault struct {

	// KMS key ID to use for the default encryption.
	KMSMasterKeyID *string `type:"string"`

	// Server-side encryption algorithm to use for the default encryption. Valid
	// values are aws: kms or AES256.
	SSEAlgorithm *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies the default server-side encryption to apply to new objects in the bucket.

func (AwsS3BucketServerSideEncryptionByDefault) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketServerSideEncryptionByDefault) SetKMSMasterKeyID

SetKMSMasterKeyID sets the KMSMasterKeyID field's value.

func (*AwsS3BucketServerSideEncryptionByDefault) SetSSEAlgorithm

SetSSEAlgorithm sets the SSEAlgorithm field's value.

func (AwsS3BucketServerSideEncryptionByDefault) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketServerSideEncryptionConfiguration

type AwsS3BucketServerSideEncryptionConfiguration struct {

	// The encryption rules that are applied to the S3 bucket.
	Rules []*AwsS3BucketServerSideEncryptionRule `type:"list"`
	// contains filtered or unexported fields
}

The encryption configuration for the S3 bucket.

func (AwsS3BucketServerSideEncryptionConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketServerSideEncryptionConfiguration) SetRules

SetRules sets the Rules field's value.

func (AwsS3BucketServerSideEncryptionConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketServerSideEncryptionRule

type AwsS3BucketServerSideEncryptionRule struct {

	// Specifies the default server-side encryption to apply to new objects in the
	// bucket. If a PUT object request doesn't specify any server-side encryption,
	// this default encryption is applied.
	ApplyServerSideEncryptionByDefault *AwsS3BucketServerSideEncryptionByDefault `type:"structure"`
	// contains filtered or unexported fields
}

An encryption rule to apply to the S3 bucket.

func (AwsS3BucketServerSideEncryptionRule) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketServerSideEncryptionRule) SetApplyServerSideEncryptionByDefault

SetApplyServerSideEncryptionByDefault sets the ApplyServerSideEncryptionByDefault field's value.

func (AwsS3BucketServerSideEncryptionRule) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketWebsiteConfiguration

type AwsS3BucketWebsiteConfiguration struct {

	// The name of the error document for the website.
	ErrorDocument *string `type:"string"`

	// The name of the index document for the website.
	IndexDocumentSuffix *string `type:"string"`

	// The redirect behavior for requests to the website.
	RedirectAllRequestsTo *AwsS3BucketWebsiteConfigurationRedirectTo `type:"structure"`

	// The rules for applying redirects for requests to the website.
	RoutingRules []*AwsS3BucketWebsiteConfigurationRoutingRule `type:"list"`
	// contains filtered or unexported fields
}

Website parameters for the S3 bucket.

func (AwsS3BucketWebsiteConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketWebsiteConfiguration) SetErrorDocument

SetErrorDocument sets the ErrorDocument field's value.

func (*AwsS3BucketWebsiteConfiguration) SetIndexDocumentSuffix

SetIndexDocumentSuffix sets the IndexDocumentSuffix field's value.

func (*AwsS3BucketWebsiteConfiguration) SetRedirectAllRequestsTo

SetRedirectAllRequestsTo sets the RedirectAllRequestsTo field's value.

func (*AwsS3BucketWebsiteConfiguration) SetRoutingRules

SetRoutingRules sets the RoutingRules field's value.

func (AwsS3BucketWebsiteConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketWebsiteConfigurationRedirectTo

type AwsS3BucketWebsiteConfigurationRedirectTo struct {

	// The name of the host to redirect requests to.
	Hostname *string `type:"string"`

	// The protocol to use when redirecting requests. By default, this field uses
	// the same protocol as the original request. Valid values are http or https.
	Protocol *string `type:"string"`
	// contains filtered or unexported fields
}

The redirect behavior for requests to the website.

func (AwsS3BucketWebsiteConfigurationRedirectTo) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketWebsiteConfigurationRedirectTo) SetHostname

SetHostname sets the Hostname field's value.

func (*AwsS3BucketWebsiteConfigurationRedirectTo) SetProtocol

SetProtocol sets the Protocol field's value.

func (AwsS3BucketWebsiteConfigurationRedirectTo) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketWebsiteConfigurationRoutingRule

type AwsS3BucketWebsiteConfigurationRoutingRule struct {

	// Provides the condition that must be met in order to apply the routing rule.
	Condition *AwsS3BucketWebsiteConfigurationRoutingRuleCondition `type:"structure"`

	// Provides the rules to redirect the request if the condition in Condition
	// is met.
	Redirect *AwsS3BucketWebsiteConfigurationRoutingRuleRedirect `type:"structure"`
	// contains filtered or unexported fields
}

A rule for redirecting requests to the website.

func (AwsS3BucketWebsiteConfigurationRoutingRule) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketWebsiteConfigurationRoutingRule) SetCondition

SetCondition sets the Condition field's value.

func (*AwsS3BucketWebsiteConfigurationRoutingRule) SetRedirect

SetRedirect sets the Redirect field's value.

func (AwsS3BucketWebsiteConfigurationRoutingRule) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketWebsiteConfigurationRoutingRuleCondition

type AwsS3BucketWebsiteConfigurationRoutingRuleCondition struct {

	// Indicates to redirect the request if the HTTP error code matches this value.
	HttpErrorCodeReturnedEquals *string `type:"string"`

	// Indicates to redirect the request if the key prefix matches this value.
	KeyPrefixEquals *string `type:"string"`
	// contains filtered or unexported fields
}

The condition that must be met in order to apply the routing rule.

func (AwsS3BucketWebsiteConfigurationRoutingRuleCondition) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketWebsiteConfigurationRoutingRuleCondition) SetHttpErrorCodeReturnedEquals

SetHttpErrorCodeReturnedEquals sets the HttpErrorCodeReturnedEquals field's value.

func (*AwsS3BucketWebsiteConfigurationRoutingRuleCondition) SetKeyPrefixEquals

SetKeyPrefixEquals sets the KeyPrefixEquals field's value.

func (AwsS3BucketWebsiteConfigurationRoutingRuleCondition) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3BucketWebsiteConfigurationRoutingRuleRedirect

type AwsS3BucketWebsiteConfigurationRoutingRuleRedirect struct {

	// The host name to use in the redirect request.
	Hostname *string `type:"string"`

	// The HTTP redirect code to use in the response.
	HttpRedirectCode *string `type:"string"`

	// The protocol to use to redirect the request. By default, uses the protocol
	// from the original request.
	Protocol *string `type:"string"`

	// The object key prefix to use in the redirect request.
	//
	// Cannot be provided if ReplaceKeyWith is present.
	ReplaceKeyPrefixWith *string `type:"string"`

	// The specific object key to use in the redirect request.
	//
	// Cannot be provided if ReplaceKeyPrefixWith is present.
	ReplaceKeyWith *string `type:"string"`
	// contains filtered or unexported fields
}

The rules to redirect the request if the condition in Condition is met.

func (AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) SetHostname

SetHostname sets the Hostname field's value.

func (*AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) SetHttpRedirectCode

SetHttpRedirectCode sets the HttpRedirectCode field's value.

func (*AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) SetProtocol

SetProtocol sets the Protocol field's value.

func (*AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) SetReplaceKeyPrefixWith

SetReplaceKeyPrefixWith sets the ReplaceKeyPrefixWith field's value.

func (*AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) SetReplaceKeyWith

SetReplaceKeyWith sets the ReplaceKeyWith field's value.

func (AwsS3BucketWebsiteConfigurationRoutingRuleRedirect) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsS3ObjectDetails

type AwsS3ObjectDetails struct {

	// A standard MIME type describing the format of the object data.
	ContentType *string `type:"string"`

	// The opaque identifier assigned by a web server to a specific version of a
	// resource found at a URL.
	ETag *string `type:"string"`

	// Indicates when the object was last modified.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	LastModified *string `type:"string"`

	// The identifier of the KMS symmetric customer managed key that was used for
	// the object.
	SSEKMSKeyId *string `type:"string"`

	// If the object is stored using server-side encryption, the value of the server-side
	// encryption algorithm used when storing this object in Amazon S3.
	ServerSideEncryption *string `type:"string"`

	// The version of the object.
	VersionId *string `type:"string"`
	// contains filtered or unexported fields
}

Details about an Amazon S3 object.

func (AwsS3ObjectDetails) GoString

func (s AwsS3ObjectDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsS3ObjectDetails) SetContentType

func (s *AwsS3ObjectDetails) SetContentType(v string) *AwsS3ObjectDetails

SetContentType sets the ContentType field's value.

func (*AwsS3ObjectDetails) SetETag

SetETag sets the ETag field's value.

func (*AwsS3ObjectDetails) SetLastModified

func (s *AwsS3ObjectDetails) SetLastModified(v string) *AwsS3ObjectDetails

SetLastModified sets the LastModified field's value.

func (*AwsS3ObjectDetails) SetSSEKMSKeyId

func (s *AwsS3ObjectDetails) SetSSEKMSKeyId(v string) *AwsS3ObjectDetails

SetSSEKMSKeyId sets the SSEKMSKeyId field's value.

func (*AwsS3ObjectDetails) SetServerSideEncryption

func (s *AwsS3ObjectDetails) SetServerSideEncryption(v string) *AwsS3ObjectDetails

SetServerSideEncryption sets the ServerSideEncryption field's value.

func (*AwsS3ObjectDetails) SetVersionId

func (s *AwsS3ObjectDetails) SetVersionId(v string) *AwsS3ObjectDetails

SetVersionId sets the VersionId field's value.

func (AwsS3ObjectDetails) String

func (s AwsS3ObjectDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsSageMakerNotebookInstanceDetails added in v1.42.9

type AwsSageMakerNotebookInstanceDetails struct {

	// A list of Amazon Elastic Inference instance types to associate with the notebook
	// instance. Currently, only one instance type can be associated with a notebook
	// instance.
	AcceleratorTypes []*string `type:"list"`

	// An array of up to three Git repositories associated with the notebook instance.
	// These can be either the names of Git repositories stored as resources in
	// your account, or the URL of Git repositories in CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html)
	// or in any other Git repository. These repositories are cloned at the same
	// level as the default repository of your notebook instance. For more information,
	// see Associating Git repositories with SageMaker notebook instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html)
	// in the Amazon SageMaker Developer Guide.
	AdditionalCodeRepositories []*string `type:"list"`

	// The Git repository associated with the notebook instance as its default code
	// repository. This can be either the name of a Git repository stored as a resource
	// in your account, or the URL of a Git repository in CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html)
	// or in any other Git repository. When you open a notebook instance, it opens
	// in the directory that contains this repository. For more information, see
	// Associating Git repositories with SageMaker notebook instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html)
	// in the Amazon SageMaker Developer Guide.
	DefaultCodeRepository *string `type:"string"`

	// Sets whether SageMaker provides internet access to the notebook instance.
	// If you set this to Disabled, this notebook instance is able to access resources
	// only in your VPC, and is not be able to connect to SageMaker training and
	// endpoint services unless you configure a Network Address Translation (NAT)
	// Gateway in your VPC.
	DirectInternetAccess *string `type:"string"`

	// If status of the instance is Failed, the reason it failed.
	FailureReason *string `type:"string"`

	// Information on the IMDS configuration of the notebook instance.
	InstanceMetadataServiceConfiguration *AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails `type:"structure"`

	// The type of machine learning (ML) compute instance to launch for the notebook
	// instance.
	InstanceType *string `type:"string"`

	// The Amazon Resource Name (ARN) of an Key Management Service (KMS) key that
	// SageMaker uses to encrypt data on the storage volume attached to your notebook
	// instance. The KMS key you provide must be enabled. For information, see Enabling
	// and disabling keys (https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html)
	// in the Key Management Service Developer Guide.
	KmsKeyId *string `type:"string"`

	// The network interface ID that SageMaker created when the instance was created.
	NetworkInterfaceId *string `type:"string"`

	// The Amazon Resource Name (ARN) of the notebook instance.
	NotebookInstanceArn *string `type:"string"`

	// The name of a notebook instance lifecycle configuration.
	NotebookInstanceLifecycleConfigName *string `type:"string"`

	// The name of the new notebook instance.
	NotebookInstanceName *string `type:"string"`

	// The status of the notebook instance.
	NotebookInstanceStatus *string `type:"string"`

	// The platform identifier of the notebook instance runtime environment.
	PlatformIdentifier *string `type:"string"`

	// The Amazon Resource Name (ARN) of the IAM role associated with the instance.
	RoleArn *string `type:"string"`

	// Whether root access is enabled or disabled for users of the notebook instance.
	RootAccess *string `type:"string"`

	// The VPC security group IDs.
	SecurityGroups []*string `type:"list"`

	// The ID of the VPC subnet to which you have a connectivity from your ML compute
	// instance.
	SubnetId *string `type:"string"`

	// The URL that you use to connect to the Jupyter notebook that is running in
	// your notebook instance.
	Url *string `type:"string"`

	// The size, in GB, of the ML storage volume to attach to the notebook instance.
	VolumeSizeInGB *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides details about an Amazon SageMaker notebook instance.

func (AwsSageMakerNotebookInstanceDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsSageMakerNotebookInstanceDetails) SetAcceleratorTypes added in v1.42.9

SetAcceleratorTypes sets the AcceleratorTypes field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetAdditionalCodeRepositories added in v1.42.9

func (s *AwsSageMakerNotebookInstanceDetails) SetAdditionalCodeRepositories(v []*string) *AwsSageMakerNotebookInstanceDetails

SetAdditionalCodeRepositories sets the AdditionalCodeRepositories field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetDefaultCodeRepository added in v1.42.9

SetDefaultCodeRepository sets the DefaultCodeRepository field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetDirectInternetAccess added in v1.42.9

SetDirectInternetAccess sets the DirectInternetAccess field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetFailureReason added in v1.42.9

SetFailureReason sets the FailureReason field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetInstanceMetadataServiceConfiguration added in v1.42.9

SetInstanceMetadataServiceConfiguration sets the InstanceMetadataServiceConfiguration field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetInstanceType added in v1.42.9

SetInstanceType sets the InstanceType field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetKmsKeyId added in v1.42.9

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetNetworkInterfaceId added in v1.42.9

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetNotebookInstanceArn added in v1.42.9

SetNotebookInstanceArn sets the NotebookInstanceArn field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetNotebookInstanceLifecycleConfigName added in v1.42.9

func (s *AwsSageMakerNotebookInstanceDetails) SetNotebookInstanceLifecycleConfigName(v string) *AwsSageMakerNotebookInstanceDetails

SetNotebookInstanceLifecycleConfigName sets the NotebookInstanceLifecycleConfigName field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetNotebookInstanceName added in v1.42.9

SetNotebookInstanceName sets the NotebookInstanceName field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetNotebookInstanceStatus added in v1.42.9

SetNotebookInstanceStatus sets the NotebookInstanceStatus field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetPlatformIdentifier added in v1.42.9

SetPlatformIdentifier sets the PlatformIdentifier field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetRoleArn added in v1.42.9

SetRoleArn sets the RoleArn field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetRootAccess added in v1.42.9

SetRootAccess sets the RootAccess field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetSecurityGroups added in v1.42.9

SetSecurityGroups sets the SecurityGroups field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetSubnetId added in v1.42.9

SetSubnetId sets the SubnetId field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetUrl added in v1.42.9

SetUrl sets the Url field's value.

func (*AwsSageMakerNotebookInstanceDetails) SetVolumeSizeInGB added in v1.42.9

SetVolumeSizeInGB sets the VolumeSizeInGB field's value.

func (AwsSageMakerNotebookInstanceDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails added in v1.42.9

type AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails struct {

	// Indicates the minimum IMDS version that the notebook instance supports.
	MinimumInstanceMetadataServiceVersion *string `type:"string"`
	// contains filtered or unexported fields
}

Information on the instance metadata service (IMDS) configuration of the notebook instance.

func (AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails) SetMinimumInstanceMetadataServiceVersion added in v1.42.9

SetMinimumInstanceMetadataServiceVersion sets the MinimumInstanceMetadataServiceVersion field's value.

func (AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsSecretsManagerSecretDetails

type AwsSecretsManagerSecretDetails struct {

	// Whether the secret is deleted.
	Deleted *bool `type:"boolean"`

	// The user-provided description of the secret.
	Description *string `type:"string"`

	// The ARN, Key ID, or alias of the KMS key used to encrypt the SecretString
	// or SecretBinary values for versions of this secret.
	KmsKeyId *string `type:"string"`

	// The name of the secret.
	Name *string `type:"string"`

	// Whether rotation is enabled.
	RotationEnabled *bool `type:"boolean"`

	// The ARN of the Lambda function that rotates the secret.
	RotationLambdaArn *string `type:"string"`

	// Whether the rotation occurred within the specified rotation frequency.
	RotationOccurredWithinFrequency *bool `type:"boolean"`

	// Defines the rotation schedule for the secret.
	RotationRules *AwsSecretsManagerSecretRotationRules `type:"structure"`
	// contains filtered or unexported fields
}

Details about an Secrets Manager secret.

func (AwsSecretsManagerSecretDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsSecretsManagerSecretDetails) SetDeleted

SetDeleted sets the Deleted field's value.

func (*AwsSecretsManagerSecretDetails) SetDescription

SetDescription sets the Description field's value.

func (*AwsSecretsManagerSecretDetails) SetKmsKeyId

SetKmsKeyId sets the KmsKeyId field's value.

func (*AwsSecretsManagerSecretDetails) SetName

SetName sets the Name field's value.

func (*AwsSecretsManagerSecretDetails) SetRotationEnabled

SetRotationEnabled sets the RotationEnabled field's value.

func (*AwsSecretsManagerSecretDetails) SetRotationLambdaArn

SetRotationLambdaArn sets the RotationLambdaArn field's value.

func (*AwsSecretsManagerSecretDetails) SetRotationOccurredWithinFrequency

func (s *AwsSecretsManagerSecretDetails) SetRotationOccurredWithinFrequency(v bool) *AwsSecretsManagerSecretDetails

SetRotationOccurredWithinFrequency sets the RotationOccurredWithinFrequency field's value.

func (*AwsSecretsManagerSecretDetails) SetRotationRules

SetRotationRules sets the RotationRules field's value.

func (AwsSecretsManagerSecretDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsSecretsManagerSecretRotationRules

type AwsSecretsManagerSecretRotationRules struct {

	// The number of days after the previous rotation to rotate the secret.
	AutomaticallyAfterDays *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Defines the rotation schedule for the secret.

func (AwsSecretsManagerSecretRotationRules) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsSecretsManagerSecretRotationRules) SetAutomaticallyAfterDays

SetAutomaticallyAfterDays sets the AutomaticallyAfterDays field's value.

func (AwsSecretsManagerSecretRotationRules) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsSecurityFinding

type AwsSecurityFinding struct {

	// Provides details about an action that affects or that was taken on a resource.
	Action *Action `type:"structure"`

	// The Amazon Web Services account ID that a finding is generated in.
	//
	// AwsAccountId is a required field
	AwsAccountId *string `type:"string" required:"true"`

	// The name of the company for the product that generated the finding.
	//
	// Security Hub populates this attribute automatically for each finding. You
	// cannot update this attribute with BatchImportFindings or BatchUpdateFindings.
	// The exception to this is a custom integration.
	//
	// When you use the Security Hub console or API to filter findings by company
	// name, you use this attribute.
	CompanyName *string `type:"string"`

	// This data type is exclusive to findings that are generated as the result
	// of a check run against a specific rule in a supported security standard,
	// such as CIS Amazon Web Services Foundations. Contains security standard-related
	// finding details.
	Compliance *Compliance `type:"structure"`

	// A finding's confidence. Confidence is defined as the likelihood that a finding
	// accurately identifies the behavior or issue that it was intended to identify.
	//
	// Confidence is scored on a 0-100 basis using a ratio scale, where 0 means
	// zero percent confidence and 100 means 100 percent confidence.
	Confidence *int64 `type:"integer"`

	// Indicates when the security findings provider created the potential security
	// issue that a finding captured.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	//
	// CreatedAt is a required field
	CreatedAt *string `type:"string" required:"true"`

	// The level of importance assigned to the resources associated with the finding.
	//
	// A score of 0 means that the underlying resources have no criticality, and
	// a score of 100 is reserved for the most critical resources.
	Criticality *int64 `type:"integer"`

	// A finding's description.
	//
	// In this release, Description is a required property.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// In a BatchImportFindings request, finding providers use FindingProviderFields
	// to provide and update their own values for confidence, criticality, related
	// findings, severity, and types.
	FindingProviderFields *FindingProviderFields `type:"structure"`

	// Indicates when the security findings provider first observed the potential
	// security issue that a finding captured.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	FirstObservedAt *string `type:"string"`

	// The identifier for the solution-specific component (a discrete unit of logic)
	// that generated a finding. In various security findings providers' solutions,
	// this generator can be called a rule, a check, a detector, a plugin, etc.
	//
	// GeneratorId is a required field
	GeneratorId *string `type:"string" required:"true"`

	// The security findings provider-specific identifier for a finding.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// Indicates when the security findings provider most recently observed the
	// potential security issue that a finding captured.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	LastObservedAt *string `type:"string"`

	// A list of malware related to a finding.
	Malware []*Malware `type:"list"`

	// The details of network-related information about a finding.
	Network *Network `type:"structure"`

	// Provides information about a network path that is relevant to a finding.
	// Each entry under NetworkPath represents a component of that path.
	NetworkPath []*NetworkPathComponent `type:"list"`

	// A user-defined note added to a finding.
	Note *Note `type:"structure"`

	// Provides an overview of the patch compliance status for an instance against
	// a selected compliance standard.
	PatchSummary *PatchSummary `type:"structure"`

	// The details of process-related information about a finding.
	Process *ProcessDetails `type:"structure"`

	// The ARN generated by Security Hub that uniquely identifies a product that
	// generates findings. This can be the ARN for a third-party product that is
	// integrated with Security Hub, or the ARN for a custom integration.
	//
	// ProductArn is a required field
	ProductArn *string `type:"string" required:"true"`

	// A data type where security findings providers can include additional solution-specific
	// details that aren't part of the defined AwsSecurityFinding format.
	//
	// Can contain up to 50 key-value pairs. For each key-value pair, the key can
	// contain up to 128 characters, and the value can contain up to 2048 characters.
	ProductFields map[string]*string `type:"map"`

	// The name of the product that generated the finding.
	//
	// Security Hub populates this attribute automatically for each finding. You
	// cannot update this attribute with BatchImportFindings or BatchUpdateFindings.
	// The exception to this is a custom integration.
	//
	// When you use the Security Hub console or API to filter findings by product
	// name, you use this attribute.
	ProductName *string `type:"string"`

	// The record state of a finding.
	RecordState *string `type:"string" enum:"RecordState"`

	// The Region from which the finding was generated.
	//
	// Security Hub populates this attribute automatically for each finding. You
	// cannot update it using BatchImportFindings or BatchUpdateFindings.
	Region *string `type:"string"`

	// A list of related findings.
	RelatedFindings []*RelatedFinding `type:"list"`

	// A data type that describes the remediation options for a finding.
	Remediation *Remediation `type:"structure"`

	// A set of resource data types that describe the resources that the finding
	// refers to.
	//
	// Resources is a required field
	Resources []*Resource `type:"list" required:"true"`

	// Indicates whether the finding is a sample finding.
	Sample *bool `type:"boolean"`

	// The schema version that a finding is formatted for.
	//
	// SchemaVersion is a required field
	SchemaVersion *string `type:"string" required:"true"`

	// A finding's severity.
	Severity *Severity `type:"structure"`

	// A URL that links to a page about the current finding in the security findings
	// provider's solution.
	SourceUrl *string `type:"string"`

	// Threat intelligence details related to a finding.
	ThreatIntelIndicators []*ThreatIntelIndicator `type:"list"`

	// Details about the threat detected in a security finding and the file paths
	// that were affected by the threat.
	Threats []*Threat `type:"list"`

	// A finding's title.
	//
	// In this release, Title is a required property.
	//
	// Title is a required field
	Title *string `type:"string" required:"true"`

	// One or more finding types in the format of namespace/category/classifier
	// that classify a finding.
	//
	// Valid namespace values are: Software and Configuration Checks | TTPs | Effects
	// | Unusual Behaviors | Sensitive Data Identifications
	Types []*string `type:"list"`

	// Indicates when the security findings provider last updated the finding record.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	//
	// UpdatedAt is a required field
	UpdatedAt *string `type:"string" required:"true"`

	// A list of name/value string pairs associated with the finding. These are
	// custom, user-defined fields added to a finding.
	UserDefinedFields map[string]*string `type:"map"`

	// Indicates the veracity of a finding.
	VerificationState *string `type:"string" enum:"VerificationState"`

	// Provides a list of vulnerabilities associated with the findings.
	Vulnerabilities []*Vulnerability `type:"list"`

	// Provides information about the status of the investigation into a finding.
	Workflow *Workflow `type:"structure"`

	// The workflow state of a finding.
	WorkflowState *string `deprecated:"true" type:"string" enum:"WorkflowState"`
	// contains filtered or unexported fields
}

Provides a consistent format for Security Hub findings. AwsSecurityFinding format allows you to share findings between Amazon Web Services security services and third-party solutions.

A finding is a potential security issue generated either by Amazon Web Services services or by the integrated third-party solutions and standards checks.

func (AwsSecurityFinding) GoString

func (s AwsSecurityFinding) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsSecurityFinding) SetAction

func (s *AwsSecurityFinding) SetAction(v *Action) *AwsSecurityFinding

SetAction sets the Action field's value.

func (*AwsSecurityFinding) SetAwsAccountId

func (s *AwsSecurityFinding) SetAwsAccountId(v string) *AwsSecurityFinding

SetAwsAccountId sets the AwsAccountId field's value.

func (*AwsSecurityFinding) SetCompanyName

func (s *AwsSecurityFinding) SetCompanyName(v string) *AwsSecurityFinding

SetCompanyName sets the CompanyName field's value.

func (*AwsSecurityFinding) SetCompliance

func (s *AwsSecurityFinding) SetCompliance(v *Compliance) *AwsSecurityFinding

SetCompliance sets the Compliance field's value.

func (*AwsSecurityFinding) SetConfidence

func (s *AwsSecurityFinding) SetConfidence(v int64) *AwsSecurityFinding

SetConfidence sets the Confidence field's value.

func (*AwsSecurityFinding) SetCreatedAt

func (s *AwsSecurityFinding) SetCreatedAt(v string) *AwsSecurityFinding

SetCreatedAt sets the CreatedAt field's value.

func (*AwsSecurityFinding) SetCriticality

func (s *AwsSecurityFinding) SetCriticality(v int64) *AwsSecurityFinding

SetCriticality sets the Criticality field's value.

func (*AwsSecurityFinding) SetDescription

func (s *AwsSecurityFinding) SetDescription(v string) *AwsSecurityFinding

SetDescription sets the Description field's value.

func (*AwsSecurityFinding) SetFindingProviderFields

func (s *AwsSecurityFinding) SetFindingProviderFields(v *FindingProviderFields) *AwsSecurityFinding

SetFindingProviderFields sets the FindingProviderFields field's value.

func (*AwsSecurityFinding) SetFirstObservedAt

func (s *AwsSecurityFinding) SetFirstObservedAt(v string) *AwsSecurityFinding

SetFirstObservedAt sets the FirstObservedAt field's value.

func (*AwsSecurityFinding) SetGeneratorId

func (s *AwsSecurityFinding) SetGeneratorId(v string) *AwsSecurityFinding

SetGeneratorId sets the GeneratorId field's value.

func (*AwsSecurityFinding) SetId

SetId sets the Id field's value.

func (*AwsSecurityFinding) SetLastObservedAt

func (s *AwsSecurityFinding) SetLastObservedAt(v string) *AwsSecurityFinding

SetLastObservedAt sets the LastObservedAt field's value.

func (*AwsSecurityFinding) SetMalware

func (s *AwsSecurityFinding) SetMalware(v []*Malware) *AwsSecurityFinding

SetMalware sets the Malware field's value.

func (*AwsSecurityFinding) SetNetwork

func (s *AwsSecurityFinding) SetNetwork(v *Network) *AwsSecurityFinding

SetNetwork sets the Network field's value.

func (*AwsSecurityFinding) SetNetworkPath

SetNetworkPath sets the NetworkPath field's value.

func (*AwsSecurityFinding) SetNote

func (s *AwsSecurityFinding) SetNote(v *Note) *AwsSecurityFinding

SetNote sets the Note field's value.

func (*AwsSecurityFinding) SetPatchSummary

func (s *AwsSecurityFinding) SetPatchSummary(v *PatchSummary) *AwsSecurityFinding

SetPatchSummary sets the PatchSummary field's value.

func (*AwsSecurityFinding) SetProcess

SetProcess sets the Process field's value.

func (*AwsSecurityFinding) SetProductArn

func (s *AwsSecurityFinding) SetProductArn(v string) *AwsSecurityFinding

SetProductArn sets the ProductArn field's value.

func (*AwsSecurityFinding) SetProductFields

func (s *AwsSecurityFinding) SetProductFields(v map[string]*string) *AwsSecurityFinding

SetProductFields sets the ProductFields field's value.

func (*AwsSecurityFinding) SetProductName

func (s *AwsSecurityFinding) SetProductName(v string) *AwsSecurityFinding

SetProductName sets the ProductName field's value.

func (*AwsSecurityFinding) SetRecordState

func (s *AwsSecurityFinding) SetRecordState(v string) *AwsSecurityFinding

SetRecordState sets the RecordState field's value.

func (*AwsSecurityFinding) SetRegion

func (s *AwsSecurityFinding) SetRegion(v string) *AwsSecurityFinding

SetRegion sets the Region field's value.

func (*AwsSecurityFinding) SetRelatedFindings

func (s *AwsSecurityFinding) SetRelatedFindings(v []*RelatedFinding) *AwsSecurityFinding

SetRelatedFindings sets the RelatedFindings field's value.

func (*AwsSecurityFinding) SetRemediation

func (s *AwsSecurityFinding) SetRemediation(v *Remediation) *AwsSecurityFinding

SetRemediation sets the Remediation field's value.

func (*AwsSecurityFinding) SetResources

func (s *AwsSecurityFinding) SetResources(v []*Resource) *AwsSecurityFinding

SetResources sets the Resources field's value.

func (*AwsSecurityFinding) SetSample added in v1.42.9

func (s *AwsSecurityFinding) SetSample(v bool) *AwsSecurityFinding

SetSample sets the Sample field's value.

func (*AwsSecurityFinding) SetSchemaVersion

func (s *AwsSecurityFinding) SetSchemaVersion(v string) *AwsSecurityFinding

SetSchemaVersion sets the SchemaVersion field's value.

func (*AwsSecurityFinding) SetSeverity

func (s *AwsSecurityFinding) SetSeverity(v *Severity) *AwsSecurityFinding

SetSeverity sets the Severity field's value.

func (*AwsSecurityFinding) SetSourceUrl

func (s *AwsSecurityFinding) SetSourceUrl(v string) *AwsSecurityFinding

SetSourceUrl sets the SourceUrl field's value.

func (*AwsSecurityFinding) SetThreatIntelIndicators

func (s *AwsSecurityFinding) SetThreatIntelIndicators(v []*ThreatIntelIndicator) *AwsSecurityFinding

SetThreatIntelIndicators sets the ThreatIntelIndicators field's value.

func (*AwsSecurityFinding) SetThreats added in v1.42.9

func (s *AwsSecurityFinding) SetThreats(v []*Threat) *AwsSecurityFinding

SetThreats sets the Threats field's value.

func (*AwsSecurityFinding) SetTitle

SetTitle sets the Title field's value.

func (*AwsSecurityFinding) SetTypes

func (s *AwsSecurityFinding) SetTypes(v []*string) *AwsSecurityFinding

SetTypes sets the Types field's value.

func (*AwsSecurityFinding) SetUpdatedAt

func (s *AwsSecurityFinding) SetUpdatedAt(v string) *AwsSecurityFinding

SetUpdatedAt sets the UpdatedAt field's value.

func (*AwsSecurityFinding) SetUserDefinedFields

func (s *AwsSecurityFinding) SetUserDefinedFields(v map[string]*string) *AwsSecurityFinding

SetUserDefinedFields sets the UserDefinedFields field's value.

func (*AwsSecurityFinding) SetVerificationState

func (s *AwsSecurityFinding) SetVerificationState(v string) *AwsSecurityFinding

SetVerificationState sets the VerificationState field's value.

func (*AwsSecurityFinding) SetVulnerabilities

func (s *AwsSecurityFinding) SetVulnerabilities(v []*Vulnerability) *AwsSecurityFinding

SetVulnerabilities sets the Vulnerabilities field's value.

func (*AwsSecurityFinding) SetWorkflow

func (s *AwsSecurityFinding) SetWorkflow(v *Workflow) *AwsSecurityFinding

SetWorkflow sets the Workflow field's value.

func (*AwsSecurityFinding) SetWorkflowState

func (s *AwsSecurityFinding) SetWorkflowState(v string) *AwsSecurityFinding

SetWorkflowState sets the WorkflowState field's value.

func (AwsSecurityFinding) String

func (s AwsSecurityFinding) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsSecurityFinding) Validate

func (s *AwsSecurityFinding) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AwsSecurityFindingFilters

type AwsSecurityFindingFilters struct {

	// The Amazon Web Services account ID that a finding is generated in.
	AwsAccountId []*StringFilter `type:"list"`

	// The name of the findings provider (company) that owns the solution (product)
	// that generates findings.
	CompanyName []*StringFilter `type:"list"`

	// The unique identifier of a standard in which a control is enabled. This field
	// consists of the resource portion of the Amazon Resource Name (ARN) returned
	// for a standard in the DescribeStandards (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html)
	// API response.
	ComplianceAssociatedStandardsId []*StringFilter `type:"list"`

	// The unique identifier of a control across standards. Values for this field
	// typically consist of an Amazon Web Service and a number, such as APIGateway.5.
	ComplianceSecurityControlId []*StringFilter `type:"list"`

	// Exclusive to findings that are generated as the result of a check run against
	// a specific rule in a supported standard, such as CIS Amazon Web Services
	// Foundations. Contains security standard-related finding details.
	ComplianceStatus []*StringFilter `type:"list"`

	// A finding's confidence. Confidence is defined as the likelihood that a finding
	// accurately identifies the behavior or issue that it was intended to identify.
	//
	// Confidence is scored on a 0-100 basis using a ratio scale, where 0 means
	// zero percent confidence and 100 means 100 percent confidence.
	Confidence []*NumberFilter `type:"list"`

	// An ISO8601-formatted timestamp that indicates when the security findings
	// provider captured the potential security issue that a finding captured.
	//
	// A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot
	// contain spaces, and date and time should be separated by T. For more information,
	// see RFC 3339 section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6).
	CreatedAt []*DateFilter `type:"list"`

	// The level of importance assigned to the resources associated with the finding.
	//
	// A score of 0 means that the underlying resources have no criticality, and
	// a score of 100 is reserved for the most critical resources.
	Criticality []*NumberFilter `type:"list"`

	// A finding's description.
	Description []*StringFilter `type:"list"`

	// The finding provider value for the finding confidence. Confidence is defined
	// as the likelihood that a finding accurately identifies the behavior or issue
	// that it was intended to identify.
	//
	// Confidence is scored on a 0-100 basis using a ratio scale, where 0 means
	// zero percent confidence and 100 means 100 percent confidence.
	FindingProviderFieldsConfidence []*NumberFilter `type:"list"`

	// The finding provider value for the level of importance assigned to the resources
	// associated with the findings.
	//
	// A score of 0 means that the underlying resources have no criticality, and
	// a score of 100 is reserved for the most critical resources.
	FindingProviderFieldsCriticality []*NumberFilter `type:"list"`

	// The finding identifier of a related finding that is identified by the finding
	// provider.
	FindingProviderFieldsRelatedFindingsId []*StringFilter `type:"list"`

	// The ARN of the solution that generated a related finding that is identified
	// by the finding provider.
	FindingProviderFieldsRelatedFindingsProductArn []*StringFilter `type:"list"`

	// The finding provider value for the severity label.
	FindingProviderFieldsSeverityLabel []*StringFilter `type:"list"`

	// The finding provider's original value for the severity.
	FindingProviderFieldsSeverityOriginal []*StringFilter `type:"list"`

	// One or more finding types that the finding provider assigned to the finding.
	// Uses the format of namespace/category/classifier that classify a finding.
	//
	// Valid namespace values are: Software and Configuration Checks | TTPs | Effects
	// | Unusual Behaviors | Sensitive Data Identifications
	FindingProviderFieldsTypes []*StringFilter `type:"list"`

	// An ISO8601-formatted timestamp that indicates when the security findings
	// provider first observed the potential security issue that a finding captured.
	//
	// A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot
	// contain spaces, and date and time should be separated by T. For more information,
	// see RFC 3339 section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6).
	FirstObservedAt []*DateFilter `type:"list"`

	// The identifier for the solution-specific component (a discrete unit of logic)
	// that generated a finding. In various security findings providers' solutions,
	// this generator can be called a rule, a check, a detector, a plugin, etc.
	GeneratorId []*StringFilter `type:"list"`

	// The security findings provider-specific identifier for a finding.
	Id []*StringFilter `type:"list"`

	// A keyword for a finding.
	//
	// Deprecated: The Keyword property is deprecated.
	Keyword []*KeywordFilter `deprecated:"true" type:"list"`

	// An ISO8601-formatted timestamp that indicates when the security findings
	// provider most recently observed the potential security issue that a finding
	// captured.
	//
	// A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot
	// contain spaces, and date and time should be separated by T. For more information,
	// see RFC 3339 section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6).
	LastObservedAt []*DateFilter `type:"list"`

	// The name of the malware that was observed.
	MalwareName []*StringFilter `type:"list"`

	// The filesystem path of the malware that was observed.
	MalwarePath []*StringFilter `type:"list"`

	// The state of the malware that was observed.
	MalwareState []*StringFilter `type:"list"`

	// The type of the malware that was observed.
	MalwareType []*StringFilter `type:"list"`

	// The destination domain of network-related information about a finding.
	NetworkDestinationDomain []*StringFilter `type:"list"`

	// The destination IPv4 address of network-related information about a finding.
	NetworkDestinationIpV4 []*IpFilter `type:"list"`

	// The destination IPv6 address of network-related information about a finding.
	NetworkDestinationIpV6 []*IpFilter `type:"list"`

	// The destination port of network-related information about a finding.
	NetworkDestinationPort []*NumberFilter `type:"list"`

	// Indicates the direction of network traffic associated with a finding.
	NetworkDirection []*StringFilter `type:"list"`

	// The protocol of network-related information about a finding.
	NetworkProtocol []*StringFilter `type:"list"`

	// The source domain of network-related information about a finding.
	NetworkSourceDomain []*StringFilter `type:"list"`

	// The source IPv4 address of network-related information about a finding.
	NetworkSourceIpV4 []*IpFilter `type:"list"`

	// The source IPv6 address of network-related information about a finding.
	NetworkSourceIpV6 []*IpFilter `type:"list"`

	// The source media access control (MAC) address of network-related information
	// about a finding.
	NetworkSourceMac []*StringFilter `type:"list"`

	// The source port of network-related information about a finding.
	NetworkSourcePort []*NumberFilter `type:"list"`

	// The text of a note.
	NoteText []*StringFilter `type:"list"`

	// The timestamp of when the note was updated.
	NoteUpdatedAt []*DateFilter `type:"list"`

	// The principal that created a note.
	NoteUpdatedBy []*StringFilter `type:"list"`

	// A timestamp that identifies when the process was launched.
	//
	// A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot
	// contain spaces, and date and time should be separated by T. For more information,
	// see RFC 3339 section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6).
	ProcessLaunchedAt []*DateFilter `type:"list"`

	// The name of the process.
	ProcessName []*StringFilter `type:"list"`

	// The parent process ID. This field accepts positive integers between O and
	// 2147483647.
	ProcessParentPid []*NumberFilter `type:"list"`

	// The path to the process executable.
	ProcessPath []*StringFilter `type:"list"`

	// The process ID.
	ProcessPid []*NumberFilter `type:"list"`

	// A timestamp that identifies when the process was terminated.
	//
	// A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot
	// contain spaces, and date and time should be separated by T. For more information,
	// see RFC 3339 section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6).
	ProcessTerminatedAt []*DateFilter `type:"list"`

	// The ARN generated by Security Hub that uniquely identifies a third-party
	// company (security findings provider) after this provider's product (solution
	// that generates findings) is registered with Security Hub.
	ProductArn []*StringFilter `type:"list"`

	// A data type where security findings providers can include additional solution-specific
	// details that aren't part of the defined AwsSecurityFinding format.
	ProductFields []*MapFilter `type:"list"`

	// The name of the solution (product) that generates findings.
	ProductName []*StringFilter `type:"list"`

	// The recommendation of what to do about the issue described in a finding.
	RecommendationText []*StringFilter `type:"list"`

	// The updated record state for the finding.
	RecordState []*StringFilter `type:"list"`

	// The Region from which the finding was generated.
	Region []*StringFilter `type:"list"`

	// The solution-generated identifier for a related finding.
	RelatedFindingsId []*StringFilter `type:"list"`

	// The ARN of the solution that generated a related finding.
	RelatedFindingsProductArn []*StringFilter `type:"list"`

	// The IAM profile ARN of the instance.
	ResourceAwsEc2InstanceIamInstanceProfileArn []*StringFilter `type:"list"`

	// The Amazon Machine Image (AMI) ID of the instance.
	ResourceAwsEc2InstanceImageId []*StringFilter `type:"list"`

	// The IPv4 addresses associated with the instance.
	ResourceAwsEc2InstanceIpV4Addresses []*IpFilter `type:"list"`

	// The IPv6 addresses associated with the instance.
	ResourceAwsEc2InstanceIpV6Addresses []*IpFilter `type:"list"`

	// The key name associated with the instance.
	ResourceAwsEc2InstanceKeyName []*StringFilter `type:"list"`

	// The date and time the instance was launched.
	ResourceAwsEc2InstanceLaunchedAt []*DateFilter `type:"list"`

	// The identifier of the subnet that the instance was launched in.
	ResourceAwsEc2InstanceSubnetId []*StringFilter `type:"list"`

	// The instance type of the instance.
	ResourceAwsEc2InstanceType []*StringFilter `type:"list"`

	// The identifier of the VPC that the instance was launched in.
	ResourceAwsEc2InstanceVpcId []*StringFilter `type:"list"`

	// The creation date/time of the IAM access key related to a finding.
	ResourceAwsIamAccessKeyCreatedAt []*DateFilter `type:"list"`

	// The name of the principal that is associated with an IAM access key.
	ResourceAwsIamAccessKeyPrincipalName []*StringFilter `type:"list"`

	// The status of the IAM access key related to a finding.
	ResourceAwsIamAccessKeyStatus []*StringFilter `type:"list"`

	// The user associated with the IAM access key related to a finding.
	//
	// Deprecated: This filter is deprecated. Instead, use ResourceAwsIamAccessKeyPrincipalName.
	ResourceAwsIamAccessKeyUserName []*StringFilter `deprecated:"true" type:"list"`

	// The name of an IAM user.
	ResourceAwsIamUserUserName []*StringFilter `type:"list"`

	// The canonical user ID of the owner of the S3 bucket.
	ResourceAwsS3BucketOwnerId []*StringFilter `type:"list"`

	// The display name of the owner of the S3 bucket.
	ResourceAwsS3BucketOwnerName []*StringFilter `type:"list"`

	// The identifier of the image related to a finding.
	ResourceContainerImageId []*StringFilter `type:"list"`

	// The name of the image related to a finding.
	ResourceContainerImageName []*StringFilter `type:"list"`

	// A timestamp that identifies when the container was started.
	//
	// A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot
	// contain spaces, and date and time should be separated by T. For more information,
	// see RFC 3339 section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6).
	ResourceContainerLaunchedAt []*DateFilter `type:"list"`

	// The name of the container related to a finding.
	ResourceContainerName []*StringFilter `type:"list"`

	// The details of a resource that doesn't have a specific subfield for the resource
	// type defined.
	ResourceDetailsOther []*MapFilter `type:"list"`

	// The canonical identifier for the given resource type.
	ResourceId []*StringFilter `type:"list"`

	// The canonical Amazon Web Services partition name that the Region is assigned
	// to.
	ResourcePartition []*StringFilter `type:"list"`

	// The canonical Amazon Web Services external Region name where this resource
	// is located.
	ResourceRegion []*StringFilter `type:"list"`

	// A list of Amazon Web Services tags associated with a resource at the time
	// the finding was processed.
	ResourceTags []*MapFilter `type:"list"`

	// Specifies the type of the resource that details are provided for.
	ResourceType []*StringFilter `type:"list"`

	// Indicates whether or not sample findings are included in the filter results.
	Sample []*BooleanFilter `type:"list"`

	// The label of a finding's severity.
	SeverityLabel []*StringFilter `type:"list"`

	// The normalized severity of a finding.
	//
	// Deprecated: This filter is deprecated. Instead, use SeverityLabel or FindingProviderFieldsSeverityLabel.
	SeverityNormalized []*NumberFilter `deprecated:"true" type:"list"`

	// The native severity as defined by the security findings provider's solution
	// that generated the finding.
	//
	// Deprecated: This filter is deprecated. Instead, use FindingProviderSeverityOriginal.
	SeverityProduct []*NumberFilter `deprecated:"true" type:"list"`

	// A URL that links to a page about the current finding in the security findings
	// provider's solution.
	SourceUrl []*StringFilter `type:"list"`

	// The category of a threat intelligence indicator.
	ThreatIntelIndicatorCategory []*StringFilter `type:"list"`

	// A timestamp that identifies the last observation of a threat intelligence
	// indicator.
	ThreatIntelIndicatorLastObservedAt []*DateFilter `type:"list"`

	// The source of the threat intelligence.
	ThreatIntelIndicatorSource []*StringFilter `type:"list"`

	// The URL for more details from the source of the threat intelligence.
	ThreatIntelIndicatorSourceUrl []*StringFilter `type:"list"`

	// The type of a threat intelligence indicator.
	ThreatIntelIndicatorType []*StringFilter `type:"list"`

	// The value of a threat intelligence indicator.
	ThreatIntelIndicatorValue []*StringFilter `type:"list"`

	// A finding's title.
	Title []*StringFilter `type:"list"`

	// A finding type in the format of namespace/category/classifier that classifies
	// a finding.
	Type []*StringFilter `type:"list"`

	// An ISO8601-formatted timestamp that indicates when the security findings
	// provider last updated the finding record.
	//
	// A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot
	// contain spaces, and date and time should be separated by T. For more information,
	// see RFC 3339 section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6).
	UpdatedAt []*DateFilter `type:"list"`

	// A list of name/value string pairs associated with the finding. These are
	// custom, user-defined fields added to a finding.
	UserDefinedFields []*MapFilter `type:"list"`

	// The veracity of a finding.
	VerificationState []*StringFilter `type:"list"`

	// The workflow state of a finding.
	//
	// Note that this field is deprecated. To search for a finding based on its
	// workflow status, use WorkflowStatus.
	WorkflowState []*StringFilter `type:"list"`

	// The status of the investigation into a finding. Allowed values are the following.
	//
	//    * NEW - The initial state of a finding, before it is reviewed. Security
	//    Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in
	//    the following cases: RecordState changes from ARCHIVED to ACTIVE. Compliance.Status
	//    changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.
	//
	//    * NOTIFIED - Indicates that the resource owner has been notified about
	//    the security issue. Used when the initial reviewer is not the resource
	//    owner, and needs intervention from the resource owner. If one of the following
	//    occurs, the workflow status is changed automatically from NOTIFIED to
	//    NEW: RecordState changes from ARCHIVED to ACTIVE. Compliance.Status changes
	//    from PASSED to FAILED, WARNING, or NOT_AVAILABLE.
	//
	//    * SUPPRESSED - Indicates that you reviewed the finding and do not believe
	//    that any action is needed. The workflow status of a SUPPRESSED finding
	//    does not change if RecordState changes from ARCHIVED to ACTIVE.
	//
	//    * RESOLVED - The finding was reviewed and remediated and is now considered
	//    resolved. The finding remains RESOLVED unless one of the following occurs:
	//    RecordState changes from ARCHIVED to ACTIVE. Compliance.Status changes
	//    from PASSED to FAILED, WARNING, or NOT_AVAILABLE. In those cases, the
	//    workflow status is automatically reset to NEW. For findings from controls,
	//    if Compliance.Status is PASSED, then Security Hub automatically sets the
	//    workflow status to RESOLVED.
	WorkflowStatus []*StringFilter `type:"list"`
	// contains filtered or unexported fields
}

A collection of attributes that are applied to all active Security Hub-aggregated findings and that result in a subset of findings that are included in this insight.

You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.

func (AwsSecurityFindingFilters) GoString

func (s AwsSecurityFindingFilters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsSecurityFindingFilters) SetAwsAccountId

SetAwsAccountId sets the AwsAccountId field's value.

func (*AwsSecurityFindingFilters) SetCompanyName

SetCompanyName sets the CompanyName field's value.

func (*AwsSecurityFindingFilters) SetComplianceAssociatedStandardsId added in v1.42.9

func (s *AwsSecurityFindingFilters) SetComplianceAssociatedStandardsId(v []*StringFilter) *AwsSecurityFindingFilters

SetComplianceAssociatedStandardsId sets the ComplianceAssociatedStandardsId field's value.

func (*AwsSecurityFindingFilters) SetComplianceSecurityControlId added in v1.42.9

func (s *AwsSecurityFindingFilters) SetComplianceSecurityControlId(v []*StringFilter) *AwsSecurityFindingFilters

SetComplianceSecurityControlId sets the ComplianceSecurityControlId field's value.

func (*AwsSecurityFindingFilters) SetComplianceStatus

SetComplianceStatus sets the ComplianceStatus field's value.

func (*AwsSecurityFindingFilters) SetConfidence

SetConfidence sets the Confidence field's value.

func (*AwsSecurityFindingFilters) SetCreatedAt

SetCreatedAt sets the CreatedAt field's value.

func (*AwsSecurityFindingFilters) SetCriticality

SetCriticality sets the Criticality field's value.

func (*AwsSecurityFindingFilters) SetDescription

SetDescription sets the Description field's value.

func (*AwsSecurityFindingFilters) SetFindingProviderFieldsConfidence

func (s *AwsSecurityFindingFilters) SetFindingProviderFieldsConfidence(v []*NumberFilter) *AwsSecurityFindingFilters

SetFindingProviderFieldsConfidence sets the FindingProviderFieldsConfidence field's value.

func (*AwsSecurityFindingFilters) SetFindingProviderFieldsCriticality

func (s *AwsSecurityFindingFilters) SetFindingProviderFieldsCriticality(v []*NumberFilter) *AwsSecurityFindingFilters

SetFindingProviderFieldsCriticality sets the FindingProviderFieldsCriticality field's value.

func (*AwsSecurityFindingFilters) SetFindingProviderFieldsRelatedFindingsId

func (s *AwsSecurityFindingFilters) SetFindingProviderFieldsRelatedFindingsId(v []*StringFilter) *AwsSecurityFindingFilters

SetFindingProviderFieldsRelatedFindingsId sets the FindingProviderFieldsRelatedFindingsId field's value.

func (*AwsSecurityFindingFilters) SetFindingProviderFieldsRelatedFindingsProductArn

func (s *AwsSecurityFindingFilters) SetFindingProviderFieldsRelatedFindingsProductArn(v []*StringFilter) *AwsSecurityFindingFilters

SetFindingProviderFieldsRelatedFindingsProductArn sets the FindingProviderFieldsRelatedFindingsProductArn field's value.

func (*AwsSecurityFindingFilters) SetFindingProviderFieldsSeverityLabel

func (s *AwsSecurityFindingFilters) SetFindingProviderFieldsSeverityLabel(v []*StringFilter) *AwsSecurityFindingFilters

SetFindingProviderFieldsSeverityLabel sets the FindingProviderFieldsSeverityLabel field's value.

func (*AwsSecurityFindingFilters) SetFindingProviderFieldsSeverityOriginal

func (s *AwsSecurityFindingFilters) SetFindingProviderFieldsSeverityOriginal(v []*StringFilter) *AwsSecurityFindingFilters

SetFindingProviderFieldsSeverityOriginal sets the FindingProviderFieldsSeverityOriginal field's value.

func (*AwsSecurityFindingFilters) SetFindingProviderFieldsTypes

func (s *AwsSecurityFindingFilters) SetFindingProviderFieldsTypes(v []*StringFilter) *AwsSecurityFindingFilters

SetFindingProviderFieldsTypes sets the FindingProviderFieldsTypes field's value.

func (*AwsSecurityFindingFilters) SetFirstObservedAt

func (s *AwsSecurityFindingFilters) SetFirstObservedAt(v []*DateFilter) *AwsSecurityFindingFilters

SetFirstObservedAt sets the FirstObservedAt field's value.

func (*AwsSecurityFindingFilters) SetGeneratorId

SetGeneratorId sets the GeneratorId field's value.

func (*AwsSecurityFindingFilters) SetId

SetId sets the Id field's value.

func (*AwsSecurityFindingFilters) SetKeyword

SetKeyword sets the Keyword field's value.

func (*AwsSecurityFindingFilters) SetLastObservedAt

SetLastObservedAt sets the LastObservedAt field's value.

func (*AwsSecurityFindingFilters) SetMalwareName

SetMalwareName sets the MalwareName field's value.

func (*AwsSecurityFindingFilters) SetMalwarePath

SetMalwarePath sets the MalwarePath field's value.

func (*AwsSecurityFindingFilters) SetMalwareState

SetMalwareState sets the MalwareState field's value.

func (*AwsSecurityFindingFilters) SetMalwareType

SetMalwareType sets the MalwareType field's value.

func (*AwsSecurityFindingFilters) SetNetworkDestinationDomain

func (s *AwsSecurityFindingFilters) SetNetworkDestinationDomain(v []*StringFilter) *AwsSecurityFindingFilters

SetNetworkDestinationDomain sets the NetworkDestinationDomain field's value.

func (*AwsSecurityFindingFilters) SetNetworkDestinationIpV4

func (s *AwsSecurityFindingFilters) SetNetworkDestinationIpV4(v []*IpFilter) *AwsSecurityFindingFilters

SetNetworkDestinationIpV4 sets the NetworkDestinationIpV4 field's value.

func (*AwsSecurityFindingFilters) SetNetworkDestinationIpV6

func (s *AwsSecurityFindingFilters) SetNetworkDestinationIpV6(v []*IpFilter) *AwsSecurityFindingFilters

SetNetworkDestinationIpV6 sets the NetworkDestinationIpV6 field's value.

func (*AwsSecurityFindingFilters) SetNetworkDestinationPort

func (s *AwsSecurityFindingFilters) SetNetworkDestinationPort(v []*NumberFilter) *AwsSecurityFindingFilters

SetNetworkDestinationPort sets the NetworkDestinationPort field's value.

func (*AwsSecurityFindingFilters) SetNetworkDirection

SetNetworkDirection sets the NetworkDirection field's value.

func (*AwsSecurityFindingFilters) SetNetworkProtocol

SetNetworkProtocol sets the NetworkProtocol field's value.

func (*AwsSecurityFindingFilters) SetNetworkSourceDomain

func (s *AwsSecurityFindingFilters) SetNetworkSourceDomain(v []*StringFilter) *AwsSecurityFindingFilters

SetNetworkSourceDomain sets the NetworkSourceDomain field's value.

func (*AwsSecurityFindingFilters) SetNetworkSourceIpV4

func (s *AwsSecurityFindingFilters) SetNetworkSourceIpV4(v []*IpFilter) *AwsSecurityFindingFilters

SetNetworkSourceIpV4 sets the NetworkSourceIpV4 field's value.

func (*AwsSecurityFindingFilters) SetNetworkSourceIpV6

func (s *AwsSecurityFindingFilters) SetNetworkSourceIpV6(v []*IpFilter) *AwsSecurityFindingFilters

SetNetworkSourceIpV6 sets the NetworkSourceIpV6 field's value.

func (*AwsSecurityFindingFilters) SetNetworkSourceMac

SetNetworkSourceMac sets the NetworkSourceMac field's value.

func (*AwsSecurityFindingFilters) SetNetworkSourcePort

func (s *AwsSecurityFindingFilters) SetNetworkSourcePort(v []*NumberFilter) *AwsSecurityFindingFilters

SetNetworkSourcePort sets the NetworkSourcePort field's value.

func (*AwsSecurityFindingFilters) SetNoteText

SetNoteText sets the NoteText field's value.

func (*AwsSecurityFindingFilters) SetNoteUpdatedAt

SetNoteUpdatedAt sets the NoteUpdatedAt field's value.

func (*AwsSecurityFindingFilters) SetNoteUpdatedBy

SetNoteUpdatedBy sets the NoteUpdatedBy field's value.

func (*AwsSecurityFindingFilters) SetProcessLaunchedAt

func (s *AwsSecurityFindingFilters) SetProcessLaunchedAt(v []*DateFilter) *AwsSecurityFindingFilters

SetProcessLaunchedAt sets the ProcessLaunchedAt field's value.

func (*AwsSecurityFindingFilters) SetProcessName

SetProcessName sets the ProcessName field's value.

func (*AwsSecurityFindingFilters) SetProcessParentPid

SetProcessParentPid sets the ProcessParentPid field's value.

func (*AwsSecurityFindingFilters) SetProcessPath

SetProcessPath sets the ProcessPath field's value.

func (*AwsSecurityFindingFilters) SetProcessPid

SetProcessPid sets the ProcessPid field's value.

func (*AwsSecurityFindingFilters) SetProcessTerminatedAt

func (s *AwsSecurityFindingFilters) SetProcessTerminatedAt(v []*DateFilter) *AwsSecurityFindingFilters

SetProcessTerminatedAt sets the ProcessTerminatedAt field's value.

func (*AwsSecurityFindingFilters) SetProductArn

SetProductArn sets the ProductArn field's value.

func (*AwsSecurityFindingFilters) SetProductFields

SetProductFields sets the ProductFields field's value.

func (*AwsSecurityFindingFilters) SetProductName

SetProductName sets the ProductName field's value.

func (*AwsSecurityFindingFilters) SetRecommendationText

func (s *AwsSecurityFindingFilters) SetRecommendationText(v []*StringFilter) *AwsSecurityFindingFilters

SetRecommendationText sets the RecommendationText field's value.

func (*AwsSecurityFindingFilters) SetRecordState

SetRecordState sets the RecordState field's value.

func (*AwsSecurityFindingFilters) SetRegion

SetRegion sets the Region field's value.

func (*AwsSecurityFindingFilters) SetRelatedFindingsId

func (s *AwsSecurityFindingFilters) SetRelatedFindingsId(v []*StringFilter) *AwsSecurityFindingFilters

SetRelatedFindingsId sets the RelatedFindingsId field's value.

func (*AwsSecurityFindingFilters) SetRelatedFindingsProductArn

func (s *AwsSecurityFindingFilters) SetRelatedFindingsProductArn(v []*StringFilter) *AwsSecurityFindingFilters

SetRelatedFindingsProductArn sets the RelatedFindingsProductArn field's value.

func (*AwsSecurityFindingFilters) SetResourceAwsEc2InstanceIamInstanceProfileArn

func (s *AwsSecurityFindingFilters) SetResourceAwsEc2InstanceIamInstanceProfileArn(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceAwsEc2InstanceIamInstanceProfileArn sets the ResourceAwsEc2InstanceIamInstanceProfileArn field's value.

func (*AwsSecurityFindingFilters) SetResourceAwsEc2InstanceImageId

func (s *AwsSecurityFindingFilters) SetResourceAwsEc2InstanceImageId(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceAwsEc2InstanceImageId sets the ResourceAwsEc2InstanceImageId field's value.

func (*AwsSecurityFindingFilters) SetResourceAwsEc2InstanceIpV4Addresses

func (s *AwsSecurityFindingFilters) SetResourceAwsEc2InstanceIpV4Addresses(v []*IpFilter) *AwsSecurityFindingFilters

SetResourceAwsEc2InstanceIpV4Addresses sets the ResourceAwsEc2InstanceIpV4Addresses field's value.

func (*AwsSecurityFindingFilters) SetResourceAwsEc2InstanceIpV6Addresses

func (s *AwsSecurityFindingFilters) SetResourceAwsEc2InstanceIpV6Addresses(v []*IpFilter) *AwsSecurityFindingFilters

SetResourceAwsEc2InstanceIpV6Addresses sets the ResourceAwsEc2InstanceIpV6Addresses field's value.

func (*AwsSecurityFindingFilters) SetResourceAwsEc2InstanceKeyName

func (s *AwsSecurityFindingFilters) SetResourceAwsEc2InstanceKeyName(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceAwsEc2InstanceKeyName sets the ResourceAwsEc2InstanceKeyName field's value.

func (*AwsSecurityFindingFilters) SetResourceAwsEc2InstanceLaunchedAt

func (s *AwsSecurityFindingFilters) SetResourceAwsEc2InstanceLaunchedAt(v []*DateFilter) *AwsSecurityFindingFilters

SetResourceAwsEc2InstanceLaunchedAt sets the ResourceAwsEc2InstanceLaunchedAt field's value.

func (*AwsSecurityFindingFilters) SetResourceAwsEc2InstanceSubnetId

func (s *AwsSecurityFindingFilters) SetResourceAwsEc2InstanceSubnetId(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceAwsEc2InstanceSubnetId sets the ResourceAwsEc2InstanceSubnetId field's value.

func (*AwsSecurityFindingFilters) SetResourceAwsEc2InstanceType

func (s *AwsSecurityFindingFilters) SetResourceAwsEc2InstanceType(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceAwsEc2InstanceType sets the ResourceAwsEc2InstanceType field's value.

func (*AwsSecurityFindingFilters) SetResourceAwsEc2InstanceVpcId

func (s *AwsSecurityFindingFilters) SetResourceAwsEc2InstanceVpcId(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceAwsEc2InstanceVpcId sets the ResourceAwsEc2InstanceVpcId field's value.

func (*AwsSecurityFindingFilters) SetResourceAwsIamAccessKeyCreatedAt

func (s *AwsSecurityFindingFilters) SetResourceAwsIamAccessKeyCreatedAt(v []*DateFilter) *AwsSecurityFindingFilters

SetResourceAwsIamAccessKeyCreatedAt sets the ResourceAwsIamAccessKeyCreatedAt field's value.

func (*AwsSecurityFindingFilters) SetResourceAwsIamAccessKeyPrincipalName

func (s *AwsSecurityFindingFilters) SetResourceAwsIamAccessKeyPrincipalName(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceAwsIamAccessKeyPrincipalName sets the ResourceAwsIamAccessKeyPrincipalName field's value.

func (*AwsSecurityFindingFilters) SetResourceAwsIamAccessKeyStatus

func (s *AwsSecurityFindingFilters) SetResourceAwsIamAccessKeyStatus(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceAwsIamAccessKeyStatus sets the ResourceAwsIamAccessKeyStatus field's value.

func (*AwsSecurityFindingFilters) SetResourceAwsIamAccessKeyUserName

func (s *AwsSecurityFindingFilters) SetResourceAwsIamAccessKeyUserName(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceAwsIamAccessKeyUserName sets the ResourceAwsIamAccessKeyUserName field's value.

func (*AwsSecurityFindingFilters) SetResourceAwsIamUserUserName

func (s *AwsSecurityFindingFilters) SetResourceAwsIamUserUserName(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceAwsIamUserUserName sets the ResourceAwsIamUserUserName field's value.

func (*AwsSecurityFindingFilters) SetResourceAwsS3BucketOwnerId

func (s *AwsSecurityFindingFilters) SetResourceAwsS3BucketOwnerId(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceAwsS3BucketOwnerId sets the ResourceAwsS3BucketOwnerId field's value.

func (*AwsSecurityFindingFilters) SetResourceAwsS3BucketOwnerName

func (s *AwsSecurityFindingFilters) SetResourceAwsS3BucketOwnerName(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceAwsS3BucketOwnerName sets the ResourceAwsS3BucketOwnerName field's value.

func (*AwsSecurityFindingFilters) SetResourceContainerImageId

func (s *AwsSecurityFindingFilters) SetResourceContainerImageId(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceContainerImageId sets the ResourceContainerImageId field's value.

func (*AwsSecurityFindingFilters) SetResourceContainerImageName

func (s *AwsSecurityFindingFilters) SetResourceContainerImageName(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceContainerImageName sets the ResourceContainerImageName field's value.

func (*AwsSecurityFindingFilters) SetResourceContainerLaunchedAt

func (s *AwsSecurityFindingFilters) SetResourceContainerLaunchedAt(v []*DateFilter) *AwsSecurityFindingFilters

SetResourceContainerLaunchedAt sets the ResourceContainerLaunchedAt field's value.

func (*AwsSecurityFindingFilters) SetResourceContainerName

func (s *AwsSecurityFindingFilters) SetResourceContainerName(v []*StringFilter) *AwsSecurityFindingFilters

SetResourceContainerName sets the ResourceContainerName field's value.

func (*AwsSecurityFindingFilters) SetResourceDetailsOther

func (s *AwsSecurityFindingFilters) SetResourceDetailsOther(v []*MapFilter) *AwsSecurityFindingFilters

SetResourceDetailsOther sets the ResourceDetailsOther field's value.

func (*AwsSecurityFindingFilters) SetResourceId

SetResourceId sets the ResourceId field's value.

func (*AwsSecurityFindingFilters) SetResourcePartition

func (s *AwsSecurityFindingFilters) SetResourcePartition(v []*StringFilter) *AwsSecurityFindingFilters

SetResourcePartition sets the ResourcePartition field's value.

func (*AwsSecurityFindingFilters) SetResourceRegion

SetResourceRegion sets the ResourceRegion field's value.

func (*AwsSecurityFindingFilters) SetResourceTags

SetResourceTags sets the ResourceTags field's value.

func (*AwsSecurityFindingFilters) SetResourceType

SetResourceType sets the ResourceType field's value.

func (*AwsSecurityFindingFilters) SetSample added in v1.42.9

SetSample sets the Sample field's value.

func (*AwsSecurityFindingFilters) SetSeverityLabel

SetSeverityLabel sets the SeverityLabel field's value.

func (*AwsSecurityFindingFilters) SetSeverityNormalized

func (s *AwsSecurityFindingFilters) SetSeverityNormalized(v []*NumberFilter) *AwsSecurityFindingFilters

SetSeverityNormalized sets the SeverityNormalized field's value.

func (*AwsSecurityFindingFilters) SetSeverityProduct

SetSeverityProduct sets the SeverityProduct field's value.

func (*AwsSecurityFindingFilters) SetSourceUrl

SetSourceUrl sets the SourceUrl field's value.

func (*AwsSecurityFindingFilters) SetThreatIntelIndicatorCategory

func (s *AwsSecurityFindingFilters) SetThreatIntelIndicatorCategory(v []*StringFilter) *AwsSecurityFindingFilters

SetThreatIntelIndicatorCategory sets the ThreatIntelIndicatorCategory field's value.

func (*AwsSecurityFindingFilters) SetThreatIntelIndicatorLastObservedAt

func (s *AwsSecurityFindingFilters) SetThreatIntelIndicatorLastObservedAt(v []*DateFilter) *AwsSecurityFindingFilters

SetThreatIntelIndicatorLastObservedAt sets the ThreatIntelIndicatorLastObservedAt field's value.

func (*AwsSecurityFindingFilters) SetThreatIntelIndicatorSource

func (s *AwsSecurityFindingFilters) SetThreatIntelIndicatorSource(v []*StringFilter) *AwsSecurityFindingFilters

SetThreatIntelIndicatorSource sets the ThreatIntelIndicatorSource field's value.

func (*AwsSecurityFindingFilters) SetThreatIntelIndicatorSourceUrl

func (s *AwsSecurityFindingFilters) SetThreatIntelIndicatorSourceUrl(v []*StringFilter) *AwsSecurityFindingFilters

SetThreatIntelIndicatorSourceUrl sets the ThreatIntelIndicatorSourceUrl field's value.

func (*AwsSecurityFindingFilters) SetThreatIntelIndicatorType

func (s *AwsSecurityFindingFilters) SetThreatIntelIndicatorType(v []*StringFilter) *AwsSecurityFindingFilters

SetThreatIntelIndicatorType sets the ThreatIntelIndicatorType field's value.

func (*AwsSecurityFindingFilters) SetThreatIntelIndicatorValue

func (s *AwsSecurityFindingFilters) SetThreatIntelIndicatorValue(v []*StringFilter) *AwsSecurityFindingFilters

SetThreatIntelIndicatorValue sets the ThreatIntelIndicatorValue field's value.

func (*AwsSecurityFindingFilters) SetTitle

SetTitle sets the Title field's value.

func (*AwsSecurityFindingFilters) SetType

SetType sets the Type field's value.

func (*AwsSecurityFindingFilters) SetUpdatedAt

SetUpdatedAt sets the UpdatedAt field's value.

func (*AwsSecurityFindingFilters) SetUserDefinedFields

func (s *AwsSecurityFindingFilters) SetUserDefinedFields(v []*MapFilter) *AwsSecurityFindingFilters

SetUserDefinedFields sets the UserDefinedFields field's value.

func (*AwsSecurityFindingFilters) SetVerificationState

func (s *AwsSecurityFindingFilters) SetVerificationState(v []*StringFilter) *AwsSecurityFindingFilters

SetVerificationState sets the VerificationState field's value.

func (*AwsSecurityFindingFilters) SetWorkflowState

SetWorkflowState sets the WorkflowState field's value.

func (*AwsSecurityFindingFilters) SetWorkflowStatus

SetWorkflowStatus sets the WorkflowStatus field's value.

func (AwsSecurityFindingFilters) String

func (s AwsSecurityFindingFilters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsSecurityFindingIdentifier

type AwsSecurityFindingIdentifier struct {

	// The identifier of the finding that was specified by the finding provider.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The ARN generated by Security Hub that uniquely identifies a product that
	// generates findings. This can be the ARN for a third-party product that is
	// integrated with Security Hub, or the ARN for a custom integration.
	//
	// ProductArn is a required field
	ProductArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Identifies which finding to get the finding history for.

func (AwsSecurityFindingIdentifier) GoString

func (s AwsSecurityFindingIdentifier) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsSecurityFindingIdentifier) SetId

SetId sets the Id field's value.

func (*AwsSecurityFindingIdentifier) SetProductArn

SetProductArn sets the ProductArn field's value.

func (AwsSecurityFindingIdentifier) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsSecurityFindingIdentifier) Validate

func (s *AwsSecurityFindingIdentifier) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AwsSnsTopicDetails

type AwsSnsTopicDetails struct {

	// Indicates failed message delivery status for an Amazon SNS topic that is
	// subscribed to a platform application endpoint.
	ApplicationSuccessFeedbackRoleArn *string `type:"string"`

	// Indicates failed message delivery status for an Amazon SNS topic that is
	// subscribed to an Amazon Kinesis Data Firehose endpoint.
	FirehoseFailureFeedbackRoleArn *string `type:"string"`

	// Indicates successful message delivery status for an Amazon SNS topic that
	// is subscribed to an Amazon Kinesis Data Firehose endpoint.
	FirehoseSuccessFeedbackRoleArn *string `type:"string"`

	// Indicates failed message delivery status for an Amazon SNS topic that is
	// subscribed to an HTTP endpoint.
	HttpFailureFeedbackRoleArn *string `type:"string"`

	// Indicates successful message delivery status for an Amazon SNS topic that
	// is subscribed to an HTTP endpoint.
	HttpSuccessFeedbackRoleArn *string `type:"string"`

	// The ID of an Amazon Web Services managed key for Amazon SNS or a customer
	// managed key.
	KmsMasterKeyId *string `type:"string"`

	// The subscription's owner.
	Owner *string `type:"string"`

	// Indicates failed message delivery status for an Amazon SNS topic that is
	// subscribed to an Amazon SQS endpoint.
	SqsFailureFeedbackRoleArn *string `type:"string"`

	// Indicates successful message delivery status for an Amazon SNS topic that
	// is subscribed to an Amazon SQS endpoint.
	SqsSuccessFeedbackRoleArn *string `type:"string"`

	// Subscription is an embedded property that describes the subscription endpoints
	// of an Amazon SNS topic.
	Subscription []*AwsSnsTopicSubscription `type:"list"`

	// The name of the Amazon SNS topic.
	TopicName *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about an Amazon SNS topic to which notifications can be published.

func (AwsSnsTopicDetails) GoString

func (s AwsSnsTopicDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsSnsTopicDetails) SetApplicationSuccessFeedbackRoleArn added in v1.42.9

func (s *AwsSnsTopicDetails) SetApplicationSuccessFeedbackRoleArn(v string) *AwsSnsTopicDetails

SetApplicationSuccessFeedbackRoleArn sets the ApplicationSuccessFeedbackRoleArn field's value.

func (*AwsSnsTopicDetails) SetFirehoseFailureFeedbackRoleArn added in v1.42.9

func (s *AwsSnsTopicDetails) SetFirehoseFailureFeedbackRoleArn(v string) *AwsSnsTopicDetails

SetFirehoseFailureFeedbackRoleArn sets the FirehoseFailureFeedbackRoleArn field's value.

func (*AwsSnsTopicDetails) SetFirehoseSuccessFeedbackRoleArn added in v1.42.9

func (s *AwsSnsTopicDetails) SetFirehoseSuccessFeedbackRoleArn(v string) *AwsSnsTopicDetails

SetFirehoseSuccessFeedbackRoleArn sets the FirehoseSuccessFeedbackRoleArn field's value.

func (*AwsSnsTopicDetails) SetHttpFailureFeedbackRoleArn added in v1.42.9

func (s *AwsSnsTopicDetails) SetHttpFailureFeedbackRoleArn(v string) *AwsSnsTopicDetails

SetHttpFailureFeedbackRoleArn sets the HttpFailureFeedbackRoleArn field's value.

func (*AwsSnsTopicDetails) SetHttpSuccessFeedbackRoleArn added in v1.42.9

func (s *AwsSnsTopicDetails) SetHttpSuccessFeedbackRoleArn(v string) *AwsSnsTopicDetails

SetHttpSuccessFeedbackRoleArn sets the HttpSuccessFeedbackRoleArn field's value.

func (*AwsSnsTopicDetails) SetKmsMasterKeyId

func (s *AwsSnsTopicDetails) SetKmsMasterKeyId(v string) *AwsSnsTopicDetails

SetKmsMasterKeyId sets the KmsMasterKeyId field's value.

func (*AwsSnsTopicDetails) SetOwner

SetOwner sets the Owner field's value.

func (*AwsSnsTopicDetails) SetSqsFailureFeedbackRoleArn added in v1.42.9

func (s *AwsSnsTopicDetails) SetSqsFailureFeedbackRoleArn(v string) *AwsSnsTopicDetails

SetSqsFailureFeedbackRoleArn sets the SqsFailureFeedbackRoleArn field's value.

func (*AwsSnsTopicDetails) SetSqsSuccessFeedbackRoleArn added in v1.42.9

func (s *AwsSnsTopicDetails) SetSqsSuccessFeedbackRoleArn(v string) *AwsSnsTopicDetails

SetSqsSuccessFeedbackRoleArn sets the SqsSuccessFeedbackRoleArn field's value.

func (*AwsSnsTopicDetails) SetSubscription

SetSubscription sets the Subscription field's value.

func (*AwsSnsTopicDetails) SetTopicName

func (s *AwsSnsTopicDetails) SetTopicName(v string) *AwsSnsTopicDetails

SetTopicName sets the TopicName field's value.

func (AwsSnsTopicDetails) String

func (s AwsSnsTopicDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsSnsTopicSubscription

type AwsSnsTopicSubscription struct {

	// The subscription's endpoint (format depends on the protocol).
	Endpoint *string `type:"string"`

	// The subscription's protocol.
	Protocol *string `type:"string"`
	// contains filtered or unexported fields
}

A wrapper type for the attributes of an Amazon SNS subscription.

func (AwsSnsTopicSubscription) GoString

func (s AwsSnsTopicSubscription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsSnsTopicSubscription) SetEndpoint

SetEndpoint sets the Endpoint field's value.

func (*AwsSnsTopicSubscription) SetProtocol

SetProtocol sets the Protocol field's value.

func (AwsSnsTopicSubscription) String

func (s AwsSnsTopicSubscription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsSqsQueueDetails

type AwsSqsQueueDetails struct {

	// The ARN of the dead-letter queue to which Amazon SQS moves messages after
	// the value of maxReceiveCount is exceeded.
	DeadLetterTargetArn *string `type:"string"`

	// The length of time, in seconds, for which Amazon SQS can reuse a data key
	// to encrypt or decrypt messages before calling KMS again.
	KmsDataKeyReusePeriodSeconds *int64 `type:"integer"`

	// The ID of an Amazon Web Services managed key for Amazon SQS or a custom KMS
	// key.
	KmsMasterKeyId *string `type:"string"`

	// The name of the new queue.
	QueueName *string `type:"string"`
	// contains filtered or unexported fields
}

Data about a queue.

func (AwsSqsQueueDetails) GoString

func (s AwsSqsQueueDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsSqsQueueDetails) SetDeadLetterTargetArn

func (s *AwsSqsQueueDetails) SetDeadLetterTargetArn(v string) *AwsSqsQueueDetails

SetDeadLetterTargetArn sets the DeadLetterTargetArn field's value.

func (*AwsSqsQueueDetails) SetKmsDataKeyReusePeriodSeconds

func (s *AwsSqsQueueDetails) SetKmsDataKeyReusePeriodSeconds(v int64) *AwsSqsQueueDetails

SetKmsDataKeyReusePeriodSeconds sets the KmsDataKeyReusePeriodSeconds field's value.

func (*AwsSqsQueueDetails) SetKmsMasterKeyId

func (s *AwsSqsQueueDetails) SetKmsMasterKeyId(v string) *AwsSqsQueueDetails

SetKmsMasterKeyId sets the KmsMasterKeyId field's value.

func (*AwsSqsQueueDetails) SetQueueName

func (s *AwsSqsQueueDetails) SetQueueName(v string) *AwsSqsQueueDetails

SetQueueName sets the QueueName field's value.

func (AwsSqsQueueDetails) String

func (s AwsSqsQueueDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsSsmComplianceSummary

type AwsSsmComplianceSummary struct {

	// The type of resource for which the compliance was determined. For AwsSsmPatchCompliance,
	// ComplianceType is Patch.
	ComplianceType *string `type:"string"`

	// For the patches that are compliant, the number that have a severity of CRITICAL.
	CompliantCriticalCount *int64 `type:"integer"`

	// For the patches that are compliant, the number that have a severity of HIGH.
	CompliantHighCount *int64 `type:"integer"`

	// For the patches that are compliant, the number that have a severity of INFORMATIONAL.
	CompliantInformationalCount *int64 `type:"integer"`

	// For the patches that are compliant, the number that have a severity of LOW.
	CompliantLowCount *int64 `type:"integer"`

	// For the patches that are compliant, the number that have a severity of MEDIUM.
	CompliantMediumCount *int64 `type:"integer"`

	// For the patches that are compliant, the number that have a severity of UNSPECIFIED.
	CompliantUnspecifiedCount *int64 `type:"integer"`

	// The type of execution that was used determine compliance.
	ExecutionType *string `type:"string"`

	// For the patch items that are noncompliant, the number of items that have
	// a severity of CRITICAL.
	NonCompliantCriticalCount *int64 `type:"integer"`

	// For the patches that are noncompliant, the number that have a severity of
	// HIGH.
	NonCompliantHighCount *int64 `type:"integer"`

	// For the patches that are noncompliant, the number that have a severity of
	// INFORMATIONAL.
	NonCompliantInformationalCount *int64 `type:"integer"`

	// For the patches that are noncompliant, the number that have a severity of
	// LOW.
	NonCompliantLowCount *int64 `type:"integer"`

	// For the patches that are noncompliant, the number that have a severity of
	// MEDIUM.
	NonCompliantMediumCount *int64 `type:"integer"`

	// For the patches that are noncompliant, the number that have a severity of
	// UNSPECIFIED.
	NonCompliantUnspecifiedCount *int64 `type:"integer"`

	// The highest severity for the patches. Valid values are as follows:
	//
	//    * CRITICAL
	//
	//    * HIGH
	//
	//    * MEDIUM
	//
	//    * LOW
	//
	//    * INFORMATIONAL
	//
	//    * UNSPECIFIED
	OverallSeverity *string `type:"string"`

	// The identifier of the patch baseline. The patch baseline lists the patches
	// that are approved for installation.
	PatchBaselineId *string `type:"string"`

	// The identifier of the patch group for which compliance was determined. A
	// patch group uses tags to group EC2 instances that should have the same patch
	// compliance.
	PatchGroup *string `type:"string"`

	// The current patch compliance status. Valid values are as follows:
	//
	//    * COMPLIANT
	//
	//    * NON_COMPLIANT
	//
	//    * UNSPECIFIED_DATA
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Provides the details about the compliance status for a patch.

func (AwsSsmComplianceSummary) GoString

func (s AwsSsmComplianceSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsSsmComplianceSummary) SetComplianceType

func (s *AwsSsmComplianceSummary) SetComplianceType(v string) *AwsSsmComplianceSummary

SetComplianceType sets the ComplianceType field's value.

func (*AwsSsmComplianceSummary) SetCompliantCriticalCount

func (s *AwsSsmComplianceSummary) SetCompliantCriticalCount(v int64) *AwsSsmComplianceSummary

SetCompliantCriticalCount sets the CompliantCriticalCount field's value.

func (*AwsSsmComplianceSummary) SetCompliantHighCount

func (s *AwsSsmComplianceSummary) SetCompliantHighCount(v int64) *AwsSsmComplianceSummary

SetCompliantHighCount sets the CompliantHighCount field's value.

func (*AwsSsmComplianceSummary) SetCompliantInformationalCount

func (s *AwsSsmComplianceSummary) SetCompliantInformationalCount(v int64) *AwsSsmComplianceSummary

SetCompliantInformationalCount sets the CompliantInformationalCount field's value.

func (*AwsSsmComplianceSummary) SetCompliantLowCount

func (s *AwsSsmComplianceSummary) SetCompliantLowCount(v int64) *AwsSsmComplianceSummary

SetCompliantLowCount sets the CompliantLowCount field's value.

func (*AwsSsmComplianceSummary) SetCompliantMediumCount

func (s *AwsSsmComplianceSummary) SetCompliantMediumCount(v int64) *AwsSsmComplianceSummary

SetCompliantMediumCount sets the CompliantMediumCount field's value.

func (*AwsSsmComplianceSummary) SetCompliantUnspecifiedCount

func (s *AwsSsmComplianceSummary) SetCompliantUnspecifiedCount(v int64) *AwsSsmComplianceSummary

SetCompliantUnspecifiedCount sets the CompliantUnspecifiedCount field's value.

func (*AwsSsmComplianceSummary) SetExecutionType

func (s *AwsSsmComplianceSummary) SetExecutionType(v string) *AwsSsmComplianceSummary

SetExecutionType sets the ExecutionType field's value.

func (*AwsSsmComplianceSummary) SetNonCompliantCriticalCount

func (s *AwsSsmComplianceSummary) SetNonCompliantCriticalCount(v int64) *AwsSsmComplianceSummary

SetNonCompliantCriticalCount sets the NonCompliantCriticalCount field's value.

func (*AwsSsmComplianceSummary) SetNonCompliantHighCount

func (s *AwsSsmComplianceSummary) SetNonCompliantHighCount(v int64) *AwsSsmComplianceSummary

SetNonCompliantHighCount sets the NonCompliantHighCount field's value.

func (*AwsSsmComplianceSummary) SetNonCompliantInformationalCount

func (s *AwsSsmComplianceSummary) SetNonCompliantInformationalCount(v int64) *AwsSsmComplianceSummary

SetNonCompliantInformationalCount sets the NonCompliantInformationalCount field's value.

func (*AwsSsmComplianceSummary) SetNonCompliantLowCount

func (s *AwsSsmComplianceSummary) SetNonCompliantLowCount(v int64) *AwsSsmComplianceSummary

SetNonCompliantLowCount sets the NonCompliantLowCount field's value.

func (*AwsSsmComplianceSummary) SetNonCompliantMediumCount

func (s *AwsSsmComplianceSummary) SetNonCompliantMediumCount(v int64) *AwsSsmComplianceSummary

SetNonCompliantMediumCount sets the NonCompliantMediumCount field's value.

func (*AwsSsmComplianceSummary) SetNonCompliantUnspecifiedCount

func (s *AwsSsmComplianceSummary) SetNonCompliantUnspecifiedCount(v int64) *AwsSsmComplianceSummary

SetNonCompliantUnspecifiedCount sets the NonCompliantUnspecifiedCount field's value.

func (*AwsSsmComplianceSummary) SetOverallSeverity

func (s *AwsSsmComplianceSummary) SetOverallSeverity(v string) *AwsSsmComplianceSummary

SetOverallSeverity sets the OverallSeverity field's value.

func (*AwsSsmComplianceSummary) SetPatchBaselineId

func (s *AwsSsmComplianceSummary) SetPatchBaselineId(v string) *AwsSsmComplianceSummary

SetPatchBaselineId sets the PatchBaselineId field's value.

func (*AwsSsmComplianceSummary) SetPatchGroup

SetPatchGroup sets the PatchGroup field's value.

func (*AwsSsmComplianceSummary) SetStatus

SetStatus sets the Status field's value.

func (AwsSsmComplianceSummary) String

func (s AwsSsmComplianceSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsSsmPatch

type AwsSsmPatch struct {

	// The compliance status details for the patch.
	ComplianceSummary *AwsSsmComplianceSummary `type:"structure"`
	// contains filtered or unexported fields
}

Provides details about the compliance for a patch.

func (AwsSsmPatch) GoString

func (s AwsSsmPatch) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsSsmPatch) SetComplianceSummary

func (s *AwsSsmPatch) SetComplianceSummary(v *AwsSsmComplianceSummary) *AwsSsmPatch

SetComplianceSummary sets the ComplianceSummary field's value.

func (AwsSsmPatch) String

func (s AwsSsmPatch) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsSsmPatchComplianceDetails

type AwsSsmPatchComplianceDetails struct {

	// Information about the status of a patch.
	Patch *AwsSsmPatch `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about the state of a patch on an instance based on the patch baseline that was used to patch the instance.

func (AwsSsmPatchComplianceDetails) GoString

func (s AwsSsmPatchComplianceDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsSsmPatchComplianceDetails) SetPatch

SetPatch sets the Patch field's value.

func (AwsSsmPatchComplianceDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsStepFunctionStateMachineDetails added in v1.42.9

type AwsStepFunctionStateMachineDetails struct {

	// A user-defined or an auto-generated string that identifies a Map state. This
	// parameter is present only if the stateMachineArn specified in input is a
	// qualified state machine ARN.
	Label *string `type:"string"`

	// Used to set CloudWatch Logs options.
	LoggingConfiguration *AwsStepFunctionStateMachineLoggingConfigurationDetails `type:"structure"`

	// The name of the state machine.
	Name *string `type:"string"`

	// The Amazon Resource Name (ARN) of the IAM role used when creating this state
	// machine.
	RoleArn *string `type:"string"`

	// The ARN that identifies the state machine.
	StateMachineArn *string `type:"string"`

	// The current status of the state machine.
	Status *string `type:"string"`

	// Specifies whether X-Ray tracing is enabled.
	TracingConfiguration *AwsStepFunctionStateMachineTracingConfigurationDetails `type:"structure"`

	// The type of the state machine (STANDARD or EXPRESS).
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about an Step Functions state machine, which is a workflow consisting of a series of event- driven steps.

func (AwsStepFunctionStateMachineDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsStepFunctionStateMachineDetails) SetLabel added in v1.42.9

SetLabel sets the Label field's value.

func (*AwsStepFunctionStateMachineDetails) SetLoggingConfiguration added in v1.42.9

SetLoggingConfiguration sets the LoggingConfiguration field's value.

func (*AwsStepFunctionStateMachineDetails) SetName added in v1.42.9

SetName sets the Name field's value.

func (*AwsStepFunctionStateMachineDetails) SetRoleArn added in v1.42.9

SetRoleArn sets the RoleArn field's value.

func (*AwsStepFunctionStateMachineDetails) SetStateMachineArn added in v1.42.9

SetStateMachineArn sets the StateMachineArn field's value.

func (*AwsStepFunctionStateMachineDetails) SetStatus added in v1.42.9

SetStatus sets the Status field's value.

func (*AwsStepFunctionStateMachineDetails) SetTracingConfiguration added in v1.42.9

SetTracingConfiguration sets the TracingConfiguration field's value.

func (*AwsStepFunctionStateMachineDetails) SetType added in v1.42.9

SetType sets the Type field's value.

func (AwsStepFunctionStateMachineDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails added in v1.42.9

type AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails struct {

	// The ARN (ends with :*) of the CloudWatch Logs log group to which you want
	// your logs emitted.
	LogGroupArn *string `type:"string"`
	// contains filtered or unexported fields
}

An object describing a CloudWatch log group. For more information, see Amazon Web Services::Logs::LogGroup (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html) in the CloudFormation User Guide.

func (AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails) SetLogGroupArn added in v1.42.9

SetLogGroupArn sets the LogGroupArn field's value.

func (AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails added in v1.42.9

type AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails struct {

	// An object describing a CloudWatch Logs log group. For more information, see
	// Amazon Web Services::Logs::LogGroup (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html)
	// in the CloudFormation User Guide.
	CloudWatchLogsLogGroup *AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails `type:"structure"`
	// contains filtered or unexported fields
}

An array of objects that describes where your execution history events will be logged.

func (AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails) SetCloudWatchLogsLogGroup added in v1.42.9

SetCloudWatchLogsLogGroup sets the CloudWatchLogsLogGroup field's value.

func (AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsStepFunctionStateMachineLoggingConfigurationDetails added in v1.42.9

type AwsStepFunctionStateMachineLoggingConfigurationDetails struct {

	// An array of objects that describes where your execution history events will
	// be logged.
	Destinations []*AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails `type:"list"`

	// Determines whether execution data is included in your log. When set to false,
	// data is excluded.
	IncludeExecutionData *bool `type:"boolean"`

	// Defines which category of execution history events are logged.
	Level *string `type:"string"`
	// contains filtered or unexported fields
}

The LoggingConfiguration data type is used to set CloudWatch Logs options.

func (AwsStepFunctionStateMachineLoggingConfigurationDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsStepFunctionStateMachineLoggingConfigurationDetails) SetDestinations added in v1.42.9

SetDestinations sets the Destinations field's value.

func (*AwsStepFunctionStateMachineLoggingConfigurationDetails) SetIncludeExecutionData added in v1.42.9

SetIncludeExecutionData sets the IncludeExecutionData field's value.

func (*AwsStepFunctionStateMachineLoggingConfigurationDetails) SetLevel added in v1.42.9

SetLevel sets the Level field's value.

func (AwsStepFunctionStateMachineLoggingConfigurationDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsStepFunctionStateMachineTracingConfigurationDetails added in v1.42.9

type AwsStepFunctionStateMachineTracingConfigurationDetails struct {

	// When set to true, X-Ray tracing is enabled.
	Enabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Specifies whether X-Ray tracing is enabled.

func (AwsStepFunctionStateMachineTracingConfigurationDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsStepFunctionStateMachineTracingConfigurationDetails) SetEnabled added in v1.42.9

SetEnabled sets the Enabled field's value.

func (AwsStepFunctionStateMachineTracingConfigurationDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafRateBasedRuleDetails

type AwsWafRateBasedRuleDetails struct {

	// The predicates to include in the rate-based rule.
	MatchPredicates []*AwsWafRateBasedRuleMatchPredicate `type:"list"`

	// The name of the metrics for the rate-based rule.
	MetricName *string `type:"string"`

	// The name of the rate-based rule.
	Name *string `type:"string"`

	// The field that WAF uses to determine whether requests are likely arriving
	// from single source and are subject to rate monitoring.
	RateKey *string `type:"string"`

	// The maximum number of requests that have an identical value for the field
	// specified in RateKey that are allowed within a five-minute period. If the
	// number of requests exceeds RateLimit and the other predicates specified in
	// the rule are met, WAF triggers the action for the rule.
	RateLimit *int64 `type:"long"`

	// The unique identifier for the rate-based rule.
	RuleId *string `type:"string"`
	// contains filtered or unexported fields
}

Details about a rate-based rule for global resources. A rate-based rule provides settings to indicate when to allow, block, or count a request. Rate-based rules include the number of requests that arrive over a specified period of time.

func (AwsWafRateBasedRuleDetails) GoString

func (s AwsWafRateBasedRuleDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafRateBasedRuleDetails) SetMatchPredicates

SetMatchPredicates sets the MatchPredicates field's value.

func (*AwsWafRateBasedRuleDetails) SetMetricName

SetMetricName sets the MetricName field's value.

func (*AwsWafRateBasedRuleDetails) SetName

SetName sets the Name field's value.

func (*AwsWafRateBasedRuleDetails) SetRateKey

SetRateKey sets the RateKey field's value.

func (*AwsWafRateBasedRuleDetails) SetRateLimit

SetRateLimit sets the RateLimit field's value.

func (*AwsWafRateBasedRuleDetails) SetRuleId

SetRuleId sets the RuleId field's value.

func (AwsWafRateBasedRuleDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafRateBasedRuleMatchPredicate

type AwsWafRateBasedRuleMatchPredicate struct {

	// The unique identifier for the predicate.
	DataId *string `type:"string"`

	// If set to true, then the rule actions are performed on requests that match
	// the predicate settings.
	//
	// If set to false, then the rule actions are performed on all requests except
	// those that match the predicate settings.
	Negated *bool `type:"boolean"`

	// The type of predicate. Valid values are as follows:
	//
	//    * ByteMatch
	//
	//    * GeoMatch
	//
	//    * IPMatch
	//
	//    * RegexMatch
	//
	//    * SizeConstraint
	//
	//    * SqlInjectionMatch
	//
	//    * XssMatch
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

A match predicate. A predicate might look for characteristics such as specific IP addresses, geographic locations, or sizes.

func (AwsWafRateBasedRuleMatchPredicate) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafRateBasedRuleMatchPredicate) SetDataId

SetDataId sets the DataId field's value.

func (*AwsWafRateBasedRuleMatchPredicate) SetNegated

SetNegated sets the Negated field's value.

func (*AwsWafRateBasedRuleMatchPredicate) SetType

SetType sets the Type field's value.

func (AwsWafRateBasedRuleMatchPredicate) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafRegionalRateBasedRuleDetails

type AwsWafRegionalRateBasedRuleDetails struct {

	// The predicates to include in the rate-based rule.
	MatchPredicates []*AwsWafRegionalRateBasedRuleMatchPredicate `type:"list"`

	// The name of the metrics for the rate-based rule.
	MetricName *string `type:"string"`

	// The name of the rate-based rule.
	Name *string `type:"string"`

	// The field that WAF uses to determine whether requests are likely arriving
	// from single source and are subject to rate monitoring.
	RateKey *string `type:"string"`

	// The maximum number of requests that have an identical value for the field
	// specified in RateKey that are allowed within a five-minute period. If the
	// number of requests exceeds RateLimit and the other predicates specified in
	// the rule are met, WAF triggers the action for the rule.
	RateLimit *int64 `type:"long"`

	// The unique identifier for the rate-based rule.
	RuleId *string `type:"string"`
	// contains filtered or unexported fields
}

contains details about a rate-based rule for Regional resources. A rate-based rule provides settings to indicate when to allow, block, or count a request. Rate-based rules include the number of requests that arrive over a specified period of time.

func (AwsWafRegionalRateBasedRuleDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafRegionalRateBasedRuleDetails) SetMatchPredicates

SetMatchPredicates sets the MatchPredicates field's value.

func (*AwsWafRegionalRateBasedRuleDetails) SetMetricName

SetMetricName sets the MetricName field's value.

func (*AwsWafRegionalRateBasedRuleDetails) SetName

SetName sets the Name field's value.

func (*AwsWafRegionalRateBasedRuleDetails) SetRateKey

SetRateKey sets the RateKey field's value.

func (*AwsWafRegionalRateBasedRuleDetails) SetRateLimit

SetRateLimit sets the RateLimit field's value.

func (*AwsWafRegionalRateBasedRuleDetails) SetRuleId

SetRuleId sets the RuleId field's value.

func (AwsWafRegionalRateBasedRuleDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafRegionalRateBasedRuleMatchPredicate

type AwsWafRegionalRateBasedRuleMatchPredicate struct {

	// The unique identifier for the predicate.
	DataId *string `type:"string"`

	// If set to true, then the rule actions are performed on requests that match
	// the predicate settings.
	//
	// If set to false, then the rule actions are performed on all requests except
	// those that match the predicate settings.
	Negated *bool `type:"boolean"`

	// The type of predicate. Valid values are as follows:
	//
	//    * ByteMatch
	//
	//    * GeoMatch
	//
	//    * IPMatch
	//
	//    * RegexMatch
	//
	//    * SizeConstraint
	//
	//    * SqlInjectionMatch
	//
	//    * XssMatch
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Details for a match predicate. A predicate might look for characteristics such as specific IP addresses, geographic locations, or sizes.

func (AwsWafRegionalRateBasedRuleMatchPredicate) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafRegionalRateBasedRuleMatchPredicate) SetDataId

SetDataId sets the DataId field's value.

func (*AwsWafRegionalRateBasedRuleMatchPredicate) SetNegated

SetNegated sets the Negated field's value.

func (*AwsWafRegionalRateBasedRuleMatchPredicate) SetType

SetType sets the Type field's value.

func (AwsWafRegionalRateBasedRuleMatchPredicate) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafRegionalRuleDetails added in v1.42.9

type AwsWafRegionalRuleDetails struct {

	// A name for the metrics for the rule.
	MetricName *string `type:"string"`

	// A descriptive name for the rule.
	Name *string `type:"string"`

	// Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet,
	// GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule
	// and, for each object, indicates whether you want to negate the settings.
	PredicateList []*AwsWafRegionalRulePredicateListDetails `type:"list"`

	// The ID of the rule.
	RuleId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about an WAF Regional rule. This rule identifies the web requests that you want to allow, block, or count.

func (AwsWafRegionalRuleDetails) GoString added in v1.42.9

func (s AwsWafRegionalRuleDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafRegionalRuleDetails) SetMetricName added in v1.42.9

SetMetricName sets the MetricName field's value.

func (*AwsWafRegionalRuleDetails) SetName added in v1.42.9

SetName sets the Name field's value.

func (*AwsWafRegionalRuleDetails) SetPredicateList added in v1.42.9

SetPredicateList sets the PredicateList field's value.

func (*AwsWafRegionalRuleDetails) SetRuleId added in v1.42.9

SetRuleId sets the RuleId field's value.

func (AwsWafRegionalRuleDetails) String added in v1.42.9

func (s AwsWafRegionalRuleDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafRegionalRuleGroupDetails added in v1.42.9

type AwsWafRegionalRuleGroupDetails struct {

	// A name for the metrics for this rule group.
	MetricName *string `type:"string"`

	// The descriptive name of the rule group.
	Name *string `type:"string"`

	// The ID of the rule group.
	RuleGroupId *string `type:"string"`

	// Provides information about the rule statements used to identify the web requests
	// that you want to allow, block, or count.
	Rules []*AwsWafRegionalRuleGroupRulesDetails `type:"list"`
	// contains filtered or unexported fields
}

Provides information about an WAF Regional rule group. The rule group is a collection of rules for inspecting and controlling web requests.

func (AwsWafRegionalRuleGroupDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafRegionalRuleGroupDetails) SetMetricName added in v1.42.9

SetMetricName sets the MetricName field's value.

func (*AwsWafRegionalRuleGroupDetails) SetName added in v1.42.9

SetName sets the Name field's value.

func (*AwsWafRegionalRuleGroupDetails) SetRuleGroupId added in v1.42.9

SetRuleGroupId sets the RuleGroupId field's value.

func (*AwsWafRegionalRuleGroupDetails) SetRules added in v1.42.9

SetRules sets the Rules field's value.

func (AwsWafRegionalRuleGroupDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafRegionalRuleGroupRulesActionDetails added in v1.42.9

type AwsWafRegionalRuleGroupRulesActionDetails struct {

	// Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet,
	// GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule
	// and, for each object, indicates whether you want to negate the settings.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the action that WAF should take on a web request when it matches the criteria defined in the rule.

func (AwsWafRegionalRuleGroupRulesActionDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafRegionalRuleGroupRulesActionDetails) SetType added in v1.42.9

SetType sets the Type field's value.

func (AwsWafRegionalRuleGroupRulesActionDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafRegionalRuleGroupRulesDetails added in v1.42.9

type AwsWafRegionalRuleGroupRulesDetails struct {

	// The action that WAF should take on a web request when it matches the criteria
	// defined in the rule.
	Action *AwsWafRegionalRuleGroupRulesActionDetails `type:"structure"`

	// If you define more than one rule in a web ACL, WAF evaluates each request
	// against the rules in order based on the value of Priority.
	Priority *int64 `type:"integer"`

	// The ID for a rule.
	RuleId *string `type:"string"`

	// The type of rule in the rule group.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the rules attached to a rule group

func (AwsWafRegionalRuleGroupRulesDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafRegionalRuleGroupRulesDetails) SetAction added in v1.42.9

SetAction sets the Action field's value.

func (*AwsWafRegionalRuleGroupRulesDetails) SetPriority added in v1.42.9

SetPriority sets the Priority field's value.

func (*AwsWafRegionalRuleGroupRulesDetails) SetRuleId added in v1.42.9

SetRuleId sets the RuleId field's value.

func (*AwsWafRegionalRuleGroupRulesDetails) SetType added in v1.42.9

SetType sets the Type field's value.

func (AwsWafRegionalRuleGroupRulesDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafRegionalRulePredicateListDetails added in v1.42.9

type AwsWafRegionalRulePredicateListDetails struct {

	// A unique identifier for a predicate in a rule, such as ByteMatchSetId or
	// IPSetId.
	DataId *string `type:"string"`

	// Specifies if you want WAF to allow, block, or count requests based on the
	// settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet,
	// GeoMatchSet, or SizeConstraintSet.
	Negated *bool `type:"boolean"`

	// The type of predicate in a rule, such as ByteMatch or IPSet.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you want to negate the settings.

func (AwsWafRegionalRulePredicateListDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafRegionalRulePredicateListDetails) SetDataId added in v1.42.9

SetDataId sets the DataId field's value.

func (*AwsWafRegionalRulePredicateListDetails) SetNegated added in v1.42.9

SetNegated sets the Negated field's value.

func (*AwsWafRegionalRulePredicateListDetails) SetType added in v1.42.9

SetType sets the Type field's value.

func (AwsWafRegionalRulePredicateListDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafRegionalWebAclDetails added in v1.42.9

type AwsWafRegionalWebAclDetails struct {

	// The action to perform if none of the rules contained in the web ACL match.
	DefaultAction *string `type:"string"`

	// A name for the metrics for this web ACL.
	MetricName *string `type:"string"`

	// A descriptive name for the web ACL.
	Name *string `type:"string"`

	// An array that contains the action for each rule in a web ACL, the priority
	// of the rule, and the ID of the rule.
	RulesList []*AwsWafRegionalWebAclRulesListDetails `type:"list"`

	// The ID of the web ACL.
	WebAclId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the web access control list (web ACL). The web ACL contains the rules that identify the requests that you want to allow, block, or count.

func (AwsWafRegionalWebAclDetails) GoString added in v1.42.9

func (s AwsWafRegionalWebAclDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafRegionalWebAclDetails) SetDefaultAction added in v1.42.9

SetDefaultAction sets the DefaultAction field's value.

func (*AwsWafRegionalWebAclDetails) SetMetricName added in v1.42.9

SetMetricName sets the MetricName field's value.

func (*AwsWafRegionalWebAclDetails) SetName added in v1.42.9

SetName sets the Name field's value.

func (*AwsWafRegionalWebAclDetails) SetRulesList added in v1.42.9

SetRulesList sets the RulesList field's value.

func (*AwsWafRegionalWebAclDetails) SetWebAclId added in v1.42.9

SetWebAclId sets the WebAclId field's value.

func (AwsWafRegionalWebAclDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafRegionalWebAclRulesListActionDetails added in v1.42.9

type AwsWafRegionalWebAclRulesListActionDetails struct {

	// For actions that are associated with a rule, the action that WAF takes when
	// a web request matches all conditions in a rule.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

The action that WAF takes when a web request matches all conditions in the rule, such as allow, block, or count the request.

func (AwsWafRegionalWebAclRulesListActionDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafRegionalWebAclRulesListActionDetails) SetType added in v1.42.9

SetType sets the Type field's value.

func (AwsWafRegionalWebAclRulesListActionDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafRegionalWebAclRulesListDetails added in v1.42.9

type AwsWafRegionalWebAclRulesListDetails struct {

	// The action that WAF takes when a web request matches all conditions in the
	// rule, such as allow, block, or count the request.
	Action *AwsWafRegionalWebAclRulesListActionDetails `type:"structure"`

	// Overrides the rule evaluation result in the rule group.
	OverrideAction *AwsWafRegionalWebAclRulesListOverrideActionDetails `type:"structure"`

	// The order in which WAF evaluates the rules in a web ACL.
	Priority *int64 `type:"integer"`

	// The ID of an WAF Regional rule to associate with a web ACL.
	RuleId *string `type:"string"`

	// For actions that are associated with a rule, the action that WAF takes when
	// a web request matches all conditions in a rule.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count.

func (AwsWafRegionalWebAclRulesListDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafRegionalWebAclRulesListDetails) SetAction added in v1.42.9

SetAction sets the Action field's value.

func (*AwsWafRegionalWebAclRulesListDetails) SetOverrideAction added in v1.42.9

SetOverrideAction sets the OverrideAction field's value.

func (*AwsWafRegionalWebAclRulesListDetails) SetPriority added in v1.42.9

SetPriority sets the Priority field's value.

func (*AwsWafRegionalWebAclRulesListDetails) SetRuleId added in v1.42.9

SetRuleId sets the RuleId field's value.

func (*AwsWafRegionalWebAclRulesListDetails) SetType added in v1.42.9

SetType sets the Type field's value.

func (AwsWafRegionalWebAclRulesListDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafRegionalWebAclRulesListOverrideActionDetails added in v1.42.9

type AwsWafRegionalWebAclRulesListOverrideActionDetails struct {

	// Overrides the rule evaluation result in the rule group.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the action to use in the place of the action that results from the rule group evaluation.

func (AwsWafRegionalWebAclRulesListOverrideActionDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafRegionalWebAclRulesListOverrideActionDetails) SetType added in v1.42.9

SetType sets the Type field's value.

func (AwsWafRegionalWebAclRulesListOverrideActionDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafRuleDetails added in v1.42.9

type AwsWafRuleDetails struct {

	// The name of the metrics for this rule.
	MetricName *string `type:"string"`

	// A descriptive name for the rule.
	Name *string `type:"string"`

	// Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet,
	// GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule
	// and, for each object, indicates whether you want to negate the settings.
	PredicateList []*AwsWafRulePredicateListDetails `type:"list"`

	// The ID of the WAF rule.
	RuleId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a WAF rule. This rule specifies the web requests that you want to allow, block, or count.

func (AwsWafRuleDetails) GoString added in v1.42.9

func (s AwsWafRuleDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafRuleDetails) SetMetricName added in v1.42.9

func (s *AwsWafRuleDetails) SetMetricName(v string) *AwsWafRuleDetails

SetMetricName sets the MetricName field's value.

func (*AwsWafRuleDetails) SetName added in v1.42.9

SetName sets the Name field's value.

func (*AwsWafRuleDetails) SetPredicateList added in v1.42.9

SetPredicateList sets the PredicateList field's value.

func (*AwsWafRuleDetails) SetRuleId added in v1.42.9

func (s *AwsWafRuleDetails) SetRuleId(v string) *AwsWafRuleDetails

SetRuleId sets the RuleId field's value.

func (AwsWafRuleDetails) String added in v1.42.9

func (s AwsWafRuleDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafRuleGroupDetails added in v1.42.9

type AwsWafRuleGroupDetails struct {

	// The name of the metrics for this rule group.
	MetricName *string `type:"string"`

	// The name of the rule group.
	Name *string `type:"string"`

	// The ID of the rule group.
	RuleGroupId *string `type:"string"`

	// Provides information about the rules attached to the rule group. These rules
	// identify the web requests that you want to allow, block, or count.
	Rules []*AwsWafRuleGroupRulesDetails `type:"list"`
	// contains filtered or unexported fields
}

Provides information about an WAF rule group. A rule group is a collection of rules for inspecting and controlling web requests.

func (AwsWafRuleGroupDetails) GoString added in v1.42.9

func (s AwsWafRuleGroupDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafRuleGroupDetails) SetMetricName added in v1.42.9

SetMetricName sets the MetricName field's value.

func (*AwsWafRuleGroupDetails) SetName added in v1.42.9

SetName sets the Name field's value.

func (*AwsWafRuleGroupDetails) SetRuleGroupId added in v1.42.9

SetRuleGroupId sets the RuleGroupId field's value.

func (*AwsWafRuleGroupDetails) SetRules added in v1.42.9

SetRules sets the Rules field's value.

func (AwsWafRuleGroupDetails) String added in v1.42.9

func (s AwsWafRuleGroupDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafRuleGroupRulesActionDetails added in v1.42.9

type AwsWafRuleGroupRulesActionDetails struct {

	// The action that WAF should take on a web request when it matches the rule's
	// statement.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about what action WAF should take on a web request when it matches the criteria defined in the rule.

func (AwsWafRuleGroupRulesActionDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafRuleGroupRulesActionDetails) SetType added in v1.42.9

SetType sets the Type field's value.

func (AwsWafRuleGroupRulesActionDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafRuleGroupRulesDetails added in v1.42.9

type AwsWafRuleGroupRulesDetails struct {

	// Provides information about what action WAF should take on a web request when
	// it matches the criteria defined in the rule.
	Action *AwsWafRuleGroupRulesActionDetails `type:"structure"`

	// If you define more than one rule in a web ACL, WAF evaluates each request
	// against the rules in order based on the value of Priority.
	Priority *int64 `type:"integer"`

	// The rule ID for a rule.
	RuleId *string `type:"string"`

	// The type of rule.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the rules attached to the rule group. These rules identify the web requests that you want to allow, block, or count.

func (AwsWafRuleGroupRulesDetails) GoString added in v1.42.9

func (s AwsWafRuleGroupRulesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafRuleGroupRulesDetails) SetAction added in v1.42.9

SetAction sets the Action field's value.

func (*AwsWafRuleGroupRulesDetails) SetPriority added in v1.42.9

SetPriority sets the Priority field's value.

func (*AwsWafRuleGroupRulesDetails) SetRuleId added in v1.42.9

SetRuleId sets the RuleId field's value.

func (*AwsWafRuleGroupRulesDetails) SetType added in v1.42.9

SetType sets the Type field's value.

func (AwsWafRuleGroupRulesDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafRulePredicateListDetails added in v1.42.9

type AwsWafRulePredicateListDetails struct {

	// A unique identifier for a predicate in a rule, such as ByteMatchSetId or
	// IPSetId.
	DataId *string `type:"string"`

	// Specifies if you want WAF to allow, block, or count requests based on the
	// settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet,
	// GeoMatchSet, or SizeConstraintSet.
	Negated *bool `type:"boolean"`

	// The type of predicate in a rule, such as ByteMatch or IPSet.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you want to negate the settings.

func (AwsWafRulePredicateListDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafRulePredicateListDetails) SetDataId added in v1.42.9

SetDataId sets the DataId field's value.

func (*AwsWafRulePredicateListDetails) SetNegated added in v1.42.9

SetNegated sets the Negated field's value.

func (*AwsWafRulePredicateListDetails) SetType added in v1.42.9

SetType sets the Type field's value.

func (AwsWafRulePredicateListDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafWebAclDetails

type AwsWafWebAclDetails struct {

	// The action to perform if none of the rules contained in the web ACL match.
	DefaultAction *string `type:"string"`

	// A friendly name or description of the web ACL. You can't change the name
	// of a web ACL after you create it.
	Name *string `type:"string"`

	// An array that contains the action for each rule in a web ACL, the priority
	// of the rule, and the ID of the rule.
	Rules []*AwsWafWebAclRule `type:"list"`

	// A unique identifier for a web ACL.
	WebAclId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about an WAF web access control list (web ACL).

func (AwsWafWebAclDetails) GoString

func (s AwsWafWebAclDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafWebAclDetails) SetDefaultAction

func (s *AwsWafWebAclDetails) SetDefaultAction(v string) *AwsWafWebAclDetails

SetDefaultAction sets the DefaultAction field's value.

func (*AwsWafWebAclDetails) SetName

SetName sets the Name field's value.

func (*AwsWafWebAclDetails) SetRules

SetRules sets the Rules field's value.

func (*AwsWafWebAclDetails) SetWebAclId

func (s *AwsWafWebAclDetails) SetWebAclId(v string) *AwsWafWebAclDetails

SetWebAclId sets the WebAclId field's value.

func (AwsWafWebAclDetails) String

func (s AwsWafWebAclDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafWebAclRule

type AwsWafWebAclRule struct {

	// Specifies the action that CloudFront or WAF takes when a web request matches
	// the conditions in the rule.
	Action *WafAction `type:"structure"`

	// Rules to exclude from a rule group.
	ExcludedRules []*WafExcludedRule `type:"list"`

	// Use the OverrideAction to test your RuleGroup.
	//
	// Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction
	// to None, the RuleGroup blocks a request if any individual rule in the RuleGroup
	// matches the request and is configured to block that request.
	//
	// However, if you first want to test the RuleGroup, set the OverrideAction
	// to Count. The RuleGroup then overrides any block action specified by individual
	// rules contained within the group. Instead of blocking matching requests,
	// those requests are counted.
	//
	// ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup
	// to a web ACL. In this case you do not use ActivatedRule Action. For all other
	// update requests, ActivatedRule Action is used instead of ActivatedRule OverrideAction.
	OverrideAction *WafOverrideAction `type:"structure"`

	// Specifies the order in which the rules in a web ACL are evaluated. Rules
	// with a lower value for Priority are evaluated before rules with a higher
	// value. The value must be a unique integer. If you add multiple rules to a
	// web ACL, the values do not need to be consecutive.
	Priority *int64 `type:"integer"`

	// The identifier for a rule.
	RuleId *string `type:"string"`

	// The rule type.
	//
	// Valid values: REGULAR | RATE_BASED | GROUP
	//
	// The default is REGULAR.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Details for a rule in an WAF web ACL.

func (AwsWafWebAclRule) GoString

func (s AwsWafWebAclRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafWebAclRule) SetAction

func (s *AwsWafWebAclRule) SetAction(v *WafAction) *AwsWafWebAclRule

SetAction sets the Action field's value.

func (*AwsWafWebAclRule) SetExcludedRules

func (s *AwsWafWebAclRule) SetExcludedRules(v []*WafExcludedRule) *AwsWafWebAclRule

SetExcludedRules sets the ExcludedRules field's value.

func (*AwsWafWebAclRule) SetOverrideAction

func (s *AwsWafWebAclRule) SetOverrideAction(v *WafOverrideAction) *AwsWafWebAclRule

SetOverrideAction sets the OverrideAction field's value.

func (*AwsWafWebAclRule) SetPriority

func (s *AwsWafWebAclRule) SetPriority(v int64) *AwsWafWebAclRule

SetPriority sets the Priority field's value.

func (*AwsWafWebAclRule) SetRuleId

func (s *AwsWafWebAclRule) SetRuleId(v string) *AwsWafWebAclRule

SetRuleId sets the RuleId field's value.

func (*AwsWafWebAclRule) SetType

func (s *AwsWafWebAclRule) SetType(v string) *AwsWafWebAclRule

SetType sets the Type field's value.

func (AwsWafWebAclRule) String

func (s AwsWafWebAclRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafv2ActionAllowDetails added in v1.42.9

type AwsWafv2ActionAllowDetails struct {

	// Defines custom handling for the web request. For information about customizing
	// web requests and responses, see Customizing web requests and responses in
	// WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
	// in the WAF Developer Guide..
	CustomRequestHandling *AwsWafv2CustomRequestHandlingDetails `type:"structure"`
	// contains filtered or unexported fields
}

Specifies that WAF should allow the request and optionally defines additional custom handling for the request.

func (AwsWafv2ActionAllowDetails) GoString added in v1.42.9

func (s AwsWafv2ActionAllowDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafv2ActionAllowDetails) SetCustomRequestHandling added in v1.42.9

SetCustomRequestHandling sets the CustomRequestHandling field's value.

func (AwsWafv2ActionAllowDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafv2ActionBlockDetails added in v1.42.9

type AwsWafv2ActionBlockDetails struct {

	// Defines a custom response for the web request. For information, see Customizing
	// web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
	// in the WAF Developer Guide..
	CustomResponse *AwsWafv2CustomResponseDetails `type:"structure"`
	// contains filtered or unexported fields
}

Specifies that WAF should block the request and optionally defines additional custom handling for the response to the web request.

func (AwsWafv2ActionBlockDetails) GoString added in v1.42.9

func (s AwsWafv2ActionBlockDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafv2ActionBlockDetails) SetCustomResponse added in v1.42.9

SetCustomResponse sets the CustomResponse field's value.

func (AwsWafv2ActionBlockDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafv2CustomHttpHeader added in v1.42.9

type AwsWafv2CustomHttpHeader struct {

	// The name of the custom header.
	Name *string `type:"string"`

	// The value of the custom header.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A custom header for custom request and response handling.

func (AwsWafv2CustomHttpHeader) GoString added in v1.42.9

func (s AwsWafv2CustomHttpHeader) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafv2CustomHttpHeader) SetName added in v1.42.9

SetName sets the Name field's value.

func (*AwsWafv2CustomHttpHeader) SetValue added in v1.42.9

SetValue sets the Value field's value.

func (AwsWafv2CustomHttpHeader) String added in v1.42.9

func (s AwsWafv2CustomHttpHeader) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafv2CustomRequestHandlingDetails added in v1.42.9

type AwsWafv2CustomRequestHandlingDetails struct {

	// The HTTP headers to insert into the request.
	InsertHeaders []*AwsWafv2CustomHttpHeader `type:"list"`
	// contains filtered or unexported fields
}

Custom request handling behavior that inserts custom headers into a web request. WAF uses custom request handling when the rule action doesn't block the request.

func (AwsWafv2CustomRequestHandlingDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafv2CustomRequestHandlingDetails) SetInsertHeaders added in v1.42.9

SetInsertHeaders sets the InsertHeaders field's value.

func (AwsWafv2CustomRequestHandlingDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafv2CustomResponseDetails added in v1.42.9

type AwsWafv2CustomResponseDetails struct {

	// References the response body that you want WAF to return to the web request
	// client. You can define a custom response for a rule action or a default web
	// ACL action that is set to block.
	CustomResponseBodyKey *string `type:"string"`

	// The HTTP status code to return to the client. For a list of status codes
	// that you can use in your custom responses, see Supported status codes for
	// custom response (https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html)
	// in the WAF Developer Guide.
	ResponseCode *int64 `type:"integer"`

	// The HTTP headers to use in the response.
	ResponseHeaders []*AwsWafv2CustomHttpHeader `type:"list"`
	// contains filtered or unexported fields
}

A custom response to send to the client. You can define a custom response for rule actions and default web ACL actions that are set to block.

func (AwsWafv2CustomResponseDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafv2CustomResponseDetails) SetCustomResponseBodyKey added in v1.42.9

func (s *AwsWafv2CustomResponseDetails) SetCustomResponseBodyKey(v string) *AwsWafv2CustomResponseDetails

SetCustomResponseBodyKey sets the CustomResponseBodyKey field's value.

func (*AwsWafv2CustomResponseDetails) SetResponseCode added in v1.42.9

SetResponseCode sets the ResponseCode field's value.

func (*AwsWafv2CustomResponseDetails) SetResponseHeaders added in v1.42.9

SetResponseHeaders sets the ResponseHeaders field's value.

func (AwsWafv2CustomResponseDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafv2RuleGroupDetails added in v1.42.9

type AwsWafv2RuleGroupDetails struct {

	// The Amazon Resource Name (ARN) of the entity.
	Arn *string `type:"string"`

	// The web ACL capacity units (WCUs) required for this rule group.
	Capacity *int64 `type:"long"`

	// A description of the rule group that helps with identification.
	Description *string `type:"string"`

	// A unique identifier for the rule group.
	Id *string `type:"string"`

	// The name of the rule group. You cannot change the name of a rule group after
	// you create it.
	Name *string `type:"string"`

	// The Rule statements used to identify the web requests that you want to allow,
	// block, or count. Each rule includes one top-level statement that WAF uses
	// to identify matching web requests, and parameters that govern how WAF handles
	// them.
	Rules []*AwsWafv2RulesDetails `type:"list"`

	// Specifies whether the rule group is for an Amazon CloudFront distribution
	// or for a regional application. A regional application can be an Application
	// Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API,
	// or an Amazon Cognito user pool.
	Scope *string `type:"string"`

	// Defines and enables Amazon CloudWatch metrics and web request sample collection.
	VisibilityConfig *AwsWafv2VisibilityConfigDetails `type:"structure"`
	// contains filtered or unexported fields
}

Details about an WAFv2 rule group.

func (AwsWafv2RuleGroupDetails) GoString added in v1.42.9

func (s AwsWafv2RuleGroupDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafv2RuleGroupDetails) SetArn added in v1.42.9

SetArn sets the Arn field's value.

func (*AwsWafv2RuleGroupDetails) SetCapacity added in v1.42.9

SetCapacity sets the Capacity field's value.

func (*AwsWafv2RuleGroupDetails) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*AwsWafv2RuleGroupDetails) SetId added in v1.42.9

SetId sets the Id field's value.

func (*AwsWafv2RuleGroupDetails) SetName added in v1.42.9

SetName sets the Name field's value.

func (*AwsWafv2RuleGroupDetails) SetRules added in v1.42.9

SetRules sets the Rules field's value.

func (*AwsWafv2RuleGroupDetails) SetScope added in v1.42.9

SetScope sets the Scope field's value.

func (*AwsWafv2RuleGroupDetails) SetVisibilityConfig added in v1.42.9

SetVisibilityConfig sets the VisibilityConfig field's value.

func (AwsWafv2RuleGroupDetails) String added in v1.42.9

func (s AwsWafv2RuleGroupDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafv2RulesActionCaptchaDetails added in v1.42.9

type AwsWafv2RulesActionCaptchaDetails struct {

	// Defines custom handling for the web request, used when the CAPTCHA inspection
	// determines that the request's token is valid and unexpired. For more information,
	// see Customizing web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
	// in the WAF Developer Guide..
	CustomRequestHandling *AwsWafv2CustomRequestHandlingDetails `type:"structure"`
	// contains filtered or unexported fields
}

Specifies that WAF should run a CAPTCHA check against the request.

func (AwsWafv2RulesActionCaptchaDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafv2RulesActionCaptchaDetails) SetCustomRequestHandling added in v1.42.9

SetCustomRequestHandling sets the CustomRequestHandling field's value.

func (AwsWafv2RulesActionCaptchaDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafv2RulesActionCountDetails added in v1.42.9

type AwsWafv2RulesActionCountDetails struct {

	// Defines custom handling for the web request. For more information, see Customizing
	// web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
	// in the WAF Developer Guide..
	CustomRequestHandling *AwsWafv2CustomRequestHandlingDetails `type:"structure"`
	// contains filtered or unexported fields
}

Specifies that WAF should count the request.

func (AwsWafv2RulesActionCountDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafv2RulesActionCountDetails) SetCustomRequestHandling added in v1.42.9

SetCustomRequestHandling sets the CustomRequestHandling field's value.

func (AwsWafv2RulesActionCountDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafv2RulesActionDetails added in v1.42.9

type AwsWafv2RulesActionDetails struct {

	// Instructs WAF to allow the web request.
	Allow *AwsWafv2ActionAllowDetails `type:"structure"`

	// Instructs WAF to block the web request.
	Block *AwsWafv2ActionBlockDetails `type:"structure"`

	// Instructs WAF to run a CAPTCHA check against the web request.
	Captcha *AwsWafv2RulesActionCaptchaDetails `type:"structure"`

	// Instructs WAF to count the web request and then continue evaluating the request
	// using the remaining rules in the web ACL.
	Count *AwsWafv2RulesActionCountDetails `type:"structure"`
	// contains filtered or unexported fields
}

The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.

func (AwsWafv2RulesActionDetails) GoString added in v1.42.9

func (s AwsWafv2RulesActionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafv2RulesActionDetails) SetAllow added in v1.42.9

SetAllow sets the Allow field's value.

func (*AwsWafv2RulesActionDetails) SetBlock added in v1.42.9

SetBlock sets the Block field's value.

func (*AwsWafv2RulesActionDetails) SetCaptcha added in v1.42.9

SetCaptcha sets the Captcha field's value.

func (*AwsWafv2RulesActionDetails) SetCount added in v1.42.9

SetCount sets the Count field's value.

func (AwsWafv2RulesActionDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafv2RulesDetails added in v1.42.9

type AwsWafv2RulesDetails struct {

	// The action that WAF should take on a web request when it matches the rule
	// statement. Settings at the web ACL level can override the rule action setting.
	Action *AwsWafv2RulesActionDetails `type:"structure"`

	// The name of the rule.
	Name *string `type:"string"`

	// The action to use in the place of the action that results from the rule group
	// evaluation.
	OverrideAction *string `type:"string"`

	// If you define more than one Rule in a WebACL, WAF evaluates each request
	// against the Rules in order based on the value of Priority. WAF processes
	// rules with lower priority first. The priorities don't need to be consecutive,
	// but they must all be different.
	Priority *int64 `type:"integer"`

	// Defines and enables Amazon CloudWatch metrics and web request sample collection.
	VisibilityConfig *AwsWafv2VisibilityConfigDetails `type:"structure"`
	// contains filtered or unexported fields
}

Provides details about rules in a rule group. A rule identifies web requests that you want to allow, block, or count. Each rule includes one top-level Statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

func (AwsWafv2RulesDetails) GoString added in v1.42.9

func (s AwsWafv2RulesDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafv2RulesDetails) SetAction added in v1.42.9

SetAction sets the Action field's value.

func (*AwsWafv2RulesDetails) SetName added in v1.42.9

SetName sets the Name field's value.

func (*AwsWafv2RulesDetails) SetOverrideAction added in v1.42.9

func (s *AwsWafv2RulesDetails) SetOverrideAction(v string) *AwsWafv2RulesDetails

SetOverrideAction sets the OverrideAction field's value.

func (*AwsWafv2RulesDetails) SetPriority added in v1.42.9

func (s *AwsWafv2RulesDetails) SetPriority(v int64) *AwsWafv2RulesDetails

SetPriority sets the Priority field's value.

func (*AwsWafv2RulesDetails) SetVisibilityConfig added in v1.42.9

SetVisibilityConfig sets the VisibilityConfig field's value.

func (AwsWafv2RulesDetails) String added in v1.42.9

func (s AwsWafv2RulesDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafv2VisibilityConfigDetails added in v1.42.9

type AwsWafv2VisibilityConfigDetails struct {

	// A boolean indicating whether the associated resource sends metrics to Amazon
	// CloudWatch. For the list of available metrics, see WAF metrics and dimensions
	// (https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics)
	// in the WAF Developer Guide.
	CloudWatchMetricsEnabled *bool `type:"boolean"`

	// A name of the Amazon CloudWatch metric.
	MetricName *string `type:"string"`

	// A boolean indicating whether WAF should store a sampling of the web requests
	// that match the rules. You can view the sampled requests through the WAF console.
	SampledRequestsEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Defines and enables Amazon CloudWatch metrics and web request sample collection.

func (AwsWafv2VisibilityConfigDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafv2VisibilityConfigDetails) SetCloudWatchMetricsEnabled added in v1.42.9

func (s *AwsWafv2VisibilityConfigDetails) SetCloudWatchMetricsEnabled(v bool) *AwsWafv2VisibilityConfigDetails

SetCloudWatchMetricsEnabled sets the CloudWatchMetricsEnabled field's value.

func (*AwsWafv2VisibilityConfigDetails) SetMetricName added in v1.42.9

SetMetricName sets the MetricName field's value.

func (*AwsWafv2VisibilityConfigDetails) SetSampledRequestsEnabled added in v1.42.9

func (s *AwsWafv2VisibilityConfigDetails) SetSampledRequestsEnabled(v bool) *AwsWafv2VisibilityConfigDetails

SetSampledRequestsEnabled sets the SampledRequestsEnabled field's value.

func (AwsWafv2VisibilityConfigDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafv2WebAclActionDetails added in v1.42.9

type AwsWafv2WebAclActionDetails struct {

	// Specifies that WAF should allow requests by default.
	Allow *AwsWafv2ActionAllowDetails `type:"structure"`

	// Specifies that WAF should block requests by default.
	Block *AwsWafv2ActionBlockDetails `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the action that Amazon CloudFront or WAF takes when a web request matches the conditions in the rule.

func (AwsWafv2WebAclActionDetails) GoString added in v1.42.9

func (s AwsWafv2WebAclActionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafv2WebAclActionDetails) SetAllow added in v1.42.9

SetAllow sets the Allow field's value.

func (*AwsWafv2WebAclActionDetails) SetBlock added in v1.42.9

SetBlock sets the Block field's value.

func (AwsWafv2WebAclActionDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafv2WebAclCaptchaConfigDetails added in v1.42.9

type AwsWafv2WebAclCaptchaConfigDetails struct {

	// Determines how long a CAPTCHA timestamp in the token remains valid after
	// the client successfully solves a CAPTCHA puzzle.
	ImmunityTimeProperty *AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails `type:"structure"`
	// contains filtered or unexported fields
}

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings.

func (AwsWafv2WebAclCaptchaConfigDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafv2WebAclCaptchaConfigDetails) SetImmunityTimeProperty added in v1.42.9

SetImmunityTimeProperty sets the ImmunityTimeProperty field's value.

func (AwsWafv2WebAclCaptchaConfigDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails added in v1.42.9

type AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails struct {

	// The amount of time, in seconds, that a CAPTCHA or challenge timestamp is
	// considered valid by WAF.
	ImmunityTime *int64 `type:"long"`
	// contains filtered or unexported fields
}

Used for CAPTCHA and challenge token settings. Determines how long a CAPTCHA or challenge timestamp remains valid after WAF updates it for a successful CAPTCHA or challenge response.

func (AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails) SetImmunityTime added in v1.42.9

SetImmunityTime sets the ImmunityTime field's value.

func (AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsWafv2WebAclDetails added in v1.42.9

type AwsWafv2WebAclDetails struct {

	// The Amazon Resource Name (ARN) of the web ACL that you want to associate
	// with the resource.
	Arn *string `type:"string"`

	// The web ACL capacity units (WCUs) currently being used by this web ACL.
	Capacity *int64 `type:"long"`

	// Specifies how WAF should handle CAPTCHA evaluations for rules that don't
	// have their own CaptchaConfig settings.
	CaptchaConfig *AwsWafv2WebAclCaptchaConfigDetails `type:"structure"`

	// The action to perform if none of the Rules contained in the web ACL match.
	DefaultAction *AwsWafv2WebAclActionDetails `type:"structure"`

	// A description of the web ACL that helps with identification.
	Description *string `type:"string"`

	// A unique identifier for the web ACL.
	Id *string `type:"string"`

	// Indicates whether this web ACL is managed by Firewall Manager.
	ManagedbyFirewallManager *bool `type:"boolean"`

	// The name of the web ACL.
	Name *string `type:"string"`

	// The Rule statements used to identify the web requests that you want to allow,
	// block, or count. Each rule includes one top-level statement that WAF uses
	// to identify matching web requests, and parameters that govern how WAF handles
	// them.
	Rules []*AwsWafv2RulesDetails `type:"list"`

	// Defines and enables Amazon CloudWatch metrics and web request sample collection.
	VisibilityConfig *AwsWafv2VisibilityConfigDetails `type:"structure"`
	// contains filtered or unexported fields
}

Details about an WAFv2 web Access Control List (ACL).

func (AwsWafv2WebAclDetails) GoString added in v1.42.9

func (s AwsWafv2WebAclDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsWafv2WebAclDetails) SetArn added in v1.42.9

SetArn sets the Arn field's value.

func (*AwsWafv2WebAclDetails) SetCapacity added in v1.42.9

SetCapacity sets the Capacity field's value.

func (*AwsWafv2WebAclDetails) SetCaptchaConfig added in v1.42.9

SetCaptchaConfig sets the CaptchaConfig field's value.

func (*AwsWafv2WebAclDetails) SetDefaultAction added in v1.42.9

SetDefaultAction sets the DefaultAction field's value.

func (*AwsWafv2WebAclDetails) SetDescription added in v1.42.9

func (s *AwsWafv2WebAclDetails) SetDescription(v string) *AwsWafv2WebAclDetails

SetDescription sets the Description field's value.

func (*AwsWafv2WebAclDetails) SetId added in v1.42.9

SetId sets the Id field's value.

func (*AwsWafv2WebAclDetails) SetManagedbyFirewallManager added in v1.42.9

func (s *AwsWafv2WebAclDetails) SetManagedbyFirewallManager(v bool) *AwsWafv2WebAclDetails

SetManagedbyFirewallManager sets the ManagedbyFirewallManager field's value.

func (*AwsWafv2WebAclDetails) SetName added in v1.42.9

SetName sets the Name field's value.

func (*AwsWafv2WebAclDetails) SetRules added in v1.42.9

SetRules sets the Rules field's value.

func (*AwsWafv2WebAclDetails) SetVisibilityConfig added in v1.42.9

SetVisibilityConfig sets the VisibilityConfig field's value.

func (AwsWafv2WebAclDetails) String added in v1.42.9

func (s AwsWafv2WebAclDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsXrayEncryptionConfigDetails

type AwsXrayEncryptionConfigDetails struct {

	// The identifier of the KMS key that is used for encryption. Provided if Type
	// is KMS.
	KeyId *string `type:"string"`

	// The current status of the encryption configuration. Valid values are ACTIVE
	// or UPDATING.
	//
	// When Status is equal to UPDATING, X-Ray might use both the old and new encryption.
	Status *string `type:"string"`

	// The type of encryption. KMS indicates that the encryption uses KMS keys.
	// NONE indicates the default encryption.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the encryption configuration for X-Ray.

func (AwsXrayEncryptionConfigDetails) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsXrayEncryptionConfigDetails) SetKeyId

SetKeyId sets the KeyId field's value.

func (*AwsXrayEncryptionConfigDetails) SetStatus

SetStatus sets the Status field's value.

func (*AwsXrayEncryptionConfigDetails) SetType

SetType sets the Type field's value.

func (AwsXrayEncryptionConfigDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchDeleteAutomationRulesInput added in v1.42.9

type BatchDeleteAutomationRulesInput struct {

	// A list of Amazon Resource Names (ARNs) for the rules that are to be deleted.
	//
	// AutomationRulesArns is a required field
	AutomationRulesArns []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDeleteAutomationRulesInput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteAutomationRulesInput) SetAutomationRulesArns added in v1.42.9

SetAutomationRulesArns sets the AutomationRulesArns field's value.

func (BatchDeleteAutomationRulesInput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteAutomationRulesInput) Validate added in v1.42.9

func (s *BatchDeleteAutomationRulesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDeleteAutomationRulesOutput added in v1.42.9

type BatchDeleteAutomationRulesOutput struct {

	// A list of properly processed rule ARNs.
	ProcessedAutomationRules []*string `min:"1" type:"list"`

	// A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter
	// tells you which automation rules the request didn't delete and why.
	UnprocessedAutomationRules []*UnprocessedAutomationRule `type:"list"`
	// contains filtered or unexported fields
}

func (BatchDeleteAutomationRulesOutput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteAutomationRulesOutput) SetProcessedAutomationRules added in v1.42.9

func (s *BatchDeleteAutomationRulesOutput) SetProcessedAutomationRules(v []*string) *BatchDeleteAutomationRulesOutput

SetProcessedAutomationRules sets the ProcessedAutomationRules field's value.

func (*BatchDeleteAutomationRulesOutput) SetUnprocessedAutomationRules added in v1.42.9

SetUnprocessedAutomationRules sets the UnprocessedAutomationRules field's value.

func (BatchDeleteAutomationRulesOutput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchDisableStandardsInput

type BatchDisableStandardsInput struct {

	// The ARNs of the standards subscriptions to disable.
	//
	// StandardsSubscriptionArns is a required field
	StandardsSubscriptionArns []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDisableStandardsInput) GoString

func (s BatchDisableStandardsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDisableStandardsInput) SetStandardsSubscriptionArns

func (s *BatchDisableStandardsInput) SetStandardsSubscriptionArns(v []*string) *BatchDisableStandardsInput

SetStandardsSubscriptionArns sets the StandardsSubscriptionArns field's value.

func (BatchDisableStandardsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDisableStandardsInput) Validate

func (s *BatchDisableStandardsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDisableStandardsOutput

type BatchDisableStandardsOutput struct {

	// The details of the standards subscriptions that were disabled.
	StandardsSubscriptions []*StandardsSubscription `type:"list"`
	// contains filtered or unexported fields
}

func (BatchDisableStandardsOutput) GoString

func (s BatchDisableStandardsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDisableStandardsOutput) SetStandardsSubscriptions

SetStandardsSubscriptions sets the StandardsSubscriptions field's value.

func (BatchDisableStandardsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchEnableStandardsInput

type BatchEnableStandardsInput struct {

	// The list of standards checks to enable.
	//
	// StandardsSubscriptionRequests is a required field
	StandardsSubscriptionRequests []*StandardsSubscriptionRequest `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchEnableStandardsInput) GoString

func (s BatchEnableStandardsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchEnableStandardsInput) SetStandardsSubscriptionRequests

func (s *BatchEnableStandardsInput) SetStandardsSubscriptionRequests(v []*StandardsSubscriptionRequest) *BatchEnableStandardsInput

SetStandardsSubscriptionRequests sets the StandardsSubscriptionRequests field's value.

func (BatchEnableStandardsInput) String

func (s BatchEnableStandardsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchEnableStandardsInput) Validate

func (s *BatchEnableStandardsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchEnableStandardsOutput

type BatchEnableStandardsOutput struct {

	// The details of the standards subscriptions that were enabled.
	StandardsSubscriptions []*StandardsSubscription `type:"list"`
	// contains filtered or unexported fields
}

func (BatchEnableStandardsOutput) GoString

func (s BatchEnableStandardsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchEnableStandardsOutput) SetStandardsSubscriptions

SetStandardsSubscriptions sets the StandardsSubscriptions field's value.

func (BatchEnableStandardsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetAutomationRulesInput added in v1.42.9

type BatchGetAutomationRulesInput struct {

	// A list of rule ARNs to get details for.
	//
	// AutomationRulesArns is a required field
	AutomationRulesArns []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetAutomationRulesInput) GoString added in v1.42.9

func (s BatchGetAutomationRulesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAutomationRulesInput) SetAutomationRulesArns added in v1.42.9

func (s *BatchGetAutomationRulesInput) SetAutomationRulesArns(v []*string) *BatchGetAutomationRulesInput

SetAutomationRulesArns sets the AutomationRulesArns field's value.

func (BatchGetAutomationRulesInput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAutomationRulesInput) Validate added in v1.42.9

func (s *BatchGetAutomationRulesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchGetAutomationRulesOutput added in v1.42.9

type BatchGetAutomationRulesOutput struct {

	// A list of rule details for the provided rule ARNs.
	Rules []*AutomationRulesConfig `type:"list"`

	// A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter
	// tells you which automation rules the request didn't retrieve and why.
	UnprocessedAutomationRules []*UnprocessedAutomationRule `type:"list"`
	// contains filtered or unexported fields
}

func (BatchGetAutomationRulesOutput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAutomationRulesOutput) SetRules added in v1.42.9

SetRules sets the Rules field's value.

func (*BatchGetAutomationRulesOutput) SetUnprocessedAutomationRules added in v1.42.9

SetUnprocessedAutomationRules sets the UnprocessedAutomationRules field's value.

func (BatchGetAutomationRulesOutput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetSecurityControlsInput added in v1.42.9

type BatchGetSecurityControlsInput struct {

	// A list of security controls (identified with SecurityControlId, SecurityControlArn,
	// or a mix of both parameters). The security control ID or Amazon Resource
	// Name (ARN) is the same across standards.
	//
	// SecurityControlIds is a required field
	SecurityControlIds []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetSecurityControlsInput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetSecurityControlsInput) SetSecurityControlIds added in v1.42.9

func (s *BatchGetSecurityControlsInput) SetSecurityControlIds(v []*string) *BatchGetSecurityControlsInput

SetSecurityControlIds sets the SecurityControlIds field's value.

func (BatchGetSecurityControlsInput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetSecurityControlsInput) Validate added in v1.42.9

func (s *BatchGetSecurityControlsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchGetSecurityControlsOutput added in v1.42.9

type BatchGetSecurityControlsOutput struct {

	// An array that returns the identifier, Amazon Resource Name (ARN), and other
	// details about a security control. The same information is returned whether
	// the request includes SecurityControlId or SecurityControlArn.
	//
	// SecurityControls is a required field
	SecurityControls []*SecurityControl `type:"list" required:"true"`

	// A security control (identified with SecurityControlId, SecurityControlArn,
	// or a mix of both parameters) for which details cannot be returned.
	UnprocessedIds []*UnprocessedSecurityControl `type:"list"`
	// contains filtered or unexported fields
}

func (BatchGetSecurityControlsOutput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetSecurityControlsOutput) SetSecurityControls added in v1.42.9

SetSecurityControls sets the SecurityControls field's value.

func (*BatchGetSecurityControlsOutput) SetUnprocessedIds added in v1.42.9

SetUnprocessedIds sets the UnprocessedIds field's value.

func (BatchGetSecurityControlsOutput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetStandardsControlAssociationsInput added in v1.42.9

type BatchGetStandardsControlAssociationsInput struct {

	// An array with one or more objects that includes a security control (identified
	// with SecurityControlId, SecurityControlArn, or a mix of both parameters)
	// and the Amazon Resource Name (ARN) of a standard. This field is used to query
	// the enablement status of a control in a specified standard. The security
	// control ID or ARN is the same across standards.
	//
	// StandardsControlAssociationIds is a required field
	StandardsControlAssociationIds []*StandardsControlAssociationId `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetStandardsControlAssociationsInput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetStandardsControlAssociationsInput) SetStandardsControlAssociationIds added in v1.42.9

SetStandardsControlAssociationIds sets the StandardsControlAssociationIds field's value.

func (BatchGetStandardsControlAssociationsInput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetStandardsControlAssociationsInput) Validate added in v1.42.9

Validate inspects the fields of the type to determine if they are valid.

type BatchGetStandardsControlAssociationsOutput added in v1.42.9

type BatchGetStandardsControlAssociationsOutput struct {

	// Provides the enablement status of a security control in a specified standard
	// and other details for the control in relation to the specified standard.
	//
	// StandardsControlAssociationDetails is a required field
	StandardsControlAssociationDetails []*StandardsControlAssociationDetail `type:"list" required:"true"`

	// A security control (identified with SecurityControlId, SecurityControlArn,
	// or a mix of both parameters) whose enablement status in a specified standard
	// cannot be returned.
	UnprocessedAssociations []*UnprocessedStandardsControlAssociation `type:"list"`
	// contains filtered or unexported fields
}

func (BatchGetStandardsControlAssociationsOutput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetStandardsControlAssociationsOutput) SetStandardsControlAssociationDetails added in v1.42.9

SetStandardsControlAssociationDetails sets the StandardsControlAssociationDetails field's value.

func (*BatchGetStandardsControlAssociationsOutput) SetUnprocessedAssociations added in v1.42.9

SetUnprocessedAssociations sets the UnprocessedAssociations field's value.

func (BatchGetStandardsControlAssociationsOutput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchImportFindingsInput

type BatchImportFindingsInput struct {

	// A list of findings to import. To successfully import a finding, it must follow
	// the Amazon Web Services Security Finding Format (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html).
	// Maximum of 100 findings per request.
	//
	// Findings is a required field
	Findings []*AwsSecurityFinding `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchImportFindingsInput) GoString

func (s BatchImportFindingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchImportFindingsInput) SetFindings

SetFindings sets the Findings field's value.

func (BatchImportFindingsInput) String

func (s BatchImportFindingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchImportFindingsInput) Validate

func (s *BatchImportFindingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchImportFindingsOutput

type BatchImportFindingsOutput struct {

	// The number of findings that failed to import.
	//
	// FailedCount is a required field
	FailedCount *int64 `type:"integer" required:"true"`

	// The list of findings that failed to import.
	FailedFindings []*ImportFindingsError `type:"list"`

	// The number of findings that were successfully imported.
	//
	// SuccessCount is a required field
	SuccessCount *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (BatchImportFindingsOutput) GoString

func (s BatchImportFindingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchImportFindingsOutput) SetFailedCount

SetFailedCount sets the FailedCount field's value.

func (*BatchImportFindingsOutput) SetFailedFindings

SetFailedFindings sets the FailedFindings field's value.

func (*BatchImportFindingsOutput) SetSuccessCount

SetSuccessCount sets the SuccessCount field's value.

func (BatchImportFindingsOutput) String

func (s BatchImportFindingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchUpdateAutomationRulesInput added in v1.42.9

type BatchUpdateAutomationRulesInput struct {

	// An array of ARNs for the rules that are to be updated. Optionally, you can
	// also include RuleStatus and RuleOrder.
	//
	// UpdateAutomationRulesRequestItems is a required field
	UpdateAutomationRulesRequestItems []*UpdateAutomationRulesRequestItem `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchUpdateAutomationRulesInput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchUpdateAutomationRulesInput) SetUpdateAutomationRulesRequestItems added in v1.42.9

SetUpdateAutomationRulesRequestItems sets the UpdateAutomationRulesRequestItems field's value.

func (BatchUpdateAutomationRulesInput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchUpdateAutomationRulesInput) Validate added in v1.42.9

func (s *BatchUpdateAutomationRulesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchUpdateAutomationRulesOutput added in v1.42.9

type BatchUpdateAutomationRulesOutput struct {

	// A list of properly processed rule ARNs.
	ProcessedAutomationRules []*string `min:"1" type:"list"`

	// A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter
	// tells you which automation rules the request didn't update and why.
	UnprocessedAutomationRules []*UnprocessedAutomationRule `type:"list"`
	// contains filtered or unexported fields
}

func (BatchUpdateAutomationRulesOutput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchUpdateAutomationRulesOutput) SetProcessedAutomationRules added in v1.42.9

func (s *BatchUpdateAutomationRulesOutput) SetProcessedAutomationRules(v []*string) *BatchUpdateAutomationRulesOutput

SetProcessedAutomationRules sets the ProcessedAutomationRules field's value.

func (*BatchUpdateAutomationRulesOutput) SetUnprocessedAutomationRules added in v1.42.9

SetUnprocessedAutomationRules sets the UnprocessedAutomationRules field's value.

func (BatchUpdateAutomationRulesOutput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchUpdateFindingsInput

type BatchUpdateFindingsInput struct {

	// The updated value for the finding confidence. Confidence is defined as the
	// likelihood that a finding accurately identifies the behavior or issue that
	// it was intended to identify.
	//
	// Confidence is scored on a 0-100 basis using a ratio scale, where 0 means
	// zero percent confidence and 100 means 100 percent confidence.
	Confidence *int64 `type:"integer"`

	// The updated value for the level of importance assigned to the resources associated
	// with the findings.
	//
	// A score of 0 means that the underlying resources have no criticality, and
	// a score of 100 is reserved for the most critical resources.
	Criticality *int64 `type:"integer"`

	// The list of findings to update. BatchUpdateFindings can be used to update
	// up to 100 findings at a time.
	//
	// For each finding, the list provides the finding identifier and the ARN of
	// the finding provider.
	//
	// FindingIdentifiers is a required field
	FindingIdentifiers []*AwsSecurityFindingIdentifier `type:"list" required:"true"`

	// The updated note.
	Note *NoteUpdate `type:"structure"`

	// A list of findings that are related to the updated findings.
	RelatedFindings []*RelatedFinding `type:"list"`

	// Used to update the finding severity.
	Severity *SeverityUpdate `type:"structure"`

	// One or more finding types in the format of namespace/category/classifier
	// that classify a finding.
	//
	// Valid namespace values are as follows.
	//
	//    * Software and Configuration Checks
	//
	//    * TTPs
	//
	//    * Effects
	//
	//    * Unusual Behaviors
	//
	//    * Sensitive Data Identifications
	Types []*string `type:"list"`

	// A list of name/value string pairs associated with the finding. These are
	// custom, user-defined fields added to a finding.
	UserDefinedFields map[string]*string `type:"map"`

	// Indicates the veracity of a finding.
	//
	// The available values for VerificationState are as follows.
	//
	//    * UNKNOWN – The default disposition of a security finding
	//
	//    * TRUE_POSITIVE – The security finding is confirmed
	//
	//    * FALSE_POSITIVE – The security finding was determined to be a false
	//    alarm
	//
	//    * BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding
	//    doesn't pose any threat, is expected, or both
	VerificationState *string `type:"string" enum:"VerificationState"`

	// Used to update the workflow status of a finding.
	//
	// The workflow status indicates the progress of the investigation into the
	// finding.
	Workflow *WorkflowUpdate `type:"structure"`
	// contains filtered or unexported fields
}

func (BatchUpdateFindingsInput) GoString

func (s BatchUpdateFindingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchUpdateFindingsInput) SetConfidence

SetConfidence sets the Confidence field's value.

func (*BatchUpdateFindingsInput) SetCriticality

SetCriticality sets the Criticality field's value.

func (*BatchUpdateFindingsInput) SetFindingIdentifiers

SetFindingIdentifiers sets the FindingIdentifiers field's value.

func (*BatchUpdateFindingsInput) SetNote

SetNote sets the Note field's value.

func (*BatchUpdateFindingsInput) SetRelatedFindings

SetRelatedFindings sets the RelatedFindings field's value.

func (*BatchUpdateFindingsInput) SetSeverity

SetSeverity sets the Severity field's value.

func (*BatchUpdateFindingsInput) SetTypes

SetTypes sets the Types field's value.

func (*BatchUpdateFindingsInput) SetUserDefinedFields

func (s *BatchUpdateFindingsInput) SetUserDefinedFields(v map[string]*string) *BatchUpdateFindingsInput

SetUserDefinedFields sets the UserDefinedFields field's value.

func (*BatchUpdateFindingsInput) SetVerificationState

func (s *BatchUpdateFindingsInput) SetVerificationState(v string) *BatchUpdateFindingsInput

SetVerificationState sets the VerificationState field's value.

func (*BatchUpdateFindingsInput) SetWorkflow

SetWorkflow sets the Workflow field's value.

func (BatchUpdateFindingsInput) String

func (s BatchUpdateFindingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchUpdateFindingsInput) Validate

func (s *BatchUpdateFindingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchUpdateFindingsOutput

type BatchUpdateFindingsOutput struct {

	// The list of findings that were updated successfully.
	//
	// ProcessedFindings is a required field
	ProcessedFindings []*AwsSecurityFindingIdentifier `type:"list" required:"true"`

	// The list of findings that were not updated.
	//
	// UnprocessedFindings is a required field
	UnprocessedFindings []*BatchUpdateFindingsUnprocessedFinding `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchUpdateFindingsOutput) GoString

func (s BatchUpdateFindingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchUpdateFindingsOutput) SetProcessedFindings

SetProcessedFindings sets the ProcessedFindings field's value.

func (*BatchUpdateFindingsOutput) SetUnprocessedFindings

SetUnprocessedFindings sets the UnprocessedFindings field's value.

func (BatchUpdateFindingsOutput) String

func (s BatchUpdateFindingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchUpdateFindingsUnprocessedFinding

type BatchUpdateFindingsUnprocessedFinding struct {

	// The code associated with the error. Possible values are:
	//
	//    * ConcurrentUpdateError - Another request attempted to update the finding
	//    while this request was being processed. This error may also occur if you
	//    call BatchUpdateFindings (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html)
	//    and BatchImportFindings (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html)
	//    at the same time.
	//
	//    * DuplicatedFindingIdentifier - The request included two or more findings
	//    with the same FindingIdentifier.
	//
	//    * FindingNotFound - The FindingIdentifier included in the request did
	//    not match an existing finding.
	//
	//    * FindingSizeExceeded - The finding size was greater than the permissible
	//    value of 240 KB.
	//
	//    * InternalFailure - An internal service failure occurred when updating
	//    the finding.
	//
	//    * InvalidInput - The finding update contained an invalid value that did
	//    not satisfy the Amazon Web Services Security Finding Format (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html)
	//    syntax.
	//
	// ErrorCode is a required field
	ErrorCode *string `type:"string" required:"true"`

	// The message associated with the error. Possible values are:
	//
	//    * Concurrent finding updates detected
	//
	//    * Finding Identifier is duplicated
	//
	//    * Finding Not Found
	//
	//    * Finding size exceeded 240 KB
	//
	//    * Internal service failure
	//
	//    * Invalid Input
	//
	// ErrorMessage is a required field
	ErrorMessage *string `type:"string" required:"true"`

	// The identifier of the finding that was not updated.
	//
	// FindingIdentifier is a required field
	FindingIdentifier *AwsSecurityFindingIdentifier `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

A finding from a BatchUpdateFindings request that Security Hub was unable to update.

func (BatchUpdateFindingsUnprocessedFinding) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchUpdateFindingsUnprocessedFinding) SetErrorCode

SetErrorCode sets the ErrorCode field's value.

func (*BatchUpdateFindingsUnprocessedFinding) SetErrorMessage

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchUpdateFindingsUnprocessedFinding) SetFindingIdentifier

SetFindingIdentifier sets the FindingIdentifier field's value.

func (BatchUpdateFindingsUnprocessedFinding) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchUpdateStandardsControlAssociationsInput added in v1.42.9

type BatchUpdateStandardsControlAssociationsInput struct {

	// Updates the enablement status of a security control in a specified standard.
	//
	// StandardsControlAssociationUpdates is a required field
	StandardsControlAssociationUpdates []*StandardsControlAssociationUpdate `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchUpdateStandardsControlAssociationsInput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchUpdateStandardsControlAssociationsInput) SetStandardsControlAssociationUpdates added in v1.42.9

SetStandardsControlAssociationUpdates sets the StandardsControlAssociationUpdates field's value.

func (BatchUpdateStandardsControlAssociationsInput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchUpdateStandardsControlAssociationsInput) Validate added in v1.42.9

Validate inspects the fields of the type to determine if they are valid.

type BatchUpdateStandardsControlAssociationsOutput added in v1.42.9

type BatchUpdateStandardsControlAssociationsOutput struct {

	// A security control (identified with SecurityControlId, SecurityControlArn,
	// or a mix of both parameters) whose enablement status in a specified standard
	// couldn't be updated.
	UnprocessedAssociationUpdates []*UnprocessedStandardsControlAssociationUpdate `type:"list"`
	// contains filtered or unexported fields
}

func (BatchUpdateStandardsControlAssociationsOutput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchUpdateStandardsControlAssociationsOutput) SetUnprocessedAssociationUpdates added in v1.42.9

SetUnprocessedAssociationUpdates sets the UnprocessedAssociationUpdates field's value.

func (BatchUpdateStandardsControlAssociationsOutput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BooleanFilter added in v1.42.9

type BooleanFilter struct {

	// The value of the boolean.
	Value *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Boolean filter for querying findings.

func (BooleanFilter) GoString added in v1.42.9

func (s BooleanFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BooleanFilter) SetValue added in v1.42.9

func (s *BooleanFilter) SetValue(v bool) *BooleanFilter

SetValue sets the Value field's value.

func (BooleanFilter) String added in v1.42.9

func (s BooleanFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Cell

type Cell struct {

	// For a Microsoft Excel workbook, provides the location of the cell, as an
	// absolute cell reference, that contains the data. For example, Sheet2!C5 for
	// cell C5 on Sheet2.
	CellReference *string `type:"string"`

	// The column number of the column that contains the data. For a Microsoft Excel
	// workbook, the column number corresponds to the alphabetical column identifiers.
	// For example, a value of 1 for Column corresponds to the A column in the workbook.
	Column *int64 `type:"long"`

	// The name of the column that contains the data.
	ColumnName *string `type:"string"`

	// The row number of the row that contains the data.
	Row *int64 `type:"long"`
	// contains filtered or unexported fields
}

An occurrence of sensitive data detected in a Microsoft Excel workbook, comma-separated value (CSV) file, or tab-separated value (TSV) file.

func (Cell) GoString

func (s Cell) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Cell) SetCellReference

func (s *Cell) SetCellReference(v string) *Cell

SetCellReference sets the CellReference field's value.

func (*Cell) SetColumn

func (s *Cell) SetColumn(v int64) *Cell

SetColumn sets the Column field's value.

func (*Cell) SetColumnName

func (s *Cell) SetColumnName(v string) *Cell

SetColumnName sets the ColumnName field's value.

func (*Cell) SetRow

func (s *Cell) SetRow(v int64) *Cell

SetRow sets the Row field's value.

func (Cell) String

func (s Cell) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CidrBlockAssociation

type CidrBlockAssociation struct {

	// The association ID for the IPv4 CIDR block.
	AssociationId *string `type:"string"`

	// The IPv4 CIDR block.
	CidrBlock *string `type:"string"`

	// Information about the state of the IPv4 CIDR block.
	CidrBlockState *string `type:"string"`
	// contains filtered or unexported fields
}

An IPv4 CIDR block association.

func (CidrBlockAssociation) GoString

func (s CidrBlockAssociation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CidrBlockAssociation) SetAssociationId

func (s *CidrBlockAssociation) SetAssociationId(v string) *CidrBlockAssociation

SetAssociationId sets the AssociationId field's value.

func (*CidrBlockAssociation) SetCidrBlock

func (s *CidrBlockAssociation) SetCidrBlock(v string) *CidrBlockAssociation

SetCidrBlock sets the CidrBlock field's value.

func (*CidrBlockAssociation) SetCidrBlockState

func (s *CidrBlockAssociation) SetCidrBlockState(v string) *CidrBlockAssociation

SetCidrBlockState sets the CidrBlockState field's value.

func (CidrBlockAssociation) String

func (s CidrBlockAssociation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type City

type City struct {

	// The name of the city.
	CityName *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a city.

func (City) GoString

func (s City) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*City) SetCityName

func (s *City) SetCityName(v string) *City

SetCityName sets the CityName field's value.

func (City) String

func (s City) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClassificationResult

type ClassificationResult struct {

	// Indicates whether there are additional occurrences of sensitive data that
	// are not included in the finding. This occurs when the number of occurrences
	// exceeds the maximum that can be included.
	AdditionalOccurrences *bool `type:"boolean"`

	// Provides details about sensitive data that was identified based on customer-defined
	// configuration.
	CustomDataIdentifiers *CustomDataIdentifiersResult `type:"structure"`

	// The type of content that the finding applies to.
	MimeType *string `type:"string"`

	// Provides details about sensitive data that was identified based on built-in
	// configuration.
	SensitiveData []*SensitiveDataResult `type:"list"`

	// The total size in bytes of the affected data.
	SizeClassified *int64 `type:"long"`

	// The current status of the sensitive data detection.
	Status *ClassificationStatus `type:"structure"`
	// contains filtered or unexported fields
}

Details about the sensitive data that was detected on the resource.

func (ClassificationResult) GoString

func (s ClassificationResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClassificationResult) SetAdditionalOccurrences

func (s *ClassificationResult) SetAdditionalOccurrences(v bool) *ClassificationResult

SetAdditionalOccurrences sets the AdditionalOccurrences field's value.

func (*ClassificationResult) SetCustomDataIdentifiers

SetCustomDataIdentifiers sets the CustomDataIdentifiers field's value.

func (*ClassificationResult) SetMimeType

SetMimeType sets the MimeType field's value.

func (*ClassificationResult) SetSensitiveData

SetSensitiveData sets the SensitiveData field's value.

func (*ClassificationResult) SetSizeClassified

func (s *ClassificationResult) SetSizeClassified(v int64) *ClassificationResult

SetSizeClassified sets the SizeClassified field's value.

func (*ClassificationResult) SetStatus

SetStatus sets the Status field's value.

func (ClassificationResult) String

func (s ClassificationResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClassificationStatus

type ClassificationStatus struct {

	// The code that represents the status of the sensitive data detection.
	Code *string `type:"string"`

	// A longer description of the current status of the sensitive data detection.
	Reason *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the current status of the sensitive data detection.

func (ClassificationStatus) GoString

func (s ClassificationStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClassificationStatus) SetCode

SetCode sets the Code field's value.

func (*ClassificationStatus) SetReason

SetReason sets the Reason field's value.

func (ClassificationStatus) String

func (s ClassificationStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Compliance

type Compliance struct {

	// The enabled security standards in which a security control is currently enabled.
	AssociatedStandards []*AssociatedStandard `type:"list"`

	// For a control, the industry or regulatory framework requirements that are
	// related to the control. The check for that control is aligned with these
	// requirements.
	RelatedRequirements []*string `type:"list"`

	// The unique identifier of a control across standards. Values for this field
	// typically consist of an Amazon Web Service and a number, such as APIGateway.5.
	SecurityControlId *string `type:"string"`

	// The result of a standards check.
	//
	// The valid values for Status are as follows.
	//
	//    * PASSED - Standards check passed for all evaluated resources. WARNING
	//    - Some information is missing or this check is not supported for your
	//    configuration. FAILED - Standards check failed for at least one evaluated
	//    resource. NOT_AVAILABLE - Check could not be performed due to a service
	//    outage, API error, or because the result of the Config evaluation was
	//    NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE, then
	//    after 3 days, Security Hub automatically archives the finding.
	Status *string `type:"string" enum:"ComplianceStatus"`

	// For findings generated from controls, a list of reasons behind the value
	// of Status. For the list of status reason codes and their meanings, see Standards-related
	// information in the ASFF (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-results.html#securityhub-standards-results-asff)
	// in the Security Hub User Guide.
	StatusReasons []*StatusReason `type:"list"`
	// contains filtered or unexported fields
}

Contains finding details that are specific to control-based findings. Only returned for findings generated from controls.

func (Compliance) GoString

func (s Compliance) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Compliance) SetAssociatedStandards added in v1.42.9

func (s *Compliance) SetAssociatedStandards(v []*AssociatedStandard) *Compliance

SetAssociatedStandards sets the AssociatedStandards field's value.

func (*Compliance) SetRelatedRequirements

func (s *Compliance) SetRelatedRequirements(v []*string) *Compliance

SetRelatedRequirements sets the RelatedRequirements field's value.

func (*Compliance) SetSecurityControlId added in v1.42.9

func (s *Compliance) SetSecurityControlId(v string) *Compliance

SetSecurityControlId sets the SecurityControlId field's value.

func (*Compliance) SetStatus

func (s *Compliance) SetStatus(v string) *Compliance

SetStatus sets the Status field's value.

func (*Compliance) SetStatusReasons

func (s *Compliance) SetStatusReasons(v []*StatusReason) *Compliance

SetStatusReasons sets the StatusReasons field's value.

func (Compliance) String

func (s Compliance) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Compliance) Validate

func (s *Compliance) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ContainerDetails

type ContainerDetails struct {

	// The runtime of the container.
	ContainerRuntime *string `type:"string"`

	// The identifier of the container image related to a finding.
	ImageId *string `type:"string"`

	// The name of the container image related to a finding.
	ImageName *string `type:"string"`

	// Indicates when the container started.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	LaunchedAt *string `type:"string"`

	// The name of the container related to a finding.
	Name *string `type:"string"`

	// When this parameter is true, the container is given elevated privileges on
	// the host container instance (similar to the root user).
	Privileged *bool `type:"boolean"`

	// Provides information about the mounting of a volume in a container.
	VolumeMounts []*VolumeMount `type:"list"`
	// contains filtered or unexported fields
}

Container details related to a finding.

func (ContainerDetails) GoString

func (s ContainerDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerDetails) SetContainerRuntime added in v1.42.9

func (s *ContainerDetails) SetContainerRuntime(v string) *ContainerDetails

SetContainerRuntime sets the ContainerRuntime field's value.

func (*ContainerDetails) SetImageId

func (s *ContainerDetails) SetImageId(v string) *ContainerDetails

SetImageId sets the ImageId field's value.

func (*ContainerDetails) SetImageName

func (s *ContainerDetails) SetImageName(v string) *ContainerDetails

SetImageName sets the ImageName field's value.

func (*ContainerDetails) SetLaunchedAt

func (s *ContainerDetails) SetLaunchedAt(v string) *ContainerDetails

SetLaunchedAt sets the LaunchedAt field's value.

func (*ContainerDetails) SetName

func (s *ContainerDetails) SetName(v string) *ContainerDetails

SetName sets the Name field's value.

func (*ContainerDetails) SetPrivileged added in v1.42.9

func (s *ContainerDetails) SetPrivileged(v bool) *ContainerDetails

SetPrivileged sets the Privileged field's value.

func (*ContainerDetails) SetVolumeMounts added in v1.42.9

func (s *ContainerDetails) SetVolumeMounts(v []*VolumeMount) *ContainerDetails

SetVolumeMounts sets the VolumeMounts field's value.

func (ContainerDetails) String

func (s ContainerDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Country

type Country struct {

	// The 2-letter ISO 3166 country code for the country.
	CountryCode *string `type:"string"`

	// The name of the country.
	CountryName *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a country.

func (Country) GoString

func (s Country) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Country) SetCountryCode

func (s *Country) SetCountryCode(v string) *Country

SetCountryCode sets the CountryCode field's value.

func (*Country) SetCountryName

func (s *Country) SetCountryName(v string) *Country

SetCountryName sets the CountryName field's value.

func (Country) String

func (s Country) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateActionTargetInput

type CreateActionTargetInput struct {

	// The description for the custom action target.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// The ID for the custom action target. Can contain up to 20 alphanumeric characters.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The name of the custom action target. Can contain up to 20 characters.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateActionTargetInput) GoString

func (s CreateActionTargetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateActionTargetInput) SetDescription

SetDescription sets the Description field's value.

func (*CreateActionTargetInput) SetId

SetId sets the Id field's value.

func (*CreateActionTargetInput) SetName

SetName sets the Name field's value.

func (CreateActionTargetInput) String

func (s CreateActionTargetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateActionTargetInput) Validate

func (s *CreateActionTargetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateActionTargetOutput

type CreateActionTargetOutput struct {

	// The Amazon Resource Name (ARN) for the custom action target.
	//
	// ActionTargetArn is a required field
	ActionTargetArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateActionTargetOutput) GoString

func (s CreateActionTargetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateActionTargetOutput) SetActionTargetArn

func (s *CreateActionTargetOutput) SetActionTargetArn(v string) *CreateActionTargetOutput

SetActionTargetArn sets the ActionTargetArn field's value.

func (CreateActionTargetOutput) String

func (s CreateActionTargetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAutomationRuleInput added in v1.42.9

type CreateAutomationRuleInput struct {

	// One or more actions to update finding fields if a finding matches the conditions
	// specified in Criteria.
	//
	// Actions is a required field
	Actions []*AutomationRulesAction `min:"1" type:"list" required:"true"`

	// A set of ASFF finding field attributes and corresponding expected values
	// that Security Hub uses to filter findings. If a rule is enabled and a finding
	// matches the conditions specified in this parameter, Security Hub applies
	// the rule action to the finding.
	//
	// Criteria is a required field
	Criteria *AutomationRulesFindingFilters `type:"structure" required:"true"`

	// A description of the rule.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// Specifies whether a rule is the last to be applied with respect to a finding
	// that matches the rule criteria. This is useful when a finding matches the
	// criteria for multiple rules, and each rule has different actions. If a rule
	// is terminal, Security Hub applies the rule action to a finding that matches
	// the rule criteria and doesn't evaluate other rules for the finding. By default,
	// a rule isn't terminal.
	IsTerminal *bool `type:"boolean"`

	// The name of the rule.
	//
	// RuleName is a required field
	RuleName *string `type:"string" required:"true"`

	// An integer ranging from 1 to 1000 that represents the order in which the
	// rule action is applied to findings. Security Hub applies rules with lower
	// values for this parameter first.
	//
	// RuleOrder is a required field
	RuleOrder *int64 `min:"1" type:"integer" required:"true"`

	// Whether the rule is active after it is created. If this parameter is equal
	// to ENABLED, Security Hub starts applying the rule to findings and finding
	// updates after the rule is created. To change the value of this parameter
	// after creating a rule, use BatchUpdateAutomationRules (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html).
	RuleStatus *string `type:"string" enum:"RuleStatus"`

	// User-defined tags that help you label the purpose of a rule.
	Tags map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateAutomationRuleInput) GoString added in v1.42.9

func (s CreateAutomationRuleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAutomationRuleInput) SetActions added in v1.42.9

SetActions sets the Actions field's value.

func (*CreateAutomationRuleInput) SetCriteria added in v1.42.9

SetCriteria sets the Criteria field's value.

func (*CreateAutomationRuleInput) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*CreateAutomationRuleInput) SetIsTerminal added in v1.42.9

SetIsTerminal sets the IsTerminal field's value.

func (*CreateAutomationRuleInput) SetRuleName added in v1.42.9

SetRuleName sets the RuleName field's value.

func (*CreateAutomationRuleInput) SetRuleOrder added in v1.42.9

SetRuleOrder sets the RuleOrder field's value.

func (*CreateAutomationRuleInput) SetRuleStatus added in v1.42.9

SetRuleStatus sets the RuleStatus field's value.

func (*CreateAutomationRuleInput) SetTags added in v1.42.9

SetTags sets the Tags field's value.

func (CreateAutomationRuleInput) String added in v1.42.9

func (s CreateAutomationRuleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAutomationRuleInput) Validate added in v1.42.9

func (s *CreateAutomationRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAutomationRuleOutput added in v1.42.9

type CreateAutomationRuleOutput struct {

	// The Amazon Resource Name (ARN) of the automation rule that you created.
	RuleArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateAutomationRuleOutput) GoString added in v1.42.9

func (s CreateAutomationRuleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAutomationRuleOutput) SetRuleArn added in v1.42.9

SetRuleArn sets the RuleArn field's value.

func (CreateAutomationRuleOutput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateFindingAggregatorInput

type CreateFindingAggregatorInput struct {

	// Indicates whether to aggregate findings from all of the available Regions
	// in the current partition. Also determines whether to automatically aggregate
	// findings from new Regions as Security Hub supports them and you opt into
	// them.
	//
	// The selected option also determines how to use the Regions provided in the
	// Regions list.
	//
	// The options are as follows:
	//
	//    * ALL_REGIONS - Indicates to aggregate findings from all of the Regions
	//    where Security Hub is enabled. When you choose this option, Security Hub
	//    also automatically aggregates findings from new Regions as Security Hub
	//    supports them and you opt into them.
	//
	//    * ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from
	//    all of the Regions where Security Hub is enabled, except for the Regions
	//    listed in the Regions parameter. When you choose this option, Security
	//    Hub also automatically aggregates findings from new Regions as Security
	//    Hub supports them and you opt into them.
	//
	//    * SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions
	//    listed in the Regions parameter. Security Hub does not automatically aggregate
	//    findings from new Regions.
	//
	// RegionLinkingMode is a required field
	RegionLinkingMode *string `type:"string" required:"true"`

	// If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated
	// list of Regions that do not aggregate findings to the aggregation Region.
	//
	// If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated
	// list of Regions that do aggregate findings to the aggregation Region.
	Regions []*string `type:"list"`
	// contains filtered or unexported fields
}

func (CreateFindingAggregatorInput) GoString

func (s CreateFindingAggregatorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFindingAggregatorInput) SetRegionLinkingMode

SetRegionLinkingMode sets the RegionLinkingMode field's value.

func (*CreateFindingAggregatorInput) SetRegions

SetRegions sets the Regions field's value.

func (CreateFindingAggregatorInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFindingAggregatorInput) Validate

func (s *CreateFindingAggregatorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateFindingAggregatorOutput

type CreateFindingAggregatorOutput struct {

	// The aggregation Region.
	FindingAggregationRegion *string `type:"string"`

	// The ARN of the finding aggregator. You use the finding aggregator ARN to
	// retrieve details for, update, and stop finding aggregation.
	FindingAggregatorArn *string `type:"string"`

	// Indicates whether to link all Regions, all Regions except for a list of excluded
	// Regions, or a list of included Regions.
	RegionLinkingMode *string `type:"string"`

	// The list of excluded Regions or included Regions.
	Regions []*string `type:"list"`
	// contains filtered or unexported fields
}

func (CreateFindingAggregatorOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFindingAggregatorOutput) SetFindingAggregationRegion

func (s *CreateFindingAggregatorOutput) SetFindingAggregationRegion(v string) *CreateFindingAggregatorOutput

SetFindingAggregationRegion sets the FindingAggregationRegion field's value.

func (*CreateFindingAggregatorOutput) SetFindingAggregatorArn

SetFindingAggregatorArn sets the FindingAggregatorArn field's value.

func (*CreateFindingAggregatorOutput) SetRegionLinkingMode

SetRegionLinkingMode sets the RegionLinkingMode field's value.

func (*CreateFindingAggregatorOutput) SetRegions

SetRegions sets the Regions field's value.

func (CreateFindingAggregatorOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateInsightInput

type CreateInsightInput struct {

	// One or more attributes used to filter the findings included in the insight.
	// The insight only includes findings that match the criteria defined in the
	// filters.
	//
	// Filters is a required field
	Filters *AwsSecurityFindingFilters `type:"structure" required:"true"`

	// The attribute used to group the findings for the insight. The grouping attribute
	// identifies the type of item that the insight applies to. For example, if
	// an insight is grouped by resource identifier, then the insight produces a
	// list of resource identifiers.
	//
	// GroupByAttribute is a required field
	GroupByAttribute *string `type:"string" required:"true"`

	// The name of the custom insight to create.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateInsightInput) GoString

func (s CreateInsightInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateInsightInput) SetFilters

SetFilters sets the Filters field's value.

func (*CreateInsightInput) SetGroupByAttribute

func (s *CreateInsightInput) SetGroupByAttribute(v string) *CreateInsightInput

SetGroupByAttribute sets the GroupByAttribute field's value.

func (*CreateInsightInput) SetName

SetName sets the Name field's value.

func (CreateInsightInput) String

func (s CreateInsightInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateInsightInput) Validate

func (s *CreateInsightInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateInsightOutput

type CreateInsightOutput struct {

	// The ARN of the insight created.
	//
	// InsightArn is a required field
	InsightArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateInsightOutput) GoString

func (s CreateInsightOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateInsightOutput) SetInsightArn

func (s *CreateInsightOutput) SetInsightArn(v string) *CreateInsightOutput

SetInsightArn sets the InsightArn field's value.

func (CreateInsightOutput) String

func (s CreateInsightOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateMembersInput

type CreateMembersInput struct {

	// The list of accounts to associate with the Security Hub administrator account.
	// For each account, the list includes the account ID and optionally the email
	// address.
	//
	// AccountDetails is a required field
	AccountDetails []*AccountDetails `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateMembersInput) GoString

func (s CreateMembersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMembersInput) SetAccountDetails

func (s *CreateMembersInput) SetAccountDetails(v []*AccountDetails) *CreateMembersInput

SetAccountDetails sets the AccountDetails field's value.

func (CreateMembersInput) String

func (s CreateMembersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMembersInput) Validate

func (s *CreateMembersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateMembersOutput

type CreateMembersOutput struct {

	// The list of Amazon Web Services accounts that were not processed. For each
	// account, the list includes the account ID and the email address.
	UnprocessedAccounts []*Result `type:"list"`
	// contains filtered or unexported fields
}

func (CreateMembersOutput) GoString

func (s CreateMembersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMembersOutput) SetUnprocessedAccounts

func (s *CreateMembersOutput) SetUnprocessedAccounts(v []*Result) *CreateMembersOutput

SetUnprocessedAccounts sets the UnprocessedAccounts field's value.

func (CreateMembersOutput) String

func (s CreateMembersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CustomDataIdentifiersDetections

type CustomDataIdentifiersDetections struct {

	// The ARN of the custom identifier that was used to detect the sensitive data.
	Arn *string `type:"string"`

	// The total number of occurrences of sensitive data that were detected.
	Count *int64 `type:"long"`

	// he name of the custom identifier that detected the sensitive data.
	Name *string `type:"string"`

	// Details about the sensitive data that was detected.
	Occurrences *Occurrences `type:"structure"`
	// contains filtered or unexported fields
}

The list of detected instances of sensitive data.

func (CustomDataIdentifiersDetections) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomDataIdentifiersDetections) SetArn

SetArn sets the Arn field's value.

func (*CustomDataIdentifiersDetections) SetCount

SetCount sets the Count field's value.

func (*CustomDataIdentifiersDetections) SetName

SetName sets the Name field's value.

func (*CustomDataIdentifiersDetections) SetOccurrences

SetOccurrences sets the Occurrences field's value.

func (CustomDataIdentifiersDetections) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CustomDataIdentifiersResult

type CustomDataIdentifiersResult struct {

	// The list of detected instances of sensitive data.
	Detections []*CustomDataIdentifiersDetections `type:"list"`

	// The total number of occurrences of sensitive data.
	TotalCount *int64 `type:"long"`
	// contains filtered or unexported fields
}

Contains an instance of sensitive data that was detected by a customer-defined identifier.

func (CustomDataIdentifiersResult) GoString

func (s CustomDataIdentifiersResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomDataIdentifiersResult) SetDetections

SetDetections sets the Detections field's value.

func (*CustomDataIdentifiersResult) SetTotalCount

SetTotalCount sets the TotalCount field's value.

func (CustomDataIdentifiersResult) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Cvss

type Cvss struct {

	// Adjustments to the CVSS metrics.
	Adjustments []*Adjustment `type:"list"`

	// The base CVSS score.
	BaseScore *float64 `type:"double"`

	// The base scoring vector for the CVSS score.
	BaseVector *string `type:"string"`

	// The origin of the original CVSS score and vector.
	Source *string `type:"string"`

	// The version of CVSS for the CVSS score.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

CVSS scores from the advisory related to the vulnerability.

func (Cvss) GoString

func (s Cvss) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Cvss) SetAdjustments

func (s *Cvss) SetAdjustments(v []*Adjustment) *Cvss

SetAdjustments sets the Adjustments field's value.

func (*Cvss) SetBaseScore

func (s *Cvss) SetBaseScore(v float64) *Cvss

SetBaseScore sets the BaseScore field's value.

func (*Cvss) SetBaseVector

func (s *Cvss) SetBaseVector(v string) *Cvss

SetBaseVector sets the BaseVector field's value.

func (*Cvss) SetSource

func (s *Cvss) SetSource(v string) *Cvss

SetSource sets the Source field's value.

func (*Cvss) SetVersion

func (s *Cvss) SetVersion(v string) *Cvss

SetVersion sets the Version field's value.

func (Cvss) String

func (s Cvss) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataClassificationDetails

type DataClassificationDetails struct {

	// The path to the folder or file that contains the sensitive data.
	DetailedResultsLocation *string `type:"string"`

	// The details about the sensitive data that was detected on the resource.
	Result *ClassificationResult `type:"structure"`
	// contains filtered or unexported fields
}

Provides details about sensitive data that was detected on a resource.

func (DataClassificationDetails) GoString

func (s DataClassificationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataClassificationDetails) SetDetailedResultsLocation

func (s *DataClassificationDetails) SetDetailedResultsLocation(v string) *DataClassificationDetails

SetDetailedResultsLocation sets the DetailedResultsLocation field's value.

func (*DataClassificationDetails) SetResult

SetResult sets the Result field's value.

func (DataClassificationDetails) String

func (s DataClassificationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DateFilter

type DateFilter struct {

	// A date range for the date filter.
	DateRange *DateRange `type:"structure"`

	// A timestamp that provides the end date for the date filter.
	//
	// A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot
	// contain spaces, and date and time should be separated by T. For more information,
	// see RFC 3339 section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6).
	End *string `type:"string"`

	// A timestamp that provides the start date for the date filter.
	//
	// A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot
	// contain spaces, and date and time should be separated by T. For more information,
	// see RFC 3339 section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6).
	Start *string `type:"string"`
	// contains filtered or unexported fields
}

A date filter for querying findings.

func (DateFilter) GoString

func (s DateFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DateFilter) SetDateRange

func (s *DateFilter) SetDateRange(v *DateRange) *DateFilter

SetDateRange sets the DateRange field's value.

func (*DateFilter) SetEnd

func (s *DateFilter) SetEnd(v string) *DateFilter

SetEnd sets the End field's value.

func (*DateFilter) SetStart

func (s *DateFilter) SetStart(v string) *DateFilter

SetStart sets the Start field's value.

func (DateFilter) String

func (s DateFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DateRange

type DateRange struct {

	// A date range unit for the date filter.
	Unit *string `type:"string" enum:"DateRangeUnit"`

	// A date range value for the date filter.
	Value *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A date range for the date filter.

func (DateRange) GoString

func (s DateRange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DateRange) SetUnit

func (s *DateRange) SetUnit(v string) *DateRange

SetUnit sets the Unit field's value.

func (*DateRange) SetValue

func (s *DateRange) SetValue(v int64) *DateRange

SetValue sets the Value field's value.

func (DateRange) String

func (s DateRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeclineInvitationsInput

type DeclineInvitationsInput struct {

	// The list of prospective member account IDs for which to decline an invitation.
	//
	// AccountIds is a required field
	AccountIds []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DeclineInvitationsInput) GoString

func (s DeclineInvitationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeclineInvitationsInput) SetAccountIds

func (s *DeclineInvitationsInput) SetAccountIds(v []*string) *DeclineInvitationsInput

SetAccountIds sets the AccountIds field's value.

func (DeclineInvitationsInput) String

func (s DeclineInvitationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeclineInvitationsInput) Validate

func (s *DeclineInvitationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeclineInvitationsOutput

type DeclineInvitationsOutput struct {

	// The list of Amazon Web Services accounts that were not processed. For each
	// account, the list includes the account ID and the email address.
	UnprocessedAccounts []*Result `type:"list"`
	// contains filtered or unexported fields
}

func (DeclineInvitationsOutput) GoString

func (s DeclineInvitationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeclineInvitationsOutput) SetUnprocessedAccounts

func (s *DeclineInvitationsOutput) SetUnprocessedAccounts(v []*Result) *DeclineInvitationsOutput

SetUnprocessedAccounts sets the UnprocessedAccounts field's value.

func (DeclineInvitationsOutput) String

func (s DeclineInvitationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteActionTargetInput

type DeleteActionTargetInput struct {

	// The Amazon Resource Name (ARN) of the custom action target to delete.
	//
	// ActionTargetArn is a required field
	ActionTargetArn *string `location:"uri" locationName:"ActionTargetArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteActionTargetInput) GoString

func (s DeleteActionTargetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteActionTargetInput) SetActionTargetArn

func (s *DeleteActionTargetInput) SetActionTargetArn(v string) *DeleteActionTargetInput

SetActionTargetArn sets the ActionTargetArn field's value.

func (DeleteActionTargetInput) String

func (s DeleteActionTargetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteActionTargetInput) Validate

func (s *DeleteActionTargetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteActionTargetOutput

type DeleteActionTargetOutput struct {

	// The ARN of the custom action target that was deleted.
	//
	// ActionTargetArn is a required field
	ActionTargetArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteActionTargetOutput) GoString

func (s DeleteActionTargetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteActionTargetOutput) SetActionTargetArn

func (s *DeleteActionTargetOutput) SetActionTargetArn(v string) *DeleteActionTargetOutput

SetActionTargetArn sets the ActionTargetArn field's value.

func (DeleteActionTargetOutput) String

func (s DeleteActionTargetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteFindingAggregatorInput

type DeleteFindingAggregatorInput struct {

	// The ARN of the finding aggregator to delete. To obtain the ARN, use ListFindingAggregators.
	//
	// FindingAggregatorArn is a required field
	FindingAggregatorArn *string `location:"uri" locationName:"FindingAggregatorArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFindingAggregatorInput) GoString

func (s DeleteFindingAggregatorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFindingAggregatorInput) SetFindingAggregatorArn

func (s *DeleteFindingAggregatorInput) SetFindingAggregatorArn(v string) *DeleteFindingAggregatorInput

SetFindingAggregatorArn sets the FindingAggregatorArn field's value.

func (DeleteFindingAggregatorInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFindingAggregatorInput) Validate

func (s *DeleteFindingAggregatorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFindingAggregatorOutput

type DeleteFindingAggregatorOutput struct {
	// contains filtered or unexported fields
}

func (DeleteFindingAggregatorOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteFindingAggregatorOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteInsightInput

type DeleteInsightInput struct {

	// The ARN of the insight to delete.
	//
	// InsightArn is a required field
	InsightArn *string `location:"uri" locationName:"InsightArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteInsightInput) GoString

func (s DeleteInsightInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInsightInput) SetInsightArn

func (s *DeleteInsightInput) SetInsightArn(v string) *DeleteInsightInput

SetInsightArn sets the InsightArn field's value.

func (DeleteInsightInput) String

func (s DeleteInsightInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInsightInput) Validate

func (s *DeleteInsightInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteInsightOutput

type DeleteInsightOutput struct {

	// The ARN of the insight that was deleted.
	//
	// InsightArn is a required field
	InsightArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteInsightOutput) GoString

func (s DeleteInsightOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInsightOutput) SetInsightArn

func (s *DeleteInsightOutput) SetInsightArn(v string) *DeleteInsightOutput

SetInsightArn sets the InsightArn field's value.

func (DeleteInsightOutput) String

func (s DeleteInsightOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteInvitationsInput

type DeleteInvitationsInput struct {

	// The list of member account IDs that received the invitations you want to
	// delete.
	//
	// AccountIds is a required field
	AccountIds []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteInvitationsInput) GoString

func (s DeleteInvitationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInvitationsInput) SetAccountIds

func (s *DeleteInvitationsInput) SetAccountIds(v []*string) *DeleteInvitationsInput

SetAccountIds sets the AccountIds field's value.

func (DeleteInvitationsInput) String

func (s DeleteInvitationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInvitationsInput) Validate

func (s *DeleteInvitationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteInvitationsOutput

type DeleteInvitationsOutput struct {

	// The list of Amazon Web Services accounts for which the invitations were not
	// deleted. For each account, the list includes the account ID and the email
	// address.
	UnprocessedAccounts []*Result `type:"list"`
	// contains filtered or unexported fields
}

func (DeleteInvitationsOutput) GoString

func (s DeleteInvitationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInvitationsOutput) SetUnprocessedAccounts

func (s *DeleteInvitationsOutput) SetUnprocessedAccounts(v []*Result) *DeleteInvitationsOutput

SetUnprocessedAccounts sets the UnprocessedAccounts field's value.

func (DeleteInvitationsOutput) String

func (s DeleteInvitationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteMembersInput

type DeleteMembersInput struct {

	// The list of account IDs for the member accounts to delete.
	//
	// AccountIds is a required field
	AccountIds []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMembersInput) GoString

func (s DeleteMembersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMembersInput) SetAccountIds

func (s *DeleteMembersInput) SetAccountIds(v []*string) *DeleteMembersInput

SetAccountIds sets the AccountIds field's value.

func (DeleteMembersInput) String

func (s DeleteMembersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMembersInput) Validate

func (s *DeleteMembersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteMembersOutput

type DeleteMembersOutput struct {

	// The list of Amazon Web Services accounts that were not deleted. For each
	// account, the list includes the account ID and the email address.
	UnprocessedAccounts []*Result `type:"list"`
	// contains filtered or unexported fields
}

func (DeleteMembersOutput) GoString

func (s DeleteMembersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMembersOutput) SetUnprocessedAccounts

func (s *DeleteMembersOutput) SetUnprocessedAccounts(v []*Result) *DeleteMembersOutput

SetUnprocessedAccounts sets the UnprocessedAccounts field's value.

func (DeleteMembersOutput) String

func (s DeleteMembersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeActionTargetsInput

type DescribeActionTargetsInput struct {

	// A list of custom action target ARNs for the custom action targets to retrieve.
	ActionTargetArns []*string `type:"list"`

	// The maximum number of results to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token that is required for pagination. On your first call to the DescribeActionTargets
	// operation, set the value of this parameter to NULL.
	//
	// For subsequent calls to the operation, to continue listing data, set the
	// value of this parameter to the value returned from the previous response.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeActionTargetsInput) GoString

func (s DescribeActionTargetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeActionTargetsInput) SetActionTargetArns

func (s *DescribeActionTargetsInput) SetActionTargetArns(v []*string) *DescribeActionTargetsInput

SetActionTargetArns sets the ActionTargetArns field's value.

func (*DescribeActionTargetsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*DescribeActionTargetsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (DescribeActionTargetsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeActionTargetsInput) Validate

func (s *DescribeActionTargetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeActionTargetsOutput

type DescribeActionTargetsOutput struct {

	// A list of ActionTarget objects. Each object includes the ActionTargetArn,
	// Description, and Name of a custom action target available in Security Hub.
	//
	// ActionTargets is a required field
	ActionTargets []*ActionTarget `type:"list" required:"true"`

	// The pagination token to use to request the next page of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeActionTargetsOutput) GoString

func (s DescribeActionTargetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeActionTargetsOutput) SetActionTargets

SetActionTargets sets the ActionTargets field's value.

func (*DescribeActionTargetsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (DescribeActionTargetsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeHubInput

type DescribeHubInput struct {

	// The ARN of the Hub resource to retrieve.
	HubArn *string `location:"querystring" locationName:"HubArn" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeHubInput) GoString

func (s DescribeHubInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeHubInput) SetHubArn

func (s *DescribeHubInput) SetHubArn(v string) *DescribeHubInput

SetHubArn sets the HubArn field's value.

func (DescribeHubInput) String

func (s DescribeHubInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeHubOutput

type DescribeHubOutput struct {

	// Whether to automatically enable new controls when they are added to standards
	// that are enabled.
	//
	// If set to true, then new controls for enabled standards are enabled automatically.
	// If set to false, then new controls are not enabled.
	AutoEnableControls *bool `type:"boolean"`

	// Specifies whether the calling account has consolidated control findings turned
	// on. If the value for this field is set to SECURITY_CONTROL, Security Hub
	// generates a single finding for a control check even when the check applies
	// to multiple enabled standards.
	//
	// If the value for this field is set to STANDARD_CONTROL, Security Hub generates
	// separate findings for a control check when the check applies to multiple
	// enabled standards.
	//
	// The value for this field in a member account matches the value in the administrator
	// account. For accounts that aren't part of an organization, the default value
	// of this field is SECURITY_CONTROL if you enabled Security Hub on or after
	// February 23, 2023.
	ControlFindingGenerator *string `type:"string" enum:"ControlFindingGenerator"`

	// The ARN of the Hub resource that was retrieved.
	HubArn *string `type:"string"`

	// The date and time when Security Hub was enabled in the account.
	SubscribedAt *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeHubOutput) GoString

func (s DescribeHubOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeHubOutput) SetAutoEnableControls

func (s *DescribeHubOutput) SetAutoEnableControls(v bool) *DescribeHubOutput

SetAutoEnableControls sets the AutoEnableControls field's value.

func (*DescribeHubOutput) SetControlFindingGenerator added in v1.42.9

func (s *DescribeHubOutput) SetControlFindingGenerator(v string) *DescribeHubOutput

SetControlFindingGenerator sets the ControlFindingGenerator field's value.

func (*DescribeHubOutput) SetHubArn

func (s *DescribeHubOutput) SetHubArn(v string) *DescribeHubOutput

SetHubArn sets the HubArn field's value.

func (*DescribeHubOutput) SetSubscribedAt

func (s *DescribeHubOutput) SetSubscribedAt(v string) *DescribeHubOutput

SetSubscribedAt sets the SubscribedAt field's value.

func (DescribeHubOutput) String

func (s DescribeHubOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeOrganizationConfigurationInput

type DescribeOrganizationConfigurationInput struct {
	// contains filtered or unexported fields
}

func (DescribeOrganizationConfigurationInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeOrganizationConfigurationInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeOrganizationConfigurationOutput

type DescribeOrganizationConfigurationOutput struct {

	// Whether to automatically enable Security Hub for new accounts in the organization.
	//
	// If set to true, then Security Hub is enabled for new accounts. If set to
	// false, then new accounts are not added automatically.
	AutoEnable *bool `type:"boolean"`

	// Whether to automatically enable Security Hub default standards (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-enable-disable.html)
	// for new member accounts in the organization.
	//
	// The default value of this parameter is equal to DEFAULT.
	//
	// If equal to DEFAULT, then Security Hub default standards are automatically
	// enabled for new member accounts. If equal to NONE, then default standards
	// are not automatically enabled for new member accounts.
	AutoEnableStandards *string `type:"string" enum:"AutoEnableStandards"`

	// Whether the maximum number of allowed member accounts are already associated
	// with the Security Hub administrator account.
	MemberAccountLimitReached *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (DescribeOrganizationConfigurationOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeOrganizationConfigurationOutput) SetAutoEnable

SetAutoEnable sets the AutoEnable field's value.

func (*DescribeOrganizationConfigurationOutput) SetAutoEnableStandards added in v1.42.9

SetAutoEnableStandards sets the AutoEnableStandards field's value.

func (*DescribeOrganizationConfigurationOutput) SetMemberAccountLimitReached

SetMemberAccountLimitReached sets the MemberAccountLimitReached field's value.

func (DescribeOrganizationConfigurationOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeProductsInput

type DescribeProductsInput struct {

	// The maximum number of results to return.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The token that is required for pagination. On your first call to the DescribeProducts
	// operation, set the value of this parameter to NULL.
	//
	// For subsequent calls to the operation, to continue listing data, set the
	// value of this parameter to the value returned from the previous response.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

	// The ARN of the integration to return.
	ProductArn *string `location:"querystring" locationName:"ProductArn" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeProductsInput) GoString

func (s DescribeProductsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProductsInput) SetMaxResults

func (s *DescribeProductsInput) SetMaxResults(v int64) *DescribeProductsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeProductsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeProductsInput) SetProductArn

func (s *DescribeProductsInput) SetProductArn(v string) *DescribeProductsInput

SetProductArn sets the ProductArn field's value.

func (DescribeProductsInput) String

func (s DescribeProductsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProductsInput) Validate

func (s *DescribeProductsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeProductsOutput

type DescribeProductsOutput struct {

	// The pagination token to use to request the next page of results.
	NextToken *string `type:"string"`

	// A list of products, including details for each product.
	//
	// Products is a required field
	Products []*Product `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeProductsOutput) GoString

func (s DescribeProductsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProductsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeProductsOutput) SetProducts

SetProducts sets the Products field's value.

func (DescribeProductsOutput) String

func (s DescribeProductsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStandardsControlsInput

type DescribeStandardsControlsInput struct {

	// The maximum number of security standard controls to return.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The token that is required for pagination. On your first call to the DescribeStandardsControls
	// operation, set the value of this parameter to NULL.
	//
	// For subsequent calls to the operation, to continue listing data, set the
	// value of this parameter to the value returned from the previous response.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

	// The ARN of a resource that represents your subscription to a supported standard.
	// To get the subscription ARNs of the standards you have enabled, use the GetEnabledStandards
	// operation.
	//
	// StandardsSubscriptionArn is a required field
	StandardsSubscriptionArn *string `location:"uri" locationName:"StandardsSubscriptionArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeStandardsControlsInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStandardsControlsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*DescribeStandardsControlsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeStandardsControlsInput) SetStandardsSubscriptionArn

func (s *DescribeStandardsControlsInput) SetStandardsSubscriptionArn(v string) *DescribeStandardsControlsInput

SetStandardsSubscriptionArn sets the StandardsSubscriptionArn field's value.

func (DescribeStandardsControlsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStandardsControlsInput) Validate

func (s *DescribeStandardsControlsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeStandardsControlsOutput

type DescribeStandardsControlsOutput struct {

	// A list of security standards controls.
	Controls []*StandardsControl `type:"list"`

	// The pagination token to use to request the next page of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeStandardsControlsOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStandardsControlsOutput) SetControls

SetControls sets the Controls field's value.

func (*DescribeStandardsControlsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (DescribeStandardsControlsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStandardsInput

type DescribeStandardsInput struct {

	// The maximum number of standards to return.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The token that is required for pagination. On your first call to the DescribeStandards
	// operation, set the value of this parameter to NULL.
	//
	// For subsequent calls to the operation, to continue listing data, set the
	// value of this parameter to the value returned from the previous response.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeStandardsInput) GoString

func (s DescribeStandardsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStandardsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*DescribeStandardsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (DescribeStandardsInput) String

func (s DescribeStandardsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStandardsInput) Validate

func (s *DescribeStandardsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeStandardsOutput

type DescribeStandardsOutput struct {

	// The pagination token to use to request the next page of results.
	NextToken *string `type:"string"`

	// A list of available standards.
	Standards []*Standard `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeStandardsOutput) GoString

func (s DescribeStandardsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStandardsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*DescribeStandardsOutput) SetStandards

SetStandards sets the Standards field's value.

func (DescribeStandardsOutput) String

func (s DescribeStandardsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisableImportFindingsForProductInput

type DisableImportFindingsForProductInput struct {

	// The ARN of the integrated product to disable the integration for.
	//
	// ProductSubscriptionArn is a required field
	ProductSubscriptionArn *string `location:"uri" locationName:"ProductSubscriptionArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisableImportFindingsForProductInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisableImportFindingsForProductInput) SetProductSubscriptionArn

SetProductSubscriptionArn sets the ProductSubscriptionArn field's value.

func (DisableImportFindingsForProductInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisableImportFindingsForProductInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DisableImportFindingsForProductOutput

type DisableImportFindingsForProductOutput struct {
	// contains filtered or unexported fields
}

func (DisableImportFindingsForProductOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisableImportFindingsForProductOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisableOrganizationAdminAccountInput

type DisableOrganizationAdminAccountInput struct {

	// The Amazon Web Services account identifier of the Security Hub administrator
	// account.
	//
	// AdminAccountId is a required field
	AdminAccountId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisableOrganizationAdminAccountInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisableOrganizationAdminAccountInput) SetAdminAccountId

SetAdminAccountId sets the AdminAccountId field's value.

func (DisableOrganizationAdminAccountInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisableOrganizationAdminAccountInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DisableOrganizationAdminAccountOutput

type DisableOrganizationAdminAccountOutput struct {
	// contains filtered or unexported fields
}

func (DisableOrganizationAdminAccountOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisableOrganizationAdminAccountOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisableSecurityHubInput

type DisableSecurityHubInput struct {
	// contains filtered or unexported fields
}

func (DisableSecurityHubInput) GoString

func (s DisableSecurityHubInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisableSecurityHubInput) String

func (s DisableSecurityHubInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisableSecurityHubOutput

type DisableSecurityHubOutput struct {
	// contains filtered or unexported fields
}

func (DisableSecurityHubOutput) GoString

func (s DisableSecurityHubOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisableSecurityHubOutput) String

func (s DisableSecurityHubOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateFromAdministratorAccountInput

type DisassociateFromAdministratorAccountInput struct {
	// contains filtered or unexported fields
}

func (DisassociateFromAdministratorAccountInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisassociateFromAdministratorAccountInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateFromAdministratorAccountOutput

type DisassociateFromAdministratorAccountOutput struct {
	// contains filtered or unexported fields
}

func (DisassociateFromAdministratorAccountOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisassociateFromAdministratorAccountOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateFromMasterAccountInput

type DisassociateFromMasterAccountInput struct {
	// contains filtered or unexported fields
}

func (DisassociateFromMasterAccountInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisassociateFromMasterAccountInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateFromMasterAccountOutput

type DisassociateFromMasterAccountOutput struct {
	// contains filtered or unexported fields
}

func (DisassociateFromMasterAccountOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisassociateFromMasterAccountOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateMembersInput

type DisassociateMembersInput struct {

	// The account IDs of the member accounts to disassociate from the administrator
	// account.
	//
	// AccountIds is a required field
	AccountIds []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateMembersInput) GoString

func (s DisassociateMembersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateMembersInput) SetAccountIds

SetAccountIds sets the AccountIds field's value.

func (DisassociateMembersInput) String

func (s DisassociateMembersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateMembersInput) Validate

func (s *DisassociateMembersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateMembersOutput

type DisassociateMembersOutput struct {
	// contains filtered or unexported fields
}

func (DisassociateMembersOutput) GoString

func (s DisassociateMembersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisassociateMembersOutput) String

func (s DisassociateMembersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DnsRequestAction

type DnsRequestAction struct {

	// Indicates whether the DNS request was blocked.
	Blocked *bool `type:"boolean"`

	// The DNS domain that is associated with the DNS request.
	Domain *string `type:"string"`

	// The protocol that was used for the DNS request.
	Protocol *string `type:"string"`
	// contains filtered or unexported fields
}

Provided if ActionType is DNS_REQUEST. It provides details about the DNS request that was detected.

func (DnsRequestAction) GoString

func (s DnsRequestAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DnsRequestAction) SetBlocked

func (s *DnsRequestAction) SetBlocked(v bool) *DnsRequestAction

SetBlocked sets the Blocked field's value.

func (*DnsRequestAction) SetDomain

func (s *DnsRequestAction) SetDomain(v string) *DnsRequestAction

SetDomain sets the Domain field's value.

func (*DnsRequestAction) SetProtocol

func (s *DnsRequestAction) SetProtocol(v string) *DnsRequestAction

SetProtocol sets the Protocol field's value.

func (DnsRequestAction) String

func (s DnsRequestAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EnableImportFindingsForProductInput

type EnableImportFindingsForProductInput struct {

	// The ARN of the product to enable the integration for.
	//
	// ProductArn is a required field
	ProductArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (EnableImportFindingsForProductInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableImportFindingsForProductInput) SetProductArn

SetProductArn sets the ProductArn field's value.

func (EnableImportFindingsForProductInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableImportFindingsForProductInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type EnableImportFindingsForProductOutput

type EnableImportFindingsForProductOutput struct {

	// The ARN of your subscription to the product to enable integrations for.
	ProductSubscriptionArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (EnableImportFindingsForProductOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableImportFindingsForProductOutput) SetProductSubscriptionArn

SetProductSubscriptionArn sets the ProductSubscriptionArn field's value.

func (EnableImportFindingsForProductOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EnableOrganizationAdminAccountInput

type EnableOrganizationAdminAccountInput struct {

	// The Amazon Web Services account identifier of the account to designate as
	// the Security Hub administrator account.
	//
	// AdminAccountId is a required field
	AdminAccountId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (EnableOrganizationAdminAccountInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableOrganizationAdminAccountInput) SetAdminAccountId

SetAdminAccountId sets the AdminAccountId field's value.

func (EnableOrganizationAdminAccountInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableOrganizationAdminAccountInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type EnableOrganizationAdminAccountOutput

type EnableOrganizationAdminAccountOutput struct {
	// contains filtered or unexported fields
}

func (EnableOrganizationAdminAccountOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (EnableOrganizationAdminAccountOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EnableSecurityHubInput

type EnableSecurityHubInput struct {

	// This field, used when enabling Security Hub, specifies whether the calling
	// account has consolidated control findings turned on. If the value for this
	// field is set to SECURITY_CONTROL, Security Hub generates a single finding
	// for a control check even when the check applies to multiple enabled standards.
	//
	// If the value for this field is set to STANDARD_CONTROL, Security Hub generates
	// separate findings for a control check when the check applies to multiple
	// enabled standards.
	//
	// The value for this field in a member account matches the value in the administrator
	// account. For accounts that aren't part of an organization, the default value
	// of this field is SECURITY_CONTROL if you enabled Security Hub on or after
	// February 23, 2023.
	ControlFindingGenerator *string `type:"string" enum:"ControlFindingGenerator"`

	// Whether to enable the security standards that Security Hub has designated
	// as automatically enabled. If you do not provide a value for EnableDefaultStandards,
	// it is set to true. To not enable the automatically enabled standards, set
	// EnableDefaultStandards to false.
	EnableDefaultStandards *bool `type:"boolean"`

	// The tags to add to the hub resource when you enable Security Hub.
	Tags map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (EnableSecurityHubInput) GoString

func (s EnableSecurityHubInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableSecurityHubInput) SetControlFindingGenerator added in v1.42.9

func (s *EnableSecurityHubInput) SetControlFindingGenerator(v string) *EnableSecurityHubInput

SetControlFindingGenerator sets the ControlFindingGenerator field's value.

func (*EnableSecurityHubInput) SetEnableDefaultStandards

func (s *EnableSecurityHubInput) SetEnableDefaultStandards(v bool) *EnableSecurityHubInput

SetEnableDefaultStandards sets the EnableDefaultStandards field's value.

func (*EnableSecurityHubInput) SetTags

SetTags sets the Tags field's value.

func (EnableSecurityHubInput) String

func (s EnableSecurityHubInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableSecurityHubInput) Validate

func (s *EnableSecurityHubInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EnableSecurityHubOutput

type EnableSecurityHubOutput struct {
	// contains filtered or unexported fields
}

func (EnableSecurityHubOutput) GoString

func (s EnableSecurityHubOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (EnableSecurityHubOutput) String

func (s EnableSecurityHubOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FilePaths added in v1.42.9

type FilePaths struct {

	// The name of the infected or suspicious file corresponding to the hash.
	FileName *string `type:"string"`

	// Path to the infected or suspicious file on the resource it was detected on.
	FilePath *string `type:"string"`

	// The hash value for the infected or suspicious file.
	Hash *string `type:"string"`

	// The Amazon Resource Name (ARN) of the resource on which the threat was detected.
	ResourceId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the file paths that were affected by the threat.

func (FilePaths) GoString added in v1.42.9

func (s FilePaths) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FilePaths) SetFileName added in v1.42.9

func (s *FilePaths) SetFileName(v string) *FilePaths

SetFileName sets the FileName field's value.

func (*FilePaths) SetFilePath added in v1.42.9

func (s *FilePaths) SetFilePath(v string) *FilePaths

SetFilePath sets the FilePath field's value.

func (*FilePaths) SetHash added in v1.42.9

func (s *FilePaths) SetHash(v string) *FilePaths

SetHash sets the Hash field's value.

func (*FilePaths) SetResourceId added in v1.42.9

func (s *FilePaths) SetResourceId(v string) *FilePaths

SetResourceId sets the ResourceId field's value.

func (FilePaths) String added in v1.42.9

func (s FilePaths) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FindingAggregator

type FindingAggregator struct {

	// The ARN of the finding aggregator. You use the finding aggregator ARN to
	// retrieve details for, update, and delete the finding aggregator.
	FindingAggregatorArn *string `type:"string"`
	// contains filtered or unexported fields
}

A finding aggregator. A finding aggregator contains the configuration for finding aggregation.

func (FindingAggregator) GoString

func (s FindingAggregator) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FindingAggregator) SetFindingAggregatorArn

func (s *FindingAggregator) SetFindingAggregatorArn(v string) *FindingAggregator

SetFindingAggregatorArn sets the FindingAggregatorArn field's value.

func (FindingAggregator) String

func (s FindingAggregator) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FindingHistoryRecord added in v1.42.9

type FindingHistoryRecord struct {

	// Identifies whether the event marks the creation of a new finding. A value
	// of True means that the finding is newly created. A value of False means that
	// the finding isn’t newly created.
	FindingCreated *bool `type:"boolean"`

	// Identifies which finding to get the finding history for.
	FindingIdentifier *AwsSecurityFindingIdentifier `type:"structure"`

	// A token for pagination purposes. Provide this token in the subsequent request
	// to GetFindingsHistory (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_GetFindingsHistory.html)
	// to get up to an additional 100 results of history for the same finding that
	// you specified in your initial request.
	NextToken *string `type:"string"`

	// Identifies the source of the event that changed the finding. For example,
	// an integrated Amazon Web Service or third-party partner integration may call
	// BatchImportFindings (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html),
	// or an Security Hub customer may call BatchUpdateFindings (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html).
	UpdateSource *FindingHistoryUpdateSource `type:"structure"`

	// An ISO 8601-formatted timestamp that indicates when Security Hub processed
	// the updated finding record.
	//
	// A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot
	// contain spaces, and date and time should be separated by T. For more information,
	// see RFC 3339 section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6).
	UpdateTime *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// An array of objects that provides details about the finding change event,
	// including the Amazon Web Services Security Finding Format (ASFF) field that
	// changed, the value of the field before the change, and the value of the field
	// after the change.
	Updates []*FindingHistoryUpdate `type:"list"`
	// contains filtered or unexported fields
}

A list of events that changed the specified finding during the specified time period. Each record represents a single finding change event.

func (FindingHistoryRecord) GoString added in v1.42.9

func (s FindingHistoryRecord) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FindingHistoryRecord) SetFindingCreated added in v1.42.9

func (s *FindingHistoryRecord) SetFindingCreated(v bool) *FindingHistoryRecord

SetFindingCreated sets the FindingCreated field's value.

func (*FindingHistoryRecord) SetFindingIdentifier added in v1.42.9

SetFindingIdentifier sets the FindingIdentifier field's value.

func (*FindingHistoryRecord) SetNextToken added in v1.42.9

func (s *FindingHistoryRecord) SetNextToken(v string) *FindingHistoryRecord

SetNextToken sets the NextToken field's value.

func (*FindingHistoryRecord) SetUpdateSource added in v1.42.9

SetUpdateSource sets the UpdateSource field's value.

func (*FindingHistoryRecord) SetUpdateTime added in v1.42.9

func (s *FindingHistoryRecord) SetUpdateTime(v time.Time) *FindingHistoryRecord

SetUpdateTime sets the UpdateTime field's value.

func (*FindingHistoryRecord) SetUpdates added in v1.42.9

SetUpdates sets the Updates field's value.

func (FindingHistoryRecord) String added in v1.42.9

func (s FindingHistoryRecord) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FindingHistoryUpdate added in v1.42.9

type FindingHistoryUpdate struct {

	// The value of the ASFF field after the finding change event. To preserve storage
	// and readability, Security Hub omits this value if FindingHistoryRecord (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_FindingHistoryRecord.html)
	// exceeds database limits.
	NewValue *string `type:"string"`

	// The value of the ASFF field before the finding change event.
	OldValue *string `type:"string"`

	// The ASFF field that changed during the finding change event.
	UpdatedField *string `type:"string"`
	// contains filtered or unexported fields
}

An array of objects that provides details about a change to a finding, including the Amazon Web Services Security Finding Format (ASFF) field that changed, the value of the field before the change, and the value of the field after the change.

func (FindingHistoryUpdate) GoString added in v1.42.9

func (s FindingHistoryUpdate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FindingHistoryUpdate) SetNewValue added in v1.42.9

SetNewValue sets the NewValue field's value.

func (*FindingHistoryUpdate) SetOldValue added in v1.42.9

SetOldValue sets the OldValue field's value.

func (*FindingHistoryUpdate) SetUpdatedField added in v1.42.9

func (s *FindingHistoryUpdate) SetUpdatedField(v string) *FindingHistoryUpdate

SetUpdatedField sets the UpdatedField field's value.

func (FindingHistoryUpdate) String added in v1.42.9

func (s FindingHistoryUpdate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FindingHistoryUpdateSource added in v1.42.9

type FindingHistoryUpdateSource struct {

	// The identity of the source that initiated the finding change event. For example,
	// the Amazon Resource Name (ARN) of a partner that calls BatchImportFindings
	// or of a customer that calls BatchUpdateFindings.
	Identity *string `type:"string"`

	// Describes the type of finding change event, such as a call to BatchImportFindings
	// (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html)
	// (by an integrated Amazon Web Service or third party partner integration)
	// or BatchUpdateFindings (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html)
	// (by a Security Hub customer).
	Type *string `type:"string" enum:"FindingHistoryUpdateSourceType"`
	// contains filtered or unexported fields
}

Identifies the source of the finding change event.

func (FindingHistoryUpdateSource) GoString added in v1.42.9

func (s FindingHistoryUpdateSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FindingHistoryUpdateSource) SetIdentity added in v1.42.9

SetIdentity sets the Identity field's value.

func (*FindingHistoryUpdateSource) SetType added in v1.42.9

SetType sets the Type field's value.

func (FindingHistoryUpdateSource) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FindingProviderFields

type FindingProviderFields struct {

	// A finding's confidence. Confidence is defined as the likelihood that a finding
	// accurately identifies the behavior or issue that it was intended to identify.
	//
	// Confidence is scored on a 0-100 basis using a ratio scale, where 0 means
	// zero percent confidence and 100 means 100 percent confidence.
	Confidence *int64 `type:"integer"`

	// The level of importance assigned to the resources associated with the finding.
	//
	// A score of 0 means that the underlying resources have no criticality, and
	// a score of 100 is reserved for the most critical resources.
	Criticality *int64 `type:"integer"`

	// A list of findings that are related to the current finding.
	RelatedFindings []*RelatedFinding `type:"list"`

	// The severity of a finding.
	Severity *FindingProviderSeverity `type:"structure"`

	// One or more finding types in the format of namespace/category/classifier
	// that classify a finding.
	//
	// Valid namespace values are: Software and Configuration Checks | TTPs | Effects
	// | Unusual Behaviors | Sensitive Data Identifications
	Types []*string `type:"list"`
	// contains filtered or unexported fields
}

In a BatchImportFindings request, finding providers use FindingProviderFields to provide and update values for confidence, criticality, related findings, severity, and types.

func (FindingProviderFields) GoString

func (s FindingProviderFields) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FindingProviderFields) SetConfidence

func (s *FindingProviderFields) SetConfidence(v int64) *FindingProviderFields

SetConfidence sets the Confidence field's value.

func (*FindingProviderFields) SetCriticality

func (s *FindingProviderFields) SetCriticality(v int64) *FindingProviderFields

SetCriticality sets the Criticality field's value.

func (*FindingProviderFields) SetRelatedFindings

func (s *FindingProviderFields) SetRelatedFindings(v []*RelatedFinding) *FindingProviderFields

SetRelatedFindings sets the RelatedFindings field's value.

func (*FindingProviderFields) SetSeverity

SetSeverity sets the Severity field's value.

func (*FindingProviderFields) SetTypes

SetTypes sets the Types field's value.

func (FindingProviderFields) String

func (s FindingProviderFields) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FindingProviderFields) Validate

func (s *FindingProviderFields) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FindingProviderSeverity

type FindingProviderSeverity struct {

	// The severity label assigned to the finding by the finding provider.
	Label *string `type:"string" enum:"SeverityLabel"`

	// The finding provider's original value for the severity.
	Original *string `type:"string"`
	// contains filtered or unexported fields
}

The severity assigned to the finding by the finding provider.

func (FindingProviderSeverity) GoString

func (s FindingProviderSeverity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FindingProviderSeverity) SetLabel

SetLabel sets the Label field's value.

func (*FindingProviderSeverity) SetOriginal

SetOriginal sets the Original field's value.

func (FindingProviderSeverity) String

func (s FindingProviderSeverity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FirewallPolicyDetails added in v1.42.9

type FirewallPolicyDetails struct {

	// The stateful rule groups that are used in the firewall policy.
	StatefulRuleGroupReferences []*FirewallPolicyStatefulRuleGroupReferencesDetails `type:"list"`

	// The custom action definitions that are available to use in the firewall policy's
	// StatelessDefaultActions setting.
	StatelessCustomActions []*FirewallPolicyStatelessCustomActionsDetails `type:"list"`

	// The actions to take on a packet if it doesn't match any of the stateless
	// rules in the policy.
	//
	// You must specify a standard action (aws:pass, aws:drop, aws:forward_to_sfe),
	// and can optionally include a custom action from StatelessCustomActions.
	StatelessDefaultActions []*string `type:"list"`

	// The actions to take on a fragmented UDP packet if it doesn't match any of
	// the stateless rules in the policy.
	//
	// You must specify a standard action (aws:pass, aws:drop, aws:forward_to_sfe),
	// and can optionally include a custom action from StatelessCustomActions.
	StatelessFragmentDefaultActions []*string `type:"list"`

	// The stateless rule groups that are used in the firewall policy.
	StatelessRuleGroupReferences []*FirewallPolicyStatelessRuleGroupReferencesDetails `type:"list"`
	// contains filtered or unexported fields
}

Defines the behavior of the firewall.

func (FirewallPolicyDetails) GoString added in v1.42.9

func (s FirewallPolicyDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FirewallPolicyDetails) SetStatefulRuleGroupReferences added in v1.42.9

SetStatefulRuleGroupReferences sets the StatefulRuleGroupReferences field's value.

func (*FirewallPolicyDetails) SetStatelessCustomActions added in v1.42.9

SetStatelessCustomActions sets the StatelessCustomActions field's value.

func (*FirewallPolicyDetails) SetStatelessDefaultActions added in v1.42.9

func (s *FirewallPolicyDetails) SetStatelessDefaultActions(v []*string) *FirewallPolicyDetails

SetStatelessDefaultActions sets the StatelessDefaultActions field's value.

func (*FirewallPolicyDetails) SetStatelessFragmentDefaultActions added in v1.42.9

func (s *FirewallPolicyDetails) SetStatelessFragmentDefaultActions(v []*string) *FirewallPolicyDetails

SetStatelessFragmentDefaultActions sets the StatelessFragmentDefaultActions field's value.

func (*FirewallPolicyDetails) SetStatelessRuleGroupReferences added in v1.42.9

SetStatelessRuleGroupReferences sets the StatelessRuleGroupReferences field's value.

func (FirewallPolicyDetails) String added in v1.42.9

func (s FirewallPolicyDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FirewallPolicyStatefulRuleGroupReferencesDetails added in v1.42.9

type FirewallPolicyStatefulRuleGroupReferencesDetails struct {

	// The ARN of the stateful rule group.
	ResourceArn *string `type:"string"`
	// contains filtered or unexported fields
}

A stateful rule group that is used by the firewall policy.

func (FirewallPolicyStatefulRuleGroupReferencesDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FirewallPolicyStatefulRuleGroupReferencesDetails) SetResourceArn added in v1.42.9

SetResourceArn sets the ResourceArn field's value.

func (FirewallPolicyStatefulRuleGroupReferencesDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FirewallPolicyStatelessCustomActionsDetails added in v1.42.9

type FirewallPolicyStatelessCustomActionsDetails struct {

	// The definition of the custom action.
	ActionDefinition *StatelessCustomActionDefinition `type:"structure"`

	// The name of the custom action.
	ActionName *string `type:"string"`
	// contains filtered or unexported fields
}

A custom action that can be used for stateless packet handling.

func (FirewallPolicyStatelessCustomActionsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FirewallPolicyStatelessCustomActionsDetails) SetActionDefinition added in v1.42.9

SetActionDefinition sets the ActionDefinition field's value.

func (*FirewallPolicyStatelessCustomActionsDetails) SetActionName added in v1.42.9

SetActionName sets the ActionName field's value.

func (FirewallPolicyStatelessCustomActionsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FirewallPolicyStatelessRuleGroupReferencesDetails added in v1.42.9

type FirewallPolicyStatelessRuleGroupReferencesDetails struct {

	// The order in which to run the stateless rule group.
	Priority *int64 `type:"integer"`

	// The ARN of the stateless rule group.
	ResourceArn *string `type:"string"`
	// contains filtered or unexported fields
}

A stateless rule group that is used by the firewall policy.

func (FirewallPolicyStatelessRuleGroupReferencesDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FirewallPolicyStatelessRuleGroupReferencesDetails) SetPriority added in v1.42.9

SetPriority sets the Priority field's value.

func (*FirewallPolicyStatelessRuleGroupReferencesDetails) SetResourceArn added in v1.42.9

SetResourceArn sets the ResourceArn field's value.

func (FirewallPolicyStatelessRuleGroupReferencesDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GeoLocation

type GeoLocation struct {

	// The latitude of the location.
	Lat *float64 `type:"double"`

	// The longitude of the location.
	Lon *float64 `type:"double"`
	// contains filtered or unexported fields
}

Provides the latitude and longitude coordinates of a location.

func (GeoLocation) GoString

func (s GeoLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GeoLocation) SetLat

func (s *GeoLocation) SetLat(v float64) *GeoLocation

SetLat sets the Lat field's value.

func (*GeoLocation) SetLon

func (s *GeoLocation) SetLon(v float64) *GeoLocation

SetLon sets the Lon field's value.

func (GeoLocation) String

func (s GeoLocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAdministratorAccountInput

type GetAdministratorAccountInput struct {
	// contains filtered or unexported fields
}

func (GetAdministratorAccountInput) GoString

func (s GetAdministratorAccountInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetAdministratorAccountInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAdministratorAccountOutput

type GetAdministratorAccountOutput struct {

	// Details about an invitation.
	Administrator *Invitation `type:"structure"`
	// contains filtered or unexported fields
}

func (GetAdministratorAccountOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAdministratorAccountOutput) SetAdministrator

SetAdministrator sets the Administrator field's value.

func (GetAdministratorAccountOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetEnabledStandardsInput

type GetEnabledStandardsInput struct {

	// The maximum number of results to return in the response.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token that is required for pagination. On your first call to the GetEnabledStandards
	// operation, set the value of this parameter to NULL.
	//
	// For subsequent calls to the operation, to continue listing data, set the
	// value of this parameter to the value returned from the previous response.
	NextToken *string `type:"string"`

	// The list of the standards subscription ARNs for the standards to retrieve.
	StandardsSubscriptionArns []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (GetEnabledStandardsInput) GoString

func (s GetEnabledStandardsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEnabledStandardsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*GetEnabledStandardsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*GetEnabledStandardsInput) SetStandardsSubscriptionArns

func (s *GetEnabledStandardsInput) SetStandardsSubscriptionArns(v []*string) *GetEnabledStandardsInput

SetStandardsSubscriptionArns sets the StandardsSubscriptionArns field's value.

func (GetEnabledStandardsInput) String

func (s GetEnabledStandardsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEnabledStandardsInput) Validate

func (s *GetEnabledStandardsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetEnabledStandardsOutput

type GetEnabledStandardsOutput struct {

	// The pagination token to use to request the next page of results.
	NextToken *string `type:"string"`

	// The list of StandardsSubscriptions objects that include information about
	// the enabled standards.
	StandardsSubscriptions []*StandardsSubscription `type:"list"`
	// contains filtered or unexported fields
}

func (GetEnabledStandardsOutput) GoString

func (s GetEnabledStandardsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEnabledStandardsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*GetEnabledStandardsOutput) SetStandardsSubscriptions

SetStandardsSubscriptions sets the StandardsSubscriptions field's value.

func (GetEnabledStandardsOutput) String

func (s GetEnabledStandardsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetFindingAggregatorInput

type GetFindingAggregatorInput struct {

	// The ARN of the finding aggregator to return details for. To obtain the ARN,
	// use ListFindingAggregators.
	//
	// FindingAggregatorArn is a required field
	FindingAggregatorArn *string `location:"uri" locationName:"FindingAggregatorArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetFindingAggregatorInput) GoString

func (s GetFindingAggregatorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFindingAggregatorInput) SetFindingAggregatorArn

func (s *GetFindingAggregatorInput) SetFindingAggregatorArn(v string) *GetFindingAggregatorInput

SetFindingAggregatorArn sets the FindingAggregatorArn field's value.

func (GetFindingAggregatorInput) String

func (s GetFindingAggregatorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFindingAggregatorInput) Validate

func (s *GetFindingAggregatorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetFindingAggregatorOutput

type GetFindingAggregatorOutput struct {

	// The aggregation Region.
	FindingAggregationRegion *string `type:"string"`

	// The ARN of the finding aggregator.
	FindingAggregatorArn *string `type:"string"`

	// Indicates whether to link all Regions, all Regions except for a list of excluded
	// Regions, or a list of included Regions.
	RegionLinkingMode *string `type:"string"`

	// The list of excluded Regions or included Regions.
	Regions []*string `type:"list"`
	// contains filtered or unexported fields
}

func (GetFindingAggregatorOutput) GoString

func (s GetFindingAggregatorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFindingAggregatorOutput) SetFindingAggregationRegion

func (s *GetFindingAggregatorOutput) SetFindingAggregationRegion(v string) *GetFindingAggregatorOutput

SetFindingAggregationRegion sets the FindingAggregationRegion field's value.

func (*GetFindingAggregatorOutput) SetFindingAggregatorArn

func (s *GetFindingAggregatorOutput) SetFindingAggregatorArn(v string) *GetFindingAggregatorOutput

SetFindingAggregatorArn sets the FindingAggregatorArn field's value.

func (*GetFindingAggregatorOutput) SetRegionLinkingMode

func (s *GetFindingAggregatorOutput) SetRegionLinkingMode(v string) *GetFindingAggregatorOutput

SetRegionLinkingMode sets the RegionLinkingMode field's value.

func (*GetFindingAggregatorOutput) SetRegions

SetRegions sets the Regions field's value.

func (GetFindingAggregatorOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetFindingHistoryInput added in v1.42.9

type GetFindingHistoryInput struct {

	// An ISO 8601-formatted timestamp that indicates the end time of the requested
	// finding history. A correctly formatted example is 2020-05-21T20:16:34.724Z.
	// The value cannot contain spaces, and date and time should be separated by
	// T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format
	// (https://www.rfc-editor.org/rfc/rfc3339#section-5.6).
	//
	// If you provide values for both StartTime and EndTime, Security Hub returns
	// finding history for the specified time period. If you provide a value for
	// StartTime but not for EndTime, Security Hub returns finding history from
	// the StartTime to the time at which the API is called. If you provide a value
	// for EndTime but not for StartTime, Security Hub returns finding history from
	// the CreatedAt (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_AwsSecurityFindingFilters.html#securityhub-Type-AwsSecurityFindingFilters-CreatedAt)
	// timestamp of the finding to the EndTime. If you provide neither StartTime
	// nor EndTime, Security Hub returns finding history from the CreatedAt timestamp
	// of the finding to the time at which the API is called. In all of these scenarios,
	// the response is limited to 100 results, and the maximum time period is limited
	// to 90 days.
	EndTime *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// Identifies which finding to get the finding history for.
	//
	// FindingIdentifier is a required field
	FindingIdentifier *AwsSecurityFindingIdentifier `type:"structure" required:"true"`

	// The maximum number of results to be returned. If you don’t provide it,
	// Security Hub returns up to 100 results of finding history.
	MaxResults *int64 `min:"1" type:"integer"`

	// A token for pagination purposes. Provide NULL as the initial value. In subsequent
	// requests, provide the token included in the response to get up to an additional
	// 100 results of finding history. If you don’t provide NextToken, Security
	// Hub returns up to 100 results of finding history for each request.
	NextToken *string `type:"string"`

	// An ISO 8601-formatted timestamp that indicates the start time of the requested
	// finding history. A correctly formatted example is 2020-05-21T20:16:34.724Z.
	// The value cannot contain spaces, and date and time should be separated by
	// T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format
	// (https://www.rfc-editor.org/rfc/rfc3339#section-5.6).
	//
	// If you provide values for both StartTime and EndTime, Security Hub returns
	// finding history for the specified time period. If you provide a value for
	// StartTime but not for EndTime, Security Hub returns finding history from
	// the StartTime to the time at which the API is called. If you provide a value
	// for EndTime but not for StartTime, Security Hub returns finding history from
	// the CreatedAt (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_AwsSecurityFindingFilters.html#securityhub-Type-AwsSecurityFindingFilters-CreatedAt)
	// timestamp of the finding to the EndTime. If you provide neither StartTime
	// nor EndTime, Security Hub returns finding history from the CreatedAt timestamp
	// of the finding to the time at which the API is called. In all of these scenarios,
	// the response is limited to 100 results, and the maximum time period is limited
	// to 90 days.
	StartTime *time.Time `type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (GetFindingHistoryInput) GoString added in v1.42.9

func (s GetFindingHistoryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFindingHistoryInput) SetEndTime added in v1.42.9

SetEndTime sets the EndTime field's value.

func (*GetFindingHistoryInput) SetFindingIdentifier added in v1.42.9

SetFindingIdentifier sets the FindingIdentifier field's value.

func (*GetFindingHistoryInput) SetMaxResults added in v1.42.9

SetMaxResults sets the MaxResults field's value.

func (*GetFindingHistoryInput) SetNextToken added in v1.42.9

SetNextToken sets the NextToken field's value.

func (*GetFindingHistoryInput) SetStartTime added in v1.42.9

SetStartTime sets the StartTime field's value.

func (GetFindingHistoryInput) String added in v1.42.9

func (s GetFindingHistoryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFindingHistoryInput) Validate added in v1.42.9

func (s *GetFindingHistoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetFindingHistoryOutput added in v1.42.9

type GetFindingHistoryOutput struct {

	// A token for pagination purposes. Provide this token in the subsequent request
	// to GetFindingsHistory to get up to an additional 100 results of history for
	// the same finding that you specified in your initial request.
	NextToken *string `type:"string"`

	// A list of events that altered the specified finding during the specified
	// time period.
	Records []*FindingHistoryRecord `type:"list"`
	// contains filtered or unexported fields
}

func (GetFindingHistoryOutput) GoString added in v1.42.9

func (s GetFindingHistoryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFindingHistoryOutput) SetNextToken added in v1.42.9

SetNextToken sets the NextToken field's value.

func (*GetFindingHistoryOutput) SetRecords added in v1.42.9

SetRecords sets the Records field's value.

func (GetFindingHistoryOutput) String added in v1.42.9

func (s GetFindingHistoryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetFindingsInput

type GetFindingsInput struct {

	// The finding attributes used to define a condition to filter the returned
	// findings.
	//
	// You can filter by up to 10 finding attributes. For each attribute, you can
	// provide up to 20 filter values.
	//
	// Note that in the available filter fields, WorkflowState is deprecated. To
	// search for a finding based on its workflow status, use WorkflowStatus.
	Filters *AwsSecurityFindingFilters `type:"structure"`

	// The maximum number of findings to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token that is required for pagination. On your first call to the GetFindings
	// operation, set the value of this parameter to NULL.
	//
	// For subsequent calls to the operation, to continue listing data, set the
	// value of this parameter to the value returned from the previous response.
	NextToken *string `type:"string"`

	// The finding attributes used to sort the list of returned findings.
	SortCriteria []*SortCriterion `type:"list"`
	// contains filtered or unexported fields
}

func (GetFindingsInput) GoString

func (s GetFindingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFindingsInput) SetFilters

SetFilters sets the Filters field's value.

func (*GetFindingsInput) SetMaxResults

func (s *GetFindingsInput) SetMaxResults(v int64) *GetFindingsInput

SetMaxResults sets the MaxResults field's value.

func (*GetFindingsInput) SetNextToken

func (s *GetFindingsInput) SetNextToken(v string) *GetFindingsInput

SetNextToken sets the NextToken field's value.

func (*GetFindingsInput) SetSortCriteria

func (s *GetFindingsInput) SetSortCriteria(v []*SortCriterion) *GetFindingsInput

SetSortCriteria sets the SortCriteria field's value.

func (GetFindingsInput) String

func (s GetFindingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFindingsInput) Validate

func (s *GetFindingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetFindingsOutput

type GetFindingsOutput struct {

	// The findings that matched the filters specified in the request.
	//
	// Findings is a required field
	Findings []*AwsSecurityFinding `type:"list" required:"true"`

	// The pagination token to use to request the next page of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetFindingsOutput) GoString

func (s GetFindingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFindingsOutput) SetFindings

SetFindings sets the Findings field's value.

func (*GetFindingsOutput) SetNextToken

func (s *GetFindingsOutput) SetNextToken(v string) *GetFindingsOutput

SetNextToken sets the NextToken field's value.

func (GetFindingsOutput) String

func (s GetFindingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetInsightResultsInput

type GetInsightResultsInput struct {

	// The ARN of the insight for which to return results.
	//
	// InsightArn is a required field
	InsightArn *string `location:"uri" locationName:"InsightArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetInsightResultsInput) GoString

func (s GetInsightResultsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInsightResultsInput) SetInsightArn

SetInsightArn sets the InsightArn field's value.

func (GetInsightResultsInput) String

func (s GetInsightResultsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInsightResultsInput) Validate

func (s *GetInsightResultsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetInsightResultsOutput

type GetInsightResultsOutput struct {

	// The insight results returned by the operation.
	//
	// InsightResults is a required field
	InsightResults *InsightResults `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetInsightResultsOutput) GoString

func (s GetInsightResultsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInsightResultsOutput) SetInsightResults

SetInsightResults sets the InsightResults field's value.

func (GetInsightResultsOutput) String

func (s GetInsightResultsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetInsightsInput

type GetInsightsInput struct {

	// The ARNs of the insights to describe. If you do not provide any insight ARNs,
	// then GetInsights returns all of your custom insights. It does not return
	// any managed insights.
	InsightArns []*string `type:"list"`

	// The maximum number of items to return in the response.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token that is required for pagination. On your first call to the GetInsights
	// operation, set the value of this parameter to NULL.
	//
	// For subsequent calls to the operation, to continue listing data, set the
	// value of this parameter to the value returned from the previous response.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetInsightsInput) GoString

func (s GetInsightsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInsightsInput) SetInsightArns

func (s *GetInsightsInput) SetInsightArns(v []*string) *GetInsightsInput

SetInsightArns sets the InsightArns field's value.

func (*GetInsightsInput) SetMaxResults

func (s *GetInsightsInput) SetMaxResults(v int64) *GetInsightsInput

SetMaxResults sets the MaxResults field's value.

func (*GetInsightsInput) SetNextToken

func (s *GetInsightsInput) SetNextToken(v string) *GetInsightsInput

SetNextToken sets the NextToken field's value.

func (GetInsightsInput) String

func (s GetInsightsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInsightsInput) Validate

func (s *GetInsightsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetInsightsOutput

type GetInsightsOutput struct {

	// The insights returned by the operation.
	//
	// Insights is a required field
	Insights []*Insight `type:"list" required:"true"`

	// The pagination token to use to request the next page of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetInsightsOutput) GoString

func (s GetInsightsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInsightsOutput) SetInsights

func (s *GetInsightsOutput) SetInsights(v []*Insight) *GetInsightsOutput

SetInsights sets the Insights field's value.

func (*GetInsightsOutput) SetNextToken

func (s *GetInsightsOutput) SetNextToken(v string) *GetInsightsOutput

SetNextToken sets the NextToken field's value.

func (GetInsightsOutput) String

func (s GetInsightsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetInvitationsCountInput

type GetInvitationsCountInput struct {
	// contains filtered or unexported fields
}

func (GetInvitationsCountInput) GoString

func (s GetInvitationsCountInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetInvitationsCountInput) String

func (s GetInvitationsCountInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetInvitationsCountOutput

type GetInvitationsCountOutput struct {

	// The number of all membership invitations sent to this Security Hub member
	// account, not including the currently accepted invitation.
	InvitationsCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (GetInvitationsCountOutput) GoString

func (s GetInvitationsCountOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInvitationsCountOutput) SetInvitationsCount

func (s *GetInvitationsCountOutput) SetInvitationsCount(v int64) *GetInvitationsCountOutput

SetInvitationsCount sets the InvitationsCount field's value.

func (GetInvitationsCountOutput) String

func (s GetInvitationsCountOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetMasterAccountInput

type GetMasterAccountInput struct {
	// contains filtered or unexported fields
}

func (GetMasterAccountInput) GoString

func (s GetMasterAccountInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetMasterAccountInput) String

func (s GetMasterAccountInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetMasterAccountOutput

type GetMasterAccountOutput struct {

	// A list of details about the Security Hub administrator account for the current
	// member account.
	Master *Invitation `type:"structure"`
	// contains filtered or unexported fields
}

func (GetMasterAccountOutput) GoString

func (s GetMasterAccountOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMasterAccountOutput) SetMaster

SetMaster sets the Master field's value.

func (GetMasterAccountOutput) String

func (s GetMasterAccountOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetMembersInput

type GetMembersInput struct {

	// The list of account IDs for the Security Hub member accounts to return the
	// details for.
	//
	// AccountIds is a required field
	AccountIds []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (GetMembersInput) GoString

func (s GetMembersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMembersInput) SetAccountIds

func (s *GetMembersInput) SetAccountIds(v []*string) *GetMembersInput

SetAccountIds sets the AccountIds field's value.

func (GetMembersInput) String

func (s GetMembersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMembersInput) Validate

func (s *GetMembersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetMembersOutput

type GetMembersOutput struct {

	// The list of details about the Security Hub member accounts.
	Members []*Member `type:"list"`

	// The list of Amazon Web Services accounts that could not be processed. For
	// each account, the list includes the account ID and the email address.
	UnprocessedAccounts []*Result `type:"list"`
	// contains filtered or unexported fields
}

func (GetMembersOutput) GoString

func (s GetMembersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMembersOutput) SetMembers

func (s *GetMembersOutput) SetMembers(v []*Member) *GetMembersOutput

SetMembers sets the Members field's value.

func (*GetMembersOutput) SetUnprocessedAccounts

func (s *GetMembersOutput) SetUnprocessedAccounts(v []*Result) *GetMembersOutput

SetUnprocessedAccounts sets the UnprocessedAccounts field's value.

func (GetMembersOutput) String

func (s GetMembersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IcmpTypeCode

type IcmpTypeCode struct {

	// The ICMP code for which to deny or allow access. To deny or allow all codes,
	// use the value -1.
	Code *int64 `type:"integer"`

	// The ICMP type for which to deny or allow access. To deny or allow all types,
	// use the value -1.
	Type *int64 `type:"integer"`
	// contains filtered or unexported fields
}

An Internet Control Message Protocol (ICMP) type and code.

func (IcmpTypeCode) GoString

func (s IcmpTypeCode) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IcmpTypeCode) SetCode

func (s *IcmpTypeCode) SetCode(v int64) *IcmpTypeCode

SetCode sets the Code field's value.

func (*IcmpTypeCode) SetType

func (s *IcmpTypeCode) SetType(v int64) *IcmpTypeCode

SetType sets the Type field's value.

func (IcmpTypeCode) String

func (s IcmpTypeCode) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ImportFindingsError

type ImportFindingsError struct {

	// The code of the error returned by the BatchImportFindings operation.
	//
	// ErrorCode is a required field
	ErrorCode *string `type:"string" required:"true"`

	// The message of the error returned by the BatchImportFindings operation.
	//
	// ErrorMessage is a required field
	ErrorMessage *string `type:"string" required:"true"`

	// The identifier of the finding that could not be updated.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The list of the findings that cannot be imported. For each finding, the list provides the error.

func (ImportFindingsError) GoString

func (s ImportFindingsError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportFindingsError) SetErrorCode

func (s *ImportFindingsError) SetErrorCode(v string) *ImportFindingsError

SetErrorCode sets the ErrorCode field's value.

func (*ImportFindingsError) SetErrorMessage

func (s *ImportFindingsError) SetErrorMessage(v string) *ImportFindingsError

SetErrorMessage sets the ErrorMessage field's value.

func (*ImportFindingsError) SetId

SetId sets the Id field's value.

func (ImportFindingsError) String

func (s ImportFindingsError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Insight

type Insight struct {

	// One or more attributes used to filter the findings included in the insight.
	// The insight only includes findings that match the criteria defined in the
	// filters.
	//
	// Filters is a required field
	Filters *AwsSecurityFindingFilters `type:"structure" required:"true"`

	// The grouping attribute for the insight's findings. Indicates how to group
	// the matching findings, and identifies the type of item that the insight applies
	// to. For example, if an insight is grouped by resource identifier, then the
	// insight produces a list of resource identifiers.
	//
	// GroupByAttribute is a required field
	GroupByAttribute *string `type:"string" required:"true"`

	// The ARN of a Security Hub insight.
	//
	// InsightArn is a required field
	InsightArn *string `type:"string" required:"true"`

	// The name of a Security Hub insight.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains information about a Security Hub insight.

func (Insight) GoString

func (s Insight) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Insight) SetFilters

func (s *Insight) SetFilters(v *AwsSecurityFindingFilters) *Insight

SetFilters sets the Filters field's value.

func (*Insight) SetGroupByAttribute

func (s *Insight) SetGroupByAttribute(v string) *Insight

SetGroupByAttribute sets the GroupByAttribute field's value.

func (*Insight) SetInsightArn

func (s *Insight) SetInsightArn(v string) *Insight

SetInsightArn sets the InsightArn field's value.

func (*Insight) SetName

func (s *Insight) SetName(v string) *Insight

SetName sets the Name field's value.

func (Insight) String

func (s Insight) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InsightResultValue

type InsightResultValue struct {

	// The number of findings returned for each GroupByAttributeValue.
	//
	// Count is a required field
	Count *int64 `type:"integer" required:"true"`

	// The value of the attribute that the findings are grouped by for the insight
	// whose results are returned by the GetInsightResults operation.
	//
	// GroupByAttributeValue is a required field
	GroupByAttributeValue *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The insight result values returned by the GetInsightResults operation.

func (InsightResultValue) GoString

func (s InsightResultValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InsightResultValue) SetCount

SetCount sets the Count field's value.

func (*InsightResultValue) SetGroupByAttributeValue

func (s *InsightResultValue) SetGroupByAttributeValue(v string) *InsightResultValue

SetGroupByAttributeValue sets the GroupByAttributeValue field's value.

func (InsightResultValue) String

func (s InsightResultValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InsightResults

type InsightResults struct {

	// The attribute that the findings are grouped by for the insight whose results
	// are returned by the GetInsightResults operation.
	//
	// GroupByAttribute is a required field
	GroupByAttribute *string `type:"string" required:"true"`

	// The ARN of the insight whose results are returned by the GetInsightResults
	// operation.
	//
	// InsightArn is a required field
	InsightArn *string `type:"string" required:"true"`

	// The list of insight result values returned by the GetInsightResults operation.
	//
	// ResultValues is a required field
	ResultValues []*InsightResultValue `type:"list" required:"true"`
	// contains filtered or unexported fields
}

The insight results returned by the GetInsightResults operation.

func (InsightResults) GoString

func (s InsightResults) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InsightResults) SetGroupByAttribute

func (s *InsightResults) SetGroupByAttribute(v string) *InsightResults

SetGroupByAttribute sets the GroupByAttribute field's value.

func (*InsightResults) SetInsightArn

func (s *InsightResults) SetInsightArn(v string) *InsightResults

SetInsightArn sets the InsightArn field's value.

func (*InsightResults) SetResultValues

func (s *InsightResults) SetResultValues(v []*InsightResultValue) *InsightResults

SetResultValues sets the ResultValues field's value.

func (InsightResults) String

func (s InsightResults) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalException

type InternalException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Internal server error.

func (*InternalException) Code

func (s *InternalException) Code() string

Code returns the exception type name.

func (*InternalException) Error

func (s *InternalException) Error() string

func (InternalException) GoString

func (s InternalException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalException) Message

func (s *InternalException) Message() string

Message returns the exception's message.

func (*InternalException) OrigErr

func (s *InternalException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalException) RequestID

func (s *InternalException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalException) StatusCode

func (s *InternalException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalException) String

func (s InternalException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidAccessException

type InvalidAccessException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The account doesn't have permission to perform this action.

func (*InvalidAccessException) Code

func (s *InvalidAccessException) Code() string

Code returns the exception type name.

func (*InvalidAccessException) Error

func (s *InvalidAccessException) Error() string

func (InvalidAccessException) GoString

func (s InvalidAccessException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidAccessException) Message

func (s *InvalidAccessException) Message() string

Message returns the exception's message.

func (*InvalidAccessException) OrigErr

func (s *InvalidAccessException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidAccessException) RequestID

func (s *InvalidAccessException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidAccessException) StatusCode

func (s *InvalidAccessException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidAccessException) String

func (s InvalidAccessException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidInputException

type InvalidInputException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

func (*InvalidInputException) Code

func (s *InvalidInputException) Code() string

Code returns the exception type name.

func (*InvalidInputException) Error

func (s *InvalidInputException) Error() string

func (InvalidInputException) GoString

func (s InvalidInputException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidInputException) Message

func (s *InvalidInputException) Message() string

Message returns the exception's message.

func (*InvalidInputException) OrigErr

func (s *InvalidInputException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidInputException) RequestID

func (s *InvalidInputException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidInputException) StatusCode

func (s *InvalidInputException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidInputException) String

func (s InvalidInputException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Invitation

type Invitation struct {

	// The account ID of the Security Hub administrator account that the invitation
	// was sent from.
	AccountId *string `type:"string"`

	// The ID of the invitation sent to the member account.
	InvitationId *string `type:"string"`

	// The timestamp of when the invitation was sent.
	InvitedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The current status of the association between the member and administrator
	// accounts.
	MemberStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Details about an invitation.

func (Invitation) GoString

func (s Invitation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Invitation) SetAccountId

func (s *Invitation) SetAccountId(v string) *Invitation

SetAccountId sets the AccountId field's value.

func (*Invitation) SetInvitationId

func (s *Invitation) SetInvitationId(v string) *Invitation

SetInvitationId sets the InvitationId field's value.

func (*Invitation) SetInvitedAt

func (s *Invitation) SetInvitedAt(v time.Time) *Invitation

SetInvitedAt sets the InvitedAt field's value.

func (*Invitation) SetMemberStatus

func (s *Invitation) SetMemberStatus(v string) *Invitation

SetMemberStatus sets the MemberStatus field's value.

func (Invitation) String

func (s Invitation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InviteMembersInput

type InviteMembersInput struct {

	// The list of account IDs of the Amazon Web Services accounts to invite to
	// Security Hub as members.
	//
	// AccountIds is a required field
	AccountIds []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (InviteMembersInput) GoString

func (s InviteMembersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InviteMembersInput) SetAccountIds

func (s *InviteMembersInput) SetAccountIds(v []*string) *InviteMembersInput

SetAccountIds sets the AccountIds field's value.

func (InviteMembersInput) String

func (s InviteMembersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InviteMembersInput) Validate

func (s *InviteMembersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InviteMembersOutput

type InviteMembersOutput struct {

	// The list of Amazon Web Services accounts that could not be processed. For
	// each account, the list includes the account ID and the email address.
	UnprocessedAccounts []*Result `type:"list"`
	// contains filtered or unexported fields
}

func (InviteMembersOutput) GoString

func (s InviteMembersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InviteMembersOutput) SetUnprocessedAccounts

func (s *InviteMembersOutput) SetUnprocessedAccounts(v []*Result) *InviteMembersOutput

SetUnprocessedAccounts sets the UnprocessedAccounts field's value.

func (InviteMembersOutput) String

func (s InviteMembersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IpFilter

type IpFilter struct {

	// A finding's CIDR value.
	Cidr *string `type:"string"`
	// contains filtered or unexported fields
}

The IP filter for querying findings.

func (IpFilter) GoString

func (s IpFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IpFilter) SetCidr

func (s *IpFilter) SetCidr(v string) *IpFilter

SetCidr sets the Cidr field's value.

func (IpFilter) String

func (s IpFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IpOrganizationDetails

type IpOrganizationDetails struct {

	// The Autonomous System Number (ASN) of the internet provider
	Asn *int64 `type:"integer"`

	// The name of the organization that registered the ASN.
	AsnOrg *string `type:"string"`

	// The ISP information for the internet provider.
	Isp *string `type:"string"`

	// The name of the internet provider.
	Org *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about an internet provider.

func (IpOrganizationDetails) GoString

func (s IpOrganizationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IpOrganizationDetails) SetAsn

SetAsn sets the Asn field's value.

func (*IpOrganizationDetails) SetAsnOrg

SetAsnOrg sets the AsnOrg field's value.

func (*IpOrganizationDetails) SetIsp

SetIsp sets the Isp field's value.

func (*IpOrganizationDetails) SetOrg

SetOrg sets the Org field's value.

func (IpOrganizationDetails) String

func (s IpOrganizationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Ipv6CidrBlockAssociation

type Ipv6CidrBlockAssociation struct {

	// The association ID for the IPv6 CIDR block.
	AssociationId *string `type:"string"`

	// Information about the state of the CIDR block. Valid values are as follows:
	//
	//    * associating
	//
	//    * associated
	//
	//    * disassociating
	//
	//    * disassociated
	//
	//    * failed
	//
	//    * failing
	CidrBlockState *string `type:"string"`

	// The IPv6 CIDR block.
	Ipv6CidrBlock *string `type:"string"`
	// contains filtered or unexported fields
}

An IPV6 CIDR block association.

func (Ipv6CidrBlockAssociation) GoString

func (s Ipv6CidrBlockAssociation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Ipv6CidrBlockAssociation) SetAssociationId

SetAssociationId sets the AssociationId field's value.

func (*Ipv6CidrBlockAssociation) SetCidrBlockState

func (s *Ipv6CidrBlockAssociation) SetCidrBlockState(v string) *Ipv6CidrBlockAssociation

SetCidrBlockState sets the CidrBlockState field's value.

func (*Ipv6CidrBlockAssociation) SetIpv6CidrBlock

SetIpv6CidrBlock sets the Ipv6CidrBlock field's value.

func (Ipv6CidrBlockAssociation) String

func (s Ipv6CidrBlockAssociation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KeywordFilter

type KeywordFilter struct {

	// A value for the keyword.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A keyword filter for querying findings.

func (KeywordFilter) GoString

func (s KeywordFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KeywordFilter) SetValue

func (s *KeywordFilter) SetValue(v string) *KeywordFilter

SetValue sets the Value field's value.

func (KeywordFilter) String

func (s KeywordFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LimitExceededException

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

func (*LimitExceededException) Code

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAutomationRulesInput added in v1.42.9

type ListAutomationRulesInput struct {

	// The maximum number of rules to return in the response. This currently ranges
	// from 1 to 100.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// A token to specify where to start paginating the response. This is the NextToken
	// from a previously truncated response. On your first call to the ListAutomationRules
	// API, set the value of this parameter to NULL.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListAutomationRulesInput) GoString added in v1.42.9

func (s ListAutomationRulesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAutomationRulesInput) SetMaxResults added in v1.42.9

SetMaxResults sets the MaxResults field's value.

func (*ListAutomationRulesInput) SetNextToken added in v1.42.9

SetNextToken sets the NextToken field's value.

func (ListAutomationRulesInput) String added in v1.42.9

func (s ListAutomationRulesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAutomationRulesInput) Validate added in v1.42.9

func (s *ListAutomationRulesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAutomationRulesOutput added in v1.42.9

type ListAutomationRulesOutput struct {

	// Metadata for rules in the calling account. The response includes rules with
	// a RuleStatus of ENABLED and DISABLED.
	AutomationRulesMetadata []*AutomationRulesMetadata `type:"list"`

	// A pagination token for the response.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListAutomationRulesOutput) GoString added in v1.42.9

func (s ListAutomationRulesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAutomationRulesOutput) SetAutomationRulesMetadata added in v1.42.9

SetAutomationRulesMetadata sets the AutomationRulesMetadata field's value.

func (*ListAutomationRulesOutput) SetNextToken added in v1.42.9

SetNextToken sets the NextToken field's value.

func (ListAutomationRulesOutput) String added in v1.42.9

func (s ListAutomationRulesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListEnabledProductsForImportInput

type ListEnabledProductsForImportInput struct {

	// The maximum number of items to return in the response.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The token that is required for pagination. On your first call to the ListEnabledProductsForImport
	// operation, set the value of this parameter to NULL.
	//
	// For subsequent calls to the operation, to continue listing data, set the
	// value of this parameter to the value returned from the previous response.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListEnabledProductsForImportInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEnabledProductsForImportInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListEnabledProductsForImportInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListEnabledProductsForImportInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEnabledProductsForImportInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type ListEnabledProductsForImportOutput

type ListEnabledProductsForImportOutput struct {

	// The pagination token to use to request the next page of results.
	NextToken *string `type:"string"`

	// The list of ARNs for the resources that represent your subscriptions to products.
	ProductSubscriptions []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ListEnabledProductsForImportOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEnabledProductsForImportOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListEnabledProductsForImportOutput) SetProductSubscriptions

SetProductSubscriptions sets the ProductSubscriptions field's value.

func (ListEnabledProductsForImportOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListFindingAggregatorsInput

type ListFindingAggregatorsInput struct {

	// The maximum number of results to return. This operation currently only returns
	// a single result.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The token returned with the previous set of results. Identifies the next
	// set of results to return.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListFindingAggregatorsInput) GoString

func (s ListFindingAggregatorsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFindingAggregatorsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListFindingAggregatorsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListFindingAggregatorsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFindingAggregatorsInput) Validate

func (s *ListFindingAggregatorsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFindingAggregatorsOutput

type ListFindingAggregatorsOutput struct {

	// The list of finding aggregators. This operation currently only returns a
	// single result.
	FindingAggregators []*FindingAggregator `type:"list"`

	// If there are more results, this is the token to provide in the next call
	// to ListFindingAggregators.
	//
	// This operation currently only returns a single result.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListFindingAggregatorsOutput) GoString

func (s ListFindingAggregatorsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFindingAggregatorsOutput) SetFindingAggregators

SetFindingAggregators sets the FindingAggregators field's value.

func (*ListFindingAggregatorsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListFindingAggregatorsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListInvitationsInput

type ListInvitationsInput struct {

	// The maximum number of items to return in the response.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The token that is required for pagination. On your first call to the ListInvitations
	// operation, set the value of this parameter to NULL.
	//
	// For subsequent calls to the operation, to continue listing data, set the
	// value of this parameter to the value returned from the previous response.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListInvitationsInput) GoString

func (s ListInvitationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListInvitationsInput) SetMaxResults

func (s *ListInvitationsInput) SetMaxResults(v int64) *ListInvitationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListInvitationsInput) SetNextToken

func (s *ListInvitationsInput) SetNextToken(v string) *ListInvitationsInput

SetNextToken sets the NextToken field's value.

func (ListInvitationsInput) String

func (s ListInvitationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListInvitationsInput) Validate

func (s *ListInvitationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListInvitationsOutput

type ListInvitationsOutput struct {

	// The details of the invitations returned by the operation.
	Invitations []*Invitation `type:"list"`

	// The pagination token to use to request the next page of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListInvitationsOutput) GoString

func (s ListInvitationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListInvitationsOutput) SetInvitations

func (s *ListInvitationsOutput) SetInvitations(v []*Invitation) *ListInvitationsOutput

SetInvitations sets the Invitations field's value.

func (*ListInvitationsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListInvitationsOutput) String

func (s ListInvitationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListMembersInput

type ListMembersInput struct {

	// The maximum number of items to return in the response.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The token that is required for pagination. On your first call to the ListMembers
	// operation, set the value of this parameter to NULL.
	//
	// For subsequent calls to the operation, to continue listing data, set the
	// value of this parameter to the value returned from the previous response.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

	// Specifies which member accounts to include in the response based on their
	// relationship status with the administrator account. The default value is
	// TRUE.
	//
	// If OnlyAssociated is set to TRUE, the response includes member accounts whose
	// relationship status with the administrator account is set to ENABLED.
	//
	// If OnlyAssociated is set to FALSE, the response includes all existing member
	// accounts.
	OnlyAssociated *bool `location:"querystring" locationName:"OnlyAssociated" type:"boolean"`
	// contains filtered or unexported fields
}

func (ListMembersInput) GoString

func (s ListMembersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMembersInput) SetMaxResults

func (s *ListMembersInput) SetMaxResults(v int64) *ListMembersInput

SetMaxResults sets the MaxResults field's value.

func (*ListMembersInput) SetNextToken

func (s *ListMembersInput) SetNextToken(v string) *ListMembersInput

SetNextToken sets the NextToken field's value.

func (*ListMembersInput) SetOnlyAssociated

func (s *ListMembersInput) SetOnlyAssociated(v bool) *ListMembersInput

SetOnlyAssociated sets the OnlyAssociated field's value.

func (ListMembersInput) String

func (s ListMembersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMembersInput) Validate

func (s *ListMembersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListMembersOutput

type ListMembersOutput struct {

	// Member details returned by the operation.
	Members []*Member `type:"list"`

	// The pagination token to use to request the next page of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListMembersOutput) GoString

func (s ListMembersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMembersOutput) SetMembers

func (s *ListMembersOutput) SetMembers(v []*Member) *ListMembersOutput

SetMembers sets the Members field's value.

func (*ListMembersOutput) SetNextToken

func (s *ListMembersOutput) SetNextToken(v string) *ListMembersOutput

SetNextToken sets the NextToken field's value.

func (ListMembersOutput) String

func (s ListMembersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListOrganizationAdminAccountsInput

type ListOrganizationAdminAccountsInput struct {

	// The maximum number of items to return in the response.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The token that is required for pagination. On your first call to the ListOrganizationAdminAccounts
	// operation, set the value of this parameter to NULL. For subsequent calls
	// to the operation, to continue listing data, set the value of this parameter
	// to the value returned from the previous response.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListOrganizationAdminAccountsInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListOrganizationAdminAccountsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListOrganizationAdminAccountsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListOrganizationAdminAccountsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListOrganizationAdminAccountsInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type ListOrganizationAdminAccountsOutput

type ListOrganizationAdminAccountsOutput struct {

	// The list of Security Hub administrator accounts.
	AdminAccounts []*AdminAccount `type:"list"`

	// The pagination token to use to request the next page of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListOrganizationAdminAccountsOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListOrganizationAdminAccountsOutput) SetAdminAccounts

SetAdminAccounts sets the AdminAccounts field's value.

func (*ListOrganizationAdminAccountsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListOrganizationAdminAccountsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListSecurityControlDefinitionsInput added in v1.42.9

type ListSecurityControlDefinitionsInput struct {

	// An optional parameter that limits the total results of the API response to
	// the specified number. If this parameter isn't provided in the request, the
	// results include the first 25 security controls that apply to the specified
	// standard. The results also include a NextToken parameter that you can use
	// in a subsequent API call to get the next 25 controls. This repeats until
	// all controls for the standard are returned.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// Optional pagination parameter.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

	// The Amazon Resource Name (ARN) of the standard that you want to view controls
	// for.
	StandardsArn *string `location:"querystring" locationName:"StandardsArn" type:"string"`
	// contains filtered or unexported fields
}

func (ListSecurityControlDefinitionsInput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSecurityControlDefinitionsInput) SetMaxResults added in v1.42.9

SetMaxResults sets the MaxResults field's value.

func (*ListSecurityControlDefinitionsInput) SetNextToken added in v1.42.9

SetNextToken sets the NextToken field's value.

func (*ListSecurityControlDefinitionsInput) SetStandardsArn added in v1.42.9

SetStandardsArn sets the StandardsArn field's value.

func (ListSecurityControlDefinitionsInput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSecurityControlDefinitionsInput) Validate added in v1.42.9

Validate inspects the fields of the type to determine if they are valid.

type ListSecurityControlDefinitionsOutput added in v1.42.9

type ListSecurityControlDefinitionsOutput struct {

	// A pagination parameter that's included in the response only if it was included
	// in the request.
	NextToken *string `type:"string"`

	// An array of controls that apply to the specified standard.
	//
	// SecurityControlDefinitions is a required field
	SecurityControlDefinitions []*SecurityControlDefinition `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListSecurityControlDefinitionsOutput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSecurityControlDefinitionsOutput) SetNextToken added in v1.42.9

SetNextToken sets the NextToken field's value.

func (*ListSecurityControlDefinitionsOutput) SetSecurityControlDefinitions added in v1.42.9

SetSecurityControlDefinitions sets the SecurityControlDefinitions field's value.

func (ListSecurityControlDefinitionsOutput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListStandardsControlAssociationsInput added in v1.42.9

type ListStandardsControlAssociationsInput struct {

	// An optional parameter that limits the total results of the API response to
	// the specified number. If this parameter isn't provided in the request, the
	// results include the first 25 standard and control associations. The results
	// also include a NextToken parameter that you can use in a subsequent API call
	// to get the next 25 associations. This repeats until all associations for
	// the specified control are returned. The number of results is limited by the
	// number of supported Security Hub standards that you've enabled in the calling
	// account.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// Optional pagination parameter.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

	// The identifier of the control (identified with SecurityControlId, SecurityControlArn,
	// or a mix of both parameters) that you want to determine the enablement status
	// of in each enabled standard.
	//
	// SecurityControlId is a required field
	SecurityControlId *string `location:"querystring" locationName:"SecurityControlId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListStandardsControlAssociationsInput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStandardsControlAssociationsInput) SetMaxResults added in v1.42.9

SetMaxResults sets the MaxResults field's value.

func (*ListStandardsControlAssociationsInput) SetNextToken added in v1.42.9

SetNextToken sets the NextToken field's value.

func (*ListStandardsControlAssociationsInput) SetSecurityControlId added in v1.42.9

SetSecurityControlId sets the SecurityControlId field's value.

func (ListStandardsControlAssociationsInput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStandardsControlAssociationsInput) Validate added in v1.42.9

Validate inspects the fields of the type to determine if they are valid.

type ListStandardsControlAssociationsOutput added in v1.42.9

type ListStandardsControlAssociationsOutput struct {

	// A pagination parameter that's included in the response only if it was included
	// in the request.
	NextToken *string `type:"string"`

	// An array that provides the enablement status and other details for each security
	// control that applies to each enabled standard.
	//
	// StandardsControlAssociationSummaries is a required field
	StandardsControlAssociationSummaries []*StandardsControlAssociationSummary `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListStandardsControlAssociationsOutput) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStandardsControlAssociationsOutput) SetNextToken added in v1.42.9

SetNextToken sets the NextToken field's value.

func (*ListStandardsControlAssociationsOutput) SetStandardsControlAssociationSummaries added in v1.42.9

SetStandardsControlAssociationSummaries sets the StandardsControlAssociationSummaries field's value.

func (ListStandardsControlAssociationsOutput) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The ARN of the resource to retrieve tags for.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The tags associated with a resource.
	Tags map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LoadBalancerState

type LoadBalancerState struct {

	// The state code. The initial state of the load balancer is provisioning.
	//
	// After the load balancer is fully set up and ready to route traffic, its state
	// is active.
	//
	// If the load balancer could not be set up, its state is failed.
	Code *string `type:"string"`

	// A description of the state.
	Reason *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the state of the load balancer.

func (LoadBalancerState) GoString

func (s LoadBalancerState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoadBalancerState) SetCode

SetCode sets the Code field's value.

func (*LoadBalancerState) SetReason

func (s *LoadBalancerState) SetReason(v string) *LoadBalancerState

SetReason sets the Reason field's value.

func (LoadBalancerState) String

func (s LoadBalancerState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Malware

type Malware struct {

	// The name of the malware that was observed.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The file system path of the malware that was observed.
	Path *string `type:"string"`

	// The state of the malware that was observed.
	State *string `type:"string" enum:"MalwareState"`

	// The type of the malware that was observed.
	Type *string `type:"string" enum:"MalwareType"`
	// contains filtered or unexported fields
}

A list of malware related to a finding.

func (Malware) GoString

func (s Malware) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Malware) SetName

func (s *Malware) SetName(v string) *Malware

SetName sets the Name field's value.

func (*Malware) SetPath

func (s *Malware) SetPath(v string) *Malware

SetPath sets the Path field's value.

func (*Malware) SetState

func (s *Malware) SetState(v string) *Malware

SetState sets the State field's value.

func (*Malware) SetType

func (s *Malware) SetType(v string) *Malware

SetType sets the Type field's value.

func (Malware) String

func (s Malware) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Malware) Validate

func (s *Malware) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MapFilter

type MapFilter struct {

	// The condition to apply to the key value when filtering Security Hub findings
	// with a map filter.
	//
	// To search for values that have the filter value, use one of the following
	// comparison operators:
	//
	//    * To search for values that include the filter value, use CONTAINS. For
	//    example, for the ResourceTags field, the filter Department CONTAINS Security
	//    matches findings that include the value Security for the Department tag.
	//    In the same example, a finding with a value of Security team for the Department
	//    tag is a match.
	//
	//    * To search for values that exactly match the filter value, use EQUALS.
	//    For example, for the ResourceTags field, the filter Department EQUALS
	//    Security matches findings that have the value Security for the Department
	//    tag.
	//
	// CONTAINS and EQUALS filters on the same field are joined by OR. A finding
	// matches if it matches any one of those filters. For example, the filters
	// Department CONTAINS Security OR Department CONTAINS Finance match a finding
	// that includes either Security, Finance, or both values.
	//
	// To search for values that don't have the filter value, use one of the following
	// comparison operators:
	//
	//    * To search for values that exclude the filter value, use NOT_CONTAINS.
	//    For example, for the ResourceTags field, the filter Department NOT_CONTAINS
	//    Finance matches findings that exclude the value Finance for the Department
	//    tag.
	//
	//    * To search for values other than the filter value, use NOT_EQUALS. For
	//    example, for the ResourceTags field, the filter Department NOT_EQUALS
	//    Finance matches findings that don’t have the value Finance for the Department
	//    tag.
	//
	// NOT_CONTAINS and NOT_EQUALS filters on the same field are joined by AND.
	// A finding matches only if it matches all of those filters. For example, the
	// filters Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance
	// match a finding that excludes both the Security and Finance values.
	//
	// CONTAINS filters can only be used with other CONTAINS filters. NOT_CONTAINS
	// filters can only be used with other NOT_CONTAINS filters.
	//
	// You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the
	// same field. Similarly, you can’t have both an EQUALS filter and a NOT_EQUALS
	// filter on the same field. Combining filters in this way returns an error.
	//
	// CONTAINS and NOT_CONTAINS operators can be used only with automation rules.
	// For more information, see Automation rules (https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html)
	// in the Security Hub User Guide.
	Comparison *string `type:"string" enum:"MapFilterComparison"`

	// The key of the map filter. For example, for ResourceTags, Key identifies
	// the name of the tag. For UserDefinedFields, Key is the name of the field.
	Key *string `type:"string"`

	// The value for the key in the map filter. Filter values are case sensitive.
	// For example, one of the values for a tag called Department might be Security.
	// If you provide security as the filter value, then there's no match.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A map filter for filtering Security Hub findings. Each map filter provides the field to check for, the value to check for, and the comparison operator.

func (MapFilter) GoString

func (s MapFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MapFilter) SetComparison

func (s *MapFilter) SetComparison(v string) *MapFilter

SetComparison sets the Comparison field's value.

func (*MapFilter) SetKey

func (s *MapFilter) SetKey(v string) *MapFilter

SetKey sets the Key field's value.

func (*MapFilter) SetValue

func (s *MapFilter) SetValue(v string) *MapFilter

SetValue sets the Value field's value.

func (MapFilter) String

func (s MapFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Member

type Member struct {

	// The Amazon Web Services account ID of the member account.
	AccountId *string `type:"string"`

	// The Amazon Web Services account ID of the Security Hub administrator account
	// associated with this member account.
	AdministratorId *string `type:"string"`

	// The email address of the member account.
	Email *string `type:"string"`

	// A timestamp for the date and time when the invitation was sent to the member
	// account.
	InvitedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// This is replaced by AdministratorID.
	//
	// The Amazon Web Services account ID of the Security Hub administrator account
	// associated with this member account.
	//
	// Deprecated: This field is deprecated, use AdministratorId instead.
	MasterId *string `deprecated:"true" type:"string"`

	// The status of the relationship between the member account and its administrator
	// account.
	//
	// The status can have one of the following values:
	//
	//    * Created - Indicates that the administrator account added the member
	//    account, but has not yet invited the member account.
	//
	//    * Invited - Indicates that the administrator account invited the member
	//    account. The member account has not yet responded to the invitation.
	//
	//    * Enabled - Indicates that the member account is currently active. For
	//    manually invited member accounts, indicates that the member account accepted
	//    the invitation.
	//
	//    * Removed - Indicates that the administrator account disassociated the
	//    member account.
	//
	//    * Resigned - Indicates that the member account disassociated themselves
	//    from the administrator account.
	//
	//    * Deleted - Indicates that the administrator account deleted the member
	//    account.
	//
	//    * AccountSuspended - Indicates that an organization account was suspended
	//    from Amazon Web Services at the same time that the administrator account
	//    tried to enable the organization account as a member account.
	MemberStatus *string `type:"string"`

	// The timestamp for the date and time when the member account was updated.
	UpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

The details about a member account.

func (Member) GoString

func (s Member) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Member) SetAccountId

func (s *Member) SetAccountId(v string) *Member

SetAccountId sets the AccountId field's value.

func (*Member) SetAdministratorId

func (s *Member) SetAdministratorId(v string) *Member

SetAdministratorId sets the AdministratorId field's value.

func (*Member) SetEmail

func (s *Member) SetEmail(v string) *Member

SetEmail sets the Email field's value.

func (*Member) SetInvitedAt

func (s *Member) SetInvitedAt(v time.Time) *Member

SetInvitedAt sets the InvitedAt field's value.

func (*Member) SetMasterId

func (s *Member) SetMasterId(v string) *Member

SetMasterId sets the MasterId field's value.

func (*Member) SetMemberStatus

func (s *Member) SetMemberStatus(v string) *Member

SetMemberStatus sets the MemberStatus field's value.

func (*Member) SetUpdatedAt

func (s *Member) SetUpdatedAt(v time.Time) *Member

SetUpdatedAt sets the UpdatedAt field's value.

func (Member) String

func (s Member) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Network

type Network struct {

	// The destination domain of network-related information about a finding.
	DestinationDomain *string `type:"string"`

	// The destination IPv4 address of network-related information about a finding.
	DestinationIpV4 *string `type:"string"`

	// The destination IPv6 address of network-related information about a finding.
	DestinationIpV6 *string `type:"string"`

	// The destination port of network-related information about a finding.
	DestinationPort *int64 `type:"integer"`

	// The direction of network traffic associated with a finding.
	Direction *string `type:"string" enum:"NetworkDirection"`

	// The range of open ports that is present on the network.
	OpenPortRange *PortRange `type:"structure"`

	// The protocol of network-related information about a finding.
	Protocol *string `type:"string"`

	// The source domain of network-related information about a finding.
	SourceDomain *string `type:"string"`

	// The source IPv4 address of network-related information about a finding.
	SourceIpV4 *string `type:"string"`

	// The source IPv6 address of network-related information about a finding.
	SourceIpV6 *string `type:"string"`

	// The source media access control (MAC) address of network-related information
	// about a finding.
	SourceMac *string `type:"string"`

	// The source port of network-related information about a finding.
	SourcePort *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The details of network-related information about a finding.

func (Network) GoString

func (s Network) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Network) SetDestinationDomain

func (s *Network) SetDestinationDomain(v string) *Network

SetDestinationDomain sets the DestinationDomain field's value.

func (*Network) SetDestinationIpV4

func (s *Network) SetDestinationIpV4(v string) *Network

SetDestinationIpV4 sets the DestinationIpV4 field's value.

func (*Network) SetDestinationIpV6

func (s *Network) SetDestinationIpV6(v string) *Network

SetDestinationIpV6 sets the DestinationIpV6 field's value.

func (*Network) SetDestinationPort

func (s *Network) SetDestinationPort(v int64) *Network

SetDestinationPort sets the DestinationPort field's value.

func (*Network) SetDirection

func (s *Network) SetDirection(v string) *Network

SetDirection sets the Direction field's value.

func (*Network) SetOpenPortRange

func (s *Network) SetOpenPortRange(v *PortRange) *Network

SetOpenPortRange sets the OpenPortRange field's value.

func (*Network) SetProtocol

func (s *Network) SetProtocol(v string) *Network

SetProtocol sets the Protocol field's value.

func (*Network) SetSourceDomain

func (s *Network) SetSourceDomain(v string) *Network

SetSourceDomain sets the SourceDomain field's value.

func (*Network) SetSourceIpV4

func (s *Network) SetSourceIpV4(v string) *Network

SetSourceIpV4 sets the SourceIpV4 field's value.

func (*Network) SetSourceIpV6

func (s *Network) SetSourceIpV6(v string) *Network

SetSourceIpV6 sets the SourceIpV6 field's value.

func (*Network) SetSourceMac

func (s *Network) SetSourceMac(v string) *Network

SetSourceMac sets the SourceMac field's value.

func (*Network) SetSourcePort

func (s *Network) SetSourcePort(v int64) *Network

SetSourcePort sets the SourcePort field's value.

func (Network) String

func (s Network) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NetworkConnectionAction

type NetworkConnectionAction struct {

	// Indicates whether the network connection attempt was blocked.
	Blocked *bool `type:"boolean"`

	// The direction of the network connection request (IN or OUT).
	ConnectionDirection *string `type:"string"`

	// Information about the port on the EC2 instance.
	LocalPortDetails *ActionLocalPortDetails `type:"structure"`

	// The protocol used to make the network connection request.
	Protocol *string `type:"string"`

	// Information about the remote IP address that issued the network connection
	// request.
	RemoteIpDetails *ActionRemoteIpDetails `type:"structure"`

	// Information about the port on the remote IP address.
	RemotePortDetails *ActionRemotePortDetails `type:"structure"`
	// contains filtered or unexported fields
}

Provided if ActionType is NETWORK_CONNECTION. It provides details about the attempted network connection that was detected.

func (NetworkConnectionAction) GoString

func (s NetworkConnectionAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NetworkConnectionAction) SetBlocked

SetBlocked sets the Blocked field's value.

func (*NetworkConnectionAction) SetConnectionDirection

func (s *NetworkConnectionAction) SetConnectionDirection(v string) *NetworkConnectionAction

SetConnectionDirection sets the ConnectionDirection field's value.

func (*NetworkConnectionAction) SetLocalPortDetails

SetLocalPortDetails sets the LocalPortDetails field's value.

func (*NetworkConnectionAction) SetProtocol

SetProtocol sets the Protocol field's value.

func (*NetworkConnectionAction) SetRemoteIpDetails

SetRemoteIpDetails sets the RemoteIpDetails field's value.

func (*NetworkConnectionAction) SetRemotePortDetails

SetRemotePortDetails sets the RemotePortDetails field's value.

func (NetworkConnectionAction) String

func (s NetworkConnectionAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NetworkHeader

type NetworkHeader struct {

	// Information about the destination of the component.
	Destination *NetworkPathComponentDetails `type:"structure"`

	// The protocol used for the component.
	Protocol *string `type:"string"`

	// Information about the origin of the component.
	Source *NetworkPathComponentDetails `type:"structure"`
	// contains filtered or unexported fields
}

Details about a network path component that occurs before or after the current component.

func (NetworkHeader) GoString

func (s NetworkHeader) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NetworkHeader) SetDestination

SetDestination sets the Destination field's value.

func (*NetworkHeader) SetProtocol

func (s *NetworkHeader) SetProtocol(v string) *NetworkHeader

SetProtocol sets the Protocol field's value.

func (*NetworkHeader) SetSource

SetSource sets the Source field's value.

func (NetworkHeader) String

func (s NetworkHeader) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NetworkPathComponent

type NetworkPathComponent struct {

	// The identifier of a component in the network path.
	ComponentId *string `type:"string"`

	// The type of component.
	ComponentType *string `type:"string"`

	// Information about the component that comes after the current component in
	// the network path.
	Egress *NetworkHeader `type:"structure"`

	// Information about the component that comes before the current node in the
	// network path.
	Ingress *NetworkHeader `type:"structure"`
	// contains filtered or unexported fields
}

Information about a network path component.

func (NetworkPathComponent) GoString

func (s NetworkPathComponent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NetworkPathComponent) SetComponentId

func (s *NetworkPathComponent) SetComponentId(v string) *NetworkPathComponent

SetComponentId sets the ComponentId field's value.

func (*NetworkPathComponent) SetComponentType

func (s *NetworkPathComponent) SetComponentType(v string) *NetworkPathComponent

SetComponentType sets the ComponentType field's value.

func (*NetworkPathComponent) SetEgress

SetEgress sets the Egress field's value.

func (*NetworkPathComponent) SetIngress

SetIngress sets the Ingress field's value.

func (NetworkPathComponent) String

func (s NetworkPathComponent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NetworkPathComponentDetails

type NetworkPathComponentDetails struct {

	// The IP addresses of the destination.
	Address []*string `type:"list"`

	// A list of port ranges for the destination.
	PortRanges []*PortRange `type:"list"`
	// contains filtered or unexported fields
}

Information about the destination of the next component in the network path.

func (NetworkPathComponentDetails) GoString

func (s NetworkPathComponentDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NetworkPathComponentDetails) SetAddress

SetAddress sets the Address field's value.

func (*NetworkPathComponentDetails) SetPortRanges

SetPortRanges sets the PortRanges field's value.

func (NetworkPathComponentDetails) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Note

type Note struct {

	// The text of a note.
	//
	// Text is a required field
	Text *string `type:"string" required:"true"`

	// The timestamp of when the note was updated.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	//
	// UpdatedAt is a required field
	UpdatedAt *string `type:"string" required:"true"`

	// The principal that created a note.
	//
	// UpdatedBy is a required field
	UpdatedBy *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A user-defined note added to a finding.

func (Note) GoString

func (s Note) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Note) SetText

func (s *Note) SetText(v string) *Note

SetText sets the Text field's value.

func (*Note) SetUpdatedAt

func (s *Note) SetUpdatedAt(v string) *Note

SetUpdatedAt sets the UpdatedAt field's value.

func (*Note) SetUpdatedBy

func (s *Note) SetUpdatedBy(v string) *Note

SetUpdatedBy sets the UpdatedBy field's value.

func (Note) String

func (s Note) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Note) Validate

func (s *Note) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type NoteUpdate

type NoteUpdate struct {

	// The updated note text.
	//
	// Text is a required field
	Text *string `type:"string" required:"true"`

	// The principal that updated the note.
	//
	// UpdatedBy is a required field
	UpdatedBy *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The updated note.

func (NoteUpdate) GoString

func (s NoteUpdate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NoteUpdate) SetText

func (s *NoteUpdate) SetText(v string) *NoteUpdate

SetText sets the Text field's value.

func (*NoteUpdate) SetUpdatedBy

func (s *NoteUpdate) SetUpdatedBy(v string) *NoteUpdate

SetUpdatedBy sets the UpdatedBy field's value.

func (NoteUpdate) String

func (s NoteUpdate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NoteUpdate) Validate

func (s *NoteUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type NumberFilter

type NumberFilter struct {

	// The equal-to condition to be applied to a single field when querying for
	// findings.
	Eq *float64 `type:"double"`

	// The greater-than-equal condition to be applied to a single field when querying
	// for findings.
	Gte *float64 `type:"double"`

	// The less-than-equal condition to be applied to a single field when querying
	// for findings.
	Lte *float64 `type:"double"`
	// contains filtered or unexported fields
}

A number filter for querying findings.

func (NumberFilter) GoString

func (s NumberFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NumberFilter) SetEq

func (s *NumberFilter) SetEq(v float64) *NumberFilter

SetEq sets the Eq field's value.

func (*NumberFilter) SetGte

func (s *NumberFilter) SetGte(v float64) *NumberFilter

SetGte sets the Gte field's value.

func (*NumberFilter) SetLte

func (s *NumberFilter) SetLte(v float64) *NumberFilter

SetLte sets the Lte field's value.

func (NumberFilter) String

func (s NumberFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Occurrences

type Occurrences struct {

	// Occurrences of sensitive data detected in Microsoft Excel workbooks, comma-separated
	// value (CSV) files, or tab-separated value (TSV) files.
	Cells []*Cell `type:"list"`

	// Occurrences of sensitive data detected in a non-binary text file or a Microsoft
	// Word file. Non-binary text files include files such as HTML, XML, JSON, and
	// TXT files.
	LineRanges []*Range `type:"list"`

	// Occurrences of sensitive data detected in a binary text file.
	OffsetRanges []*Range `type:"list"`

	// Occurrences of sensitive data in an Adobe Portable Document Format (PDF)
	// file.
	Pages []*Page `type:"list"`

	// Occurrences of sensitive data in an Apache Avro object container or an Apache
	// Parquet file.
	Records []*Record `type:"list"`
	// contains filtered or unexported fields
}

The detected occurrences of sensitive data.

func (Occurrences) GoString

func (s Occurrences) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Occurrences) SetCells

func (s *Occurrences) SetCells(v []*Cell) *Occurrences

SetCells sets the Cells field's value.

func (*Occurrences) SetLineRanges

func (s *Occurrences) SetLineRanges(v []*Range) *Occurrences

SetLineRanges sets the LineRanges field's value.

func (*Occurrences) SetOffsetRanges

func (s *Occurrences) SetOffsetRanges(v []*Range) *Occurrences

SetOffsetRanges sets the OffsetRanges field's value.

func (*Occurrences) SetPages

func (s *Occurrences) SetPages(v []*Page) *Occurrences

SetPages sets the Pages field's value.

func (*Occurrences) SetRecords

func (s *Occurrences) SetRecords(v []*Record) *Occurrences

SetRecords sets the Records field's value.

func (Occurrences) String

func (s Occurrences) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Page

type Page struct {

	// An occurrence of sensitive data detected in a non-binary text file or a Microsoft
	// Word file. Non-binary text files include files such as HTML, XML, JSON, and
	// TXT files.
	LineRange *Range `type:"structure"`

	// An occurrence of sensitive data detected in a binary text file.
	OffsetRange *Range `type:"structure"`

	// The page number of the page that contains the sensitive data.
	PageNumber *int64 `type:"long"`
	// contains filtered or unexported fields
}

An occurrence of sensitive data in an Adobe Portable Document Format (PDF) file.

func (Page) GoString

func (s Page) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Page) SetLineRange

func (s *Page) SetLineRange(v *Range) *Page

SetLineRange sets the LineRange field's value.

func (*Page) SetOffsetRange

func (s *Page) SetOffsetRange(v *Range) *Page

SetOffsetRange sets the OffsetRange field's value.

func (*Page) SetPageNumber

func (s *Page) SetPageNumber(v int64) *Page

SetPageNumber sets the PageNumber field's value.

func (Page) String

func (s Page) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PatchSummary

type PatchSummary struct {

	// The number of patches from the compliance standard that failed to install.
	FailedCount *int64 `type:"integer"`

	// The identifier of the compliance standard that was used to determine the
	// patch compliance status.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The number of patches from the compliance standard that were installed successfully.
	InstalledCount *int64 `type:"integer"`

	// The number of installed patches that are not part of the compliance standard.
	InstalledOtherCount *int64 `type:"integer"`

	// The number of patches that were applied, but that require the instance to
	// be rebooted in order to be marked as installed.
	InstalledPendingReboot *int64 `type:"integer"`

	// The number of patches that are installed but are also on a list of patches
	// that the customer rejected.
	InstalledRejectedCount *int64 `type:"integer"`

	// The number of patches that are part of the compliance standard but are not
	// installed. The count includes patches that failed to install.
	MissingCount *int64 `type:"integer"`

	// The type of patch operation performed. For Patch Manager, the values are
	// SCAN and INSTALL.
	Operation *string `type:"string"`

	// Indicates when the operation completed.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	OperationEndTime *string `type:"string"`

	// Indicates when the operation started.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	OperationStartTime *string `type:"string"`

	// The reboot option specified for the instance.
	RebootOption *string `type:"string"`
	// contains filtered or unexported fields
}

Provides an overview of the patch compliance status for an instance against a selected compliance standard.

func (PatchSummary) GoString

func (s PatchSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PatchSummary) SetFailedCount

func (s *PatchSummary) SetFailedCount(v int64) *PatchSummary

SetFailedCount sets the FailedCount field's value.

func (*PatchSummary) SetId

func (s *PatchSummary) SetId(v string) *PatchSummary

SetId sets the Id field's value.

func (*PatchSummary) SetInstalledCount

func (s *PatchSummary) SetInstalledCount(v int64) *PatchSummary

SetInstalledCount sets the InstalledCount field's value.

func (*PatchSummary) SetInstalledOtherCount

func (s *PatchSummary) SetInstalledOtherCount(v int64) *PatchSummary

SetInstalledOtherCount sets the InstalledOtherCount field's value.

func (*PatchSummary) SetInstalledPendingReboot

func (s *PatchSummary) SetInstalledPendingReboot(v int64) *PatchSummary

SetInstalledPendingReboot sets the InstalledPendingReboot field's value.

func (*PatchSummary) SetInstalledRejectedCount

func (s *PatchSummary) SetInstalledRejectedCount(v int64) *PatchSummary

SetInstalledRejectedCount sets the InstalledRejectedCount field's value.

func (*PatchSummary) SetMissingCount

func (s *PatchSummary) SetMissingCount(v int64) *PatchSummary

SetMissingCount sets the MissingCount field's value.

func (*PatchSummary) SetOperation

func (s *PatchSummary) SetOperation(v string) *PatchSummary

SetOperation sets the Operation field's value.

func (*PatchSummary) SetOperationEndTime

func (s *PatchSummary) SetOperationEndTime(v string) *PatchSummary

SetOperationEndTime sets the OperationEndTime field's value.

func (*PatchSummary) SetOperationStartTime

func (s *PatchSummary) SetOperationStartTime(v string) *PatchSummary

SetOperationStartTime sets the OperationStartTime field's value.

func (*PatchSummary) SetRebootOption

func (s *PatchSummary) SetRebootOption(v string) *PatchSummary

SetRebootOption sets the RebootOption field's value.

func (PatchSummary) String

func (s PatchSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PatchSummary) Validate

func (s *PatchSummary) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PortProbeAction

type PortProbeAction struct {

	// Indicates whether the port probe was blocked.
	Blocked *bool `type:"boolean"`

	// Information about the ports affected by the port probe.
	PortProbeDetails []*PortProbeDetail `type:"list"`
	// contains filtered or unexported fields
}

Provided if ActionType is PORT_PROBE. It provides details about the attempted port probe that was detected.

func (PortProbeAction) GoString

func (s PortProbeAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PortProbeAction) SetBlocked

func (s *PortProbeAction) SetBlocked(v bool) *PortProbeAction

SetBlocked sets the Blocked field's value.

func (*PortProbeAction) SetPortProbeDetails

func (s *PortProbeAction) SetPortProbeDetails(v []*PortProbeDetail) *PortProbeAction

SetPortProbeDetails sets the PortProbeDetails field's value.

func (PortProbeAction) String

func (s PortProbeAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PortProbeDetail

type PortProbeDetail struct {

	// Provides information about the IP address where the scanned port is located.
	LocalIpDetails *ActionLocalIpDetails `type:"structure"`

	// Provides information about the port that was scanned.
	LocalPortDetails *ActionLocalPortDetails `type:"structure"`

	// Provides information about the remote IP address that performed the scan.
	RemoteIpDetails *ActionRemoteIpDetails `type:"structure"`
	// contains filtered or unexported fields
}

A port scan that was part of the port probe. For each scan, PortProbeDetails provides information about the local IP address and port that were scanned, and the remote IP address that the scan originated from.

func (PortProbeDetail) GoString

func (s PortProbeDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PortProbeDetail) SetLocalIpDetails

func (s *PortProbeDetail) SetLocalIpDetails(v *ActionLocalIpDetails) *PortProbeDetail

SetLocalIpDetails sets the LocalIpDetails field's value.

func (*PortProbeDetail) SetLocalPortDetails

func (s *PortProbeDetail) SetLocalPortDetails(v *ActionLocalPortDetails) *PortProbeDetail

SetLocalPortDetails sets the LocalPortDetails field's value.

func (*PortProbeDetail) SetRemoteIpDetails

func (s *PortProbeDetail) SetRemoteIpDetails(v *ActionRemoteIpDetails) *PortProbeDetail

SetRemoteIpDetails sets the RemoteIpDetails field's value.

func (PortProbeDetail) String

func (s PortProbeDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PortRange

type PortRange struct {

	// The first port in the port range.
	Begin *int64 `type:"integer"`

	// The last port in the port range.
	End *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A range of ports.

func (PortRange) GoString

func (s PortRange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PortRange) SetBegin

func (s *PortRange) SetBegin(v int64) *PortRange

SetBegin sets the Begin field's value.

func (*PortRange) SetEnd

func (s *PortRange) SetEnd(v int64) *PortRange

SetEnd sets the End field's value.

func (PortRange) String

func (s PortRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PortRangeFromTo

type PortRangeFromTo struct {

	// The first port in the port range.
	From *int64 `type:"integer"`

	// The last port in the port range.
	To *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A range of ports.

func (PortRangeFromTo) GoString

func (s PortRangeFromTo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PortRangeFromTo) SetFrom

func (s *PortRangeFromTo) SetFrom(v int64) *PortRangeFromTo

SetFrom sets the From field's value.

func (*PortRangeFromTo) SetTo

func (s *PortRangeFromTo) SetTo(v int64) *PortRangeFromTo

SetTo sets the To field's value.

func (PortRangeFromTo) String

func (s PortRangeFromTo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProcessDetails

type ProcessDetails struct {

	// Indicates when the process was launched.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	LaunchedAt *string `type:"string"`

	// The name of the process.
	Name *string `type:"string"`

	// The parent process ID. This field accepts positive integers between O and
	// 2147483647.
	ParentPid *int64 `type:"integer"`

	// The path to the process executable.
	Path *string `type:"string"`

	// The process ID.
	Pid *int64 `type:"integer"`

	// Indicates when the process was terminated.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	TerminatedAt *string `type:"string"`
	// contains filtered or unexported fields
}

The details of process-related information about a finding.

func (ProcessDetails) GoString

func (s ProcessDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProcessDetails) SetLaunchedAt

func (s *ProcessDetails) SetLaunchedAt(v string) *ProcessDetails

SetLaunchedAt sets the LaunchedAt field's value.

func (*ProcessDetails) SetName

func (s *ProcessDetails) SetName(v string) *ProcessDetails

SetName sets the Name field's value.

func (*ProcessDetails) SetParentPid

func (s *ProcessDetails) SetParentPid(v int64) *ProcessDetails

SetParentPid sets the ParentPid field's value.

func (*ProcessDetails) SetPath

func (s *ProcessDetails) SetPath(v string) *ProcessDetails

SetPath sets the Path field's value.

func (*ProcessDetails) SetPid

func (s *ProcessDetails) SetPid(v int64) *ProcessDetails

SetPid sets the Pid field's value.

func (*ProcessDetails) SetTerminatedAt

func (s *ProcessDetails) SetTerminatedAt(v string) *ProcessDetails

SetTerminatedAt sets the TerminatedAt field's value.

func (ProcessDetails) String

func (s ProcessDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Product

type Product struct {

	// The URL to the service or product documentation about the integration with
	// Security Hub, including how to activate the integration.
	ActivationUrl *string `type:"string"`

	// The categories assigned to the product.
	Categories []*string `type:"list"`

	// The name of the company that provides the product.
	CompanyName *string `type:"string"`

	// A description of the product.
	Description *string `type:"string"`

	// The types of integration that the product supports. Available values are
	// the following.
	//
	//    * SEND_FINDINGS_TO_SECURITY_HUB - The integration sends findings to Security
	//    Hub.
	//
	//    * RECEIVE_FINDINGS_FROM_SECURITY_HUB - The integration receives findings
	//    from Security Hub.
	//
	//    * UPDATE_FINDINGS_IN_SECURITY_HUB - The integration does not send new
	//    findings to Security Hub, but does make updates to the findings that it
	//    receives from Security Hub.
	IntegrationTypes []*string `type:"list" enum:"IntegrationType"`

	// For integrations with Amazon Web Services services, the Amazon Web Services
	// Console URL from which to activate the service.
	//
	// For integrations with third-party products, the Amazon Web Services Marketplace
	// URL from which to subscribe to or purchase the product.
	MarketplaceUrl *string `type:"string"`

	// The ARN assigned to the product.
	//
	// ProductArn is a required field
	ProductArn *string `type:"string" required:"true"`

	// The name of the product.
	ProductName *string `type:"string"`

	// The resource policy associated with the product.
	ProductSubscriptionResourcePolicy *string `type:"string"`
	// contains filtered or unexported fields
}

Contains details about a product.

func (Product) GoString

func (s Product) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Product) SetActivationUrl

func (s *Product) SetActivationUrl(v string) *Product

SetActivationUrl sets the ActivationUrl field's value.

func (*Product) SetCategories

func (s *Product) SetCategories(v []*string) *Product

SetCategories sets the Categories field's value.

func (*Product) SetCompanyName

func (s *Product) SetCompanyName(v string) *Product

SetCompanyName sets the CompanyName field's value.

func (*Product) SetDescription

func (s *Product) SetDescription(v string) *Product

SetDescription sets the Description field's value.

func (*Product) SetIntegrationTypes

func (s *Product) SetIntegrationTypes(v []*string) *Product

SetIntegrationTypes sets the IntegrationTypes field's value.

func (*Product) SetMarketplaceUrl

func (s *Product) SetMarketplaceUrl(v string) *Product

SetMarketplaceUrl sets the MarketplaceUrl field's value.

func (*Product) SetProductArn

func (s *Product) SetProductArn(v string) *Product

SetProductArn sets the ProductArn field's value.

func (*Product) SetProductName

func (s *Product) SetProductName(v string) *Product

SetProductName sets the ProductName field's value.

func (*Product) SetProductSubscriptionResourcePolicy

func (s *Product) SetProductSubscriptionResourcePolicy(v string) *Product

SetProductSubscriptionResourcePolicy sets the ProductSubscriptionResourcePolicy field's value.

func (Product) String

func (s Product) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PropagatingVgwSetDetails added in v1.42.9

type PropagatingVgwSetDetails struct {

	// The ID of the virtual private gateway.
	GatewayId *string `type:"string"`
	// contains filtered or unexported fields
}

Describes a virtual private gateway propagating route.

func (PropagatingVgwSetDetails) GoString added in v1.42.9

func (s PropagatingVgwSetDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropagatingVgwSetDetails) SetGatewayId added in v1.42.9

SetGatewayId sets the GatewayId field's value.

func (PropagatingVgwSetDetails) String added in v1.42.9

func (s PropagatingVgwSetDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Range

type Range struct {

	// The number of lines (for a line range) or characters (for an offset range)
	// from the beginning of the file to the end of the sensitive data.
	End *int64 `type:"long"`

	// The number of lines (for a line range) or characters (for an offset range)
	// from the beginning of the file to the end of the sensitive data.
	Start *int64 `type:"long"`

	// In the line where the sensitive data starts, the column within the line where
	// the sensitive data starts.
	StartColumn *int64 `type:"long"`
	// contains filtered or unexported fields
}

Identifies where the sensitive data begins and ends.

func (Range) GoString

func (s Range) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Range) SetEnd

func (s *Range) SetEnd(v int64) *Range

SetEnd sets the End field's value.

func (*Range) SetStart

func (s *Range) SetStart(v int64) *Range

SetStart sets the Start field's value.

func (*Range) SetStartColumn

func (s *Range) SetStartColumn(v int64) *Range

SetStartColumn sets the StartColumn field's value.

func (Range) String

func (s Range) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Recommendation

type Recommendation struct {

	// Describes the recommended steps to take to remediate an issue identified
	// in a finding.
	Text *string `type:"string"`

	// A URL to a page or site that contains information about how to remediate
	// a finding.
	Url *string `type:"string"`
	// contains filtered or unexported fields
}

A recommendation on how to remediate the issue identified in a finding.

func (Recommendation) GoString

func (s Recommendation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Recommendation) SetText

func (s *Recommendation) SetText(v string) *Recommendation

SetText sets the Text field's value.

func (*Recommendation) SetUrl

func (s *Recommendation) SetUrl(v string) *Recommendation

SetUrl sets the Url field's value.

func (Recommendation) String

func (s Recommendation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Record

type Record struct {

	// The path, as a JSONPath expression, to the field in the record that contains
	// the data. If the field name is longer than 20 characters, it is truncated.
	// If the path is longer than 250 characters, it is truncated.
	JsonPath *string `type:"string"`

	// The record index, starting from 0, for the record that contains the data.
	RecordIndex *int64 `type:"long"`
	// contains filtered or unexported fields
}

An occurrence of sensitive data in an Apache Avro object container or an Apache Parquet file.

func (Record) GoString

func (s Record) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Record) SetJsonPath

func (s *Record) SetJsonPath(v string) *Record

SetJsonPath sets the JsonPath field's value.

func (*Record) SetRecordIndex

func (s *Record) SetRecordIndex(v int64) *Record

SetRecordIndex sets the RecordIndex field's value.

func (Record) String

func (s Record) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RelatedFinding

type RelatedFinding struct {

	// The product-generated identifier for a related finding.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The ARN of the product that generated a related finding.
	//
	// ProductArn is a required field
	ProductArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Details about a related finding.

func (RelatedFinding) GoString

func (s RelatedFinding) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelatedFinding) SetId

func (s *RelatedFinding) SetId(v string) *RelatedFinding

SetId sets the Id field's value.

func (*RelatedFinding) SetProductArn

func (s *RelatedFinding) SetProductArn(v string) *RelatedFinding

SetProductArn sets the ProductArn field's value.

func (RelatedFinding) String

func (s RelatedFinding) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelatedFinding) Validate

func (s *RelatedFinding) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Remediation

type Remediation struct {

	// A recommendation on the steps to take to remediate the issue identified by
	// a finding.
	Recommendation *Recommendation `type:"structure"`
	// contains filtered or unexported fields
}

Details about the remediation steps for a finding.

func (Remediation) GoString

func (s Remediation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Remediation) SetRecommendation

func (s *Remediation) SetRecommendation(v *Recommendation) *Remediation

SetRecommendation sets the Recommendation field's value.

func (Remediation) String

func (s Remediation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Resource

type Resource struct {

	// Contains information about sensitive data that was detected on the resource.
	DataClassification *DataClassificationDetails `type:"structure"`

	// Additional details about the resource related to a finding.
	Details *ResourceDetails `type:"structure"`

	// The canonical identifier for the given resource type.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// The canonical Amazon Web Services partition name that the Region is assigned
	// to.
	Partition *string `type:"string" enum:"Partition"`

	// The canonical Amazon Web Services external Region name where this resource
	// is located.
	Region *string `type:"string"`

	// Identifies the role of the resource in the finding. A resource is either
	// the actor or target of the finding activity,
	ResourceRole *string `type:"string"`

	// A list of Amazon Web Services tags associated with a resource at the time
	// the finding was processed.
	Tags map[string]*string `type:"map"`

	// The type of the resource that details are provided for. If possible, set
	// Type to one of the supported resource types. For example, if the resource
	// is an EC2 instance, then set Type to AwsEc2Instance.
	//
	// If the resource does not match any of the provided types, then set Type to
	// Other.
	//
	// Type is a required field
	Type *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A resource related to a finding.

func (Resource) GoString

func (s Resource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Resource) SetDataClassification

func (s *Resource) SetDataClassification(v *DataClassificationDetails) *Resource

SetDataClassification sets the DataClassification field's value.

func (*Resource) SetDetails

func (s *Resource) SetDetails(v *ResourceDetails) *Resource

SetDetails sets the Details field's value.

func (*Resource) SetId

func (s *Resource) SetId(v string) *Resource

SetId sets the Id field's value.

func (*Resource) SetPartition

func (s *Resource) SetPartition(v string) *Resource

SetPartition sets the Partition field's value.

func (*Resource) SetRegion

func (s *Resource) SetRegion(v string) *Resource

SetRegion sets the Region field's value.

func (*Resource) SetResourceRole

func (s *Resource) SetResourceRole(v string) *Resource

SetResourceRole sets the ResourceRole field's value.

func (*Resource) SetTags

func (s *Resource) SetTags(v map[string]*string) *Resource

SetTags sets the Tags field's value.

func (*Resource) SetType

func (s *Resource) SetType(v string) *Resource

SetType sets the Type field's value.

func (Resource) String

func (s Resource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Resource) Validate

func (s *Resource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceConflictException

type ResourceConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The resource specified in the request conflicts with an existing resource.

func (*ResourceConflictException) Code

Code returns the exception type name.

func (*ResourceConflictException) Error

func (s *ResourceConflictException) Error() string

func (ResourceConflictException) GoString

func (s ResourceConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceConflictException) Message

func (s *ResourceConflictException) Message() string

Message returns the exception's message.

func (*ResourceConflictException) OrigErr

func (s *ResourceConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceConflictException) RequestID

func (s *ResourceConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceConflictException) StatusCode

func (s *ResourceConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceConflictException) String

func (s ResourceConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceDetails

type ResourceDetails struct {

	// Provides details about AppSync message broker. A message broker allows software
	// applications and components to communicate using various programming languages,
	// operating systems, and formal messaging protocols.
	AwsAmazonMqBroker *AwsAmazonMqBrokerDetails `type:"structure"`

	// Provides information about a REST API in version 1 of Amazon API Gateway.
	AwsApiGatewayRestApi *AwsApiGatewayRestApiDetails `type:"structure"`

	// Provides information about a version 1 Amazon API Gateway stage.
	AwsApiGatewayStage *AwsApiGatewayStageDetails `type:"structure"`

	// Provides information about a version 2 API in Amazon API Gateway.
	AwsApiGatewayV2Api *AwsApiGatewayV2ApiDetails `type:"structure"`

	// Provides information about a version 2 stage for Amazon API Gateway.
	AwsApiGatewayV2Stage *AwsApiGatewayV2StageDetails `type:"structure"`

	// Provides details about an AppSync Graph QL API, which lets you query multiple
	// databases, microservices, and APIs from a single GraphQL endpoint.
	AwsAppSyncGraphQlApi *AwsAppSyncGraphQlApiDetails `type:"structure"`

	// Provides information about an Amazon Athena workgroup. A workgroup helps
	// you separate users, teams, applications, or workloads. It also helps you
	// set limits on data processing and track costs.
	AwsAthenaWorkGroup *AwsAthenaWorkGroupDetails `type:"structure"`

	// Details for an autoscaling group.
	AwsAutoScalingAutoScalingGroup *AwsAutoScalingAutoScalingGroupDetails `type:"structure"`

	// Provides details about a launch configuration.
	AwsAutoScalingLaunchConfiguration *AwsAutoScalingLaunchConfigurationDetails `type:"structure"`

	// Provides details about an Backup backup plan.
	AwsBackupBackupPlan *AwsBackupBackupPlanDetails `type:"structure"`

	// Provides details about an Backup backup vault.
	AwsBackupBackupVault *AwsBackupBackupVaultDetails `type:"structure"`

	// Provides details about an Backup backup, or recovery point.
	AwsBackupRecoveryPoint *AwsBackupRecoveryPointDetails `type:"structure"`

	// Provides details about an Certificate Manager certificate.
	AwsCertificateManagerCertificate *AwsCertificateManagerCertificateDetails `type:"structure"`

	// Details about an CloudFormation stack. A stack is a collection of Amazon
	// Web Services resources that you can manage as a single unit.
	AwsCloudFormationStack *AwsCloudFormationStackDetails `type:"structure"`

	// Details about a CloudFront distribution.
	AwsCloudFrontDistribution *AwsCloudFrontDistributionDetails `type:"structure"`

	// Provides details about a CloudTrail trail.
	AwsCloudTrailTrail *AwsCloudTrailTrailDetails `type:"structure"`

	// Details about an Amazon CloudWatch alarm. An alarm allows you to monitor
	// and receive alerts about your Amazon Web Services resources and applications
	// across multiple Regions.
	AwsCloudWatchAlarm *AwsCloudWatchAlarmDetails `type:"structure"`

	// Details for an CodeBuild project.
	AwsCodeBuildProject *AwsCodeBuildProjectDetails `type:"structure"`

	// Details about a DynamoDB table.
	AwsDynamoDbTable *AwsDynamoDbTableDetails `type:"structure"`

	// Details about an Elastic IP address.
	AwsEc2Eip *AwsEc2EipDetails `type:"structure"`

	// Details about an EC2 instance related to a finding.
	AwsEc2Instance *AwsEc2InstanceDetails `type:"structure"`

	// Specifies the properties for creating an Amazon Elastic Compute Cloud (Amazon
	// EC2) launch template.
	AwsEc2LaunchTemplate *AwsEc2LaunchTemplateDetails `type:"structure"`

	// Details about an EC2 network access control list (ACL).
	AwsEc2NetworkAcl *AwsEc2NetworkAclDetails `type:"structure"`

	// Details for an EC2 network interface.
	AwsEc2NetworkInterface *AwsEc2NetworkInterfaceDetails `type:"structure"`

	// Provides details about a route table. A route table contains a set of rules,
	// called routes, that determine where to direct network traffic from your subnet
	// or gateway.
	AwsEc2RouteTable *AwsEc2RouteTableDetails `type:"structure"`

	// Details for an EC2 security group.
	AwsEc2SecurityGroup *AwsEc2SecurityGroupDetails `type:"structure"`

	// Details about a subnet in Amazon EC2.
	AwsEc2Subnet *AwsEc2SubnetDetails `type:"structure"`

	// Details about an Amazon EC2 transit gateway that interconnects your virtual
	// private clouds (VPC) and on-premises networks.
	AwsEc2TransitGateway *AwsEc2TransitGatewayDetails `type:"structure"`

	// Details for an Amazon EC2 volume.
	AwsEc2Volume *AwsEc2VolumeDetails `type:"structure"`

	// Details for an Amazon EC2 VPC.
	AwsEc2Vpc *AwsEc2VpcDetails `type:"structure"`

	// Details about the service configuration for a VPC endpoint service.
	AwsEc2VpcEndpointService *AwsEc2VpcEndpointServiceDetails `type:"structure"`

	// Details about an Amazon EC2 VPC peering connection. A VPC peering connection
	// is a networking connection between two VPCs that enables you to route traffic
	// between them privately.
	AwsEc2VpcPeeringConnection *AwsEc2VpcPeeringConnectionDetails `type:"structure"`

	// Details about an Amazon EC2 VPN connection.
	AwsEc2VpnConnection *AwsEc2VpnConnectionDetails `type:"structure"`

	// Information about an Amazon ECR image.
	AwsEcrContainerImage *AwsEcrContainerImageDetails `type:"structure"`

	// Information about an Amazon Elastic Container Registry repository.
	AwsEcrRepository *AwsEcrRepositoryDetails `type:"structure"`

	// Details about an Amazon ECS cluster.
	AwsEcsCluster *AwsEcsClusterDetails `type:"structure"`

	// Provides information about a Docker container that's part of a task.
	AwsEcsContainer *AwsEcsContainerDetails `type:"structure"`

	// Details about a service within an ECS cluster.
	AwsEcsService *AwsEcsServiceDetails `type:"structure"`

	// Details about a task in a cluster.
	AwsEcsTask *AwsEcsTaskDetails `type:"structure"`

	// Details about a task definition. A task definition describes the container
	// and volume definitions of an Amazon Elastic Container Service task.
	AwsEcsTaskDefinition *AwsEcsTaskDefinitionDetails `type:"structure"`

	// Details about an Amazon EFS access point. An access point is an application-specific
	// view into an EFS file system that applies an operating system user and group,
	// and a file system path, to any file system request made through the access
	// point.
	AwsEfsAccessPoint *AwsEfsAccessPointDetails `type:"structure"`

	// Details about an Amazon EKS cluster.
	AwsEksCluster *AwsEksClusterDetails `type:"structure"`

	// Details about an Elastic Beanstalk environment.
	AwsElasticBeanstalkEnvironment *AwsElasticBeanstalkEnvironmentDetails `type:"structure"`

	// Details for an Elasticsearch domain.
	AwsElasticsearchDomain *AwsElasticsearchDomainDetails `type:"structure"`

	// Contains details about a Classic Load Balancer.
	AwsElbLoadBalancer *AwsElbLoadBalancerDetails `type:"structure"`

	// Details about a load balancer.
	AwsElbv2LoadBalancer *AwsElbv2LoadBalancerDetails `type:"structure"`

	// A schema defines the structure of events that are sent to Amazon EventBridge.
	// Schema registries are containers for schemas. They collect and organize schemas
	// so that your schemas are in logical groups.
	AwsEventSchemasRegistry *AwsEventSchemasRegistryDetails `type:"structure"`

	// Provides details about an Amazon GuardDuty detector. A detector is an object
	// that represents the GuardDuty service. A detector is required for GuardDuty
	// to become operational.
	AwsGuardDutyDetector *AwsGuardDutyDetectorDetails `type:"structure"`

	// Details about an IAM access key related to a finding.
	AwsIamAccessKey *AwsIamAccessKeyDetails `type:"structure"`

	// Contains details about an IAM group.
	AwsIamGroup *AwsIamGroupDetails `type:"structure"`

	// Details about an IAM permissions policy.
	AwsIamPolicy *AwsIamPolicyDetails `type:"structure"`

	// Details about an IAM role.
	AwsIamRole *AwsIamRoleDetails `type:"structure"`

	// Details about an IAM user.
	AwsIamUser *AwsIamUserDetails `type:"structure"`

	// Details about an Amazon Kinesis data stream.
	AwsKinesisStream *AwsKinesisStreamDetails `type:"structure"`

	// Details about an KMS key.
	AwsKmsKey *AwsKmsKeyDetails `type:"structure"`

	// Details about a Lambda function.
	AwsLambdaFunction *AwsLambdaFunctionDetails `type:"structure"`

	// Details for a Lambda layer version.
	AwsLambdaLayerVersion *AwsLambdaLayerVersionDetails `type:"structure"`

	// Details about an Network Firewall firewall.
	AwsNetworkFirewallFirewall *AwsNetworkFirewallFirewallDetails `type:"structure"`

	// Details about an Network Firewall firewall policy.
	AwsNetworkFirewallFirewallPolicy *AwsNetworkFirewallFirewallPolicyDetails `type:"structure"`

	// Details about an Network Firewall rule group.
	AwsNetworkFirewallRuleGroup *AwsNetworkFirewallRuleGroupDetails `type:"structure"`

	// Details about an Amazon OpenSearch Service domain.
	AwsOpenSearchServiceDomain *AwsOpenSearchServiceDomainDetails `type:"structure"`

	// Details about an Amazon RDS database cluster.
	AwsRdsDbCluster *AwsRdsDbClusterDetails `type:"structure"`

	// Details about an Amazon RDS database cluster snapshot.
	AwsRdsDbClusterSnapshot *AwsRdsDbClusterSnapshotDetails `type:"structure"`

	// Details about an Amazon RDS database instance.
	AwsRdsDbInstance *AwsRdsDbInstanceDetails `type:"structure"`

	// Details about an Amazon RDS DB security group.
	AwsRdsDbSecurityGroup *AwsRdsDbSecurityGroupDetails `type:"structure"`

	// Details about an Amazon RDS database snapshot.
	AwsRdsDbSnapshot *AwsRdsDbSnapshotDetails `type:"structure"`

	// Details about an RDS event notification subscription.
	AwsRdsEventSubscription *AwsRdsEventSubscriptionDetails `type:"structure"`

	// Contains details about an Amazon Redshift cluster.
	AwsRedshiftCluster *AwsRedshiftClusterDetails `type:"structure"`

	// Details about the Amazon S3 Public Access Block configuration for an account.
	AwsS3AccountPublicAccessBlock *AwsS3AccountPublicAccessBlockDetails `type:"structure"`

	// Details about an S3 bucket related to a finding.
	AwsS3Bucket *AwsS3BucketDetails `type:"structure"`

	// Details about an S3 object related to a finding.
	AwsS3Object *AwsS3ObjectDetails `type:"structure"`

	// Provides details about an Amazon SageMaker notebook instance.
	AwsSageMakerNotebookInstance *AwsSageMakerNotebookInstanceDetails `type:"structure"`

	// Details about a Secrets Manager secret.
	AwsSecretsManagerSecret *AwsSecretsManagerSecretDetails `type:"structure"`

	// Details about an SNS topic.
	AwsSnsTopic *AwsSnsTopicDetails `type:"structure"`

	// Details about an SQS queue.
	AwsSqsQueue *AwsSqsQueueDetails `type:"structure"`

	// Provides information about the state of a patch on an instance based on the
	// patch baseline that was used to patch the instance.
	AwsSsmPatchCompliance *AwsSsmPatchComplianceDetails `type:"structure"`

	// Provides details about an Step Functions state machine, which is a workflow
	// consisting of a series of event-driven steps.
	AwsStepFunctionStateMachine *AwsStepFunctionStateMachineDetails `type:"structure"`

	// Details about a rate-based rule for global resources.
	AwsWafRateBasedRule *AwsWafRateBasedRuleDetails `type:"structure"`

	// Details about a rate-based rule for Regional resources.
	AwsWafRegionalRateBasedRule *AwsWafRegionalRateBasedRuleDetails `type:"structure"`

	// Details about an WAF rule for Regional resources.
	AwsWafRegionalRule *AwsWafRegionalRuleDetails `type:"structure"`

	// Details about an WAF rule group for Regional resources.
	AwsWafRegionalRuleGroup *AwsWafRegionalRuleGroupDetails `type:"structure"`

	// Details about an WAF web access control list (web ACL) for Regional resources.
	AwsWafRegionalWebAcl *AwsWafRegionalWebAclDetails `type:"structure"`

	// Details about an WAF rule for global resources.
	AwsWafRule *AwsWafRuleDetails `type:"structure"`

	// Details about an WAF rule group for global resources.
	AwsWafRuleGroup *AwsWafRuleGroupDetails `type:"structure"`

	// Details for an WAF web ACL.
	AwsWafWebAcl *AwsWafWebAclDetails `type:"structure"`

	// Details about an WAFv2 rule group.
	AwsWafv2RuleGroup *AwsWafv2RuleGroupDetails `type:"structure"`

	// Details about an WAFv2 web Access Control List (ACL).
	AwsWafv2WebAcl *AwsWafv2WebAclDetails `type:"structure"`

	// Information about the encryption configuration for X-Ray.
	AwsXrayEncryptionConfig *AwsXrayEncryptionConfigDetails `type:"structure"`

	// Details about a container resource related to a finding.
	Container *ContainerDetails `type:"structure"`

	// Details about a resource that are not available in a type-specific details
	// object. Use the Other object in the following cases.
	//
	//    * The type-specific object does not contain all of the fields that you
	//    want to populate. In this case, first use the type-specific object to
	//    populate those fields. Use the Other object to populate the fields that
	//    are missing from the type-specific object.
	//
	//    * The resource type does not have a corresponding object. This includes
	//    resources for which the type is Other.
	Other map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

Additional details about a resource related to a finding.

To provide the details, use the object that corresponds to the resource type. For example, if the resource type is AwsEc2Instance, then you use the AwsEc2Instance object to provide the details.

If the type-specific object does not contain all of the fields you want to populate, then you use the Other object to populate those additional fields.

You also use the Other object to populate the details when the selected type does not have a corresponding object.

func (ResourceDetails) GoString

func (s ResourceDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceDetails) SetAwsAmazonMqBroker added in v1.42.9

func (s *ResourceDetails) SetAwsAmazonMqBroker(v *AwsAmazonMqBrokerDetails) *ResourceDetails

SetAwsAmazonMqBroker sets the AwsAmazonMqBroker field's value.

func (*ResourceDetails) SetAwsApiGatewayRestApi

func (s *ResourceDetails) SetAwsApiGatewayRestApi(v *AwsApiGatewayRestApiDetails) *ResourceDetails

SetAwsApiGatewayRestApi sets the AwsApiGatewayRestApi field's value.

func (*ResourceDetails) SetAwsApiGatewayStage

func (s *ResourceDetails) SetAwsApiGatewayStage(v *AwsApiGatewayStageDetails) *ResourceDetails

SetAwsApiGatewayStage sets the AwsApiGatewayStage field's value.

func (*ResourceDetails) SetAwsApiGatewayV2Api

func (s *ResourceDetails) SetAwsApiGatewayV2Api(v *AwsApiGatewayV2ApiDetails) *ResourceDetails

SetAwsApiGatewayV2Api sets the AwsApiGatewayV2Api field's value.

func (*ResourceDetails) SetAwsApiGatewayV2Stage

func (s *ResourceDetails) SetAwsApiGatewayV2Stage(v *AwsApiGatewayV2StageDetails) *ResourceDetails

SetAwsApiGatewayV2Stage sets the AwsApiGatewayV2Stage field's value.

func (*ResourceDetails) SetAwsAppSyncGraphQlApi added in v1.42.9

func (s *ResourceDetails) SetAwsAppSyncGraphQlApi(v *AwsAppSyncGraphQlApiDetails) *ResourceDetails

SetAwsAppSyncGraphQlApi sets the AwsAppSyncGraphQlApi field's value.

func (*ResourceDetails) SetAwsAthenaWorkGroup added in v1.42.9

func (s *ResourceDetails) SetAwsAthenaWorkGroup(v *AwsAthenaWorkGroupDetails) *ResourceDetails

SetAwsAthenaWorkGroup sets the AwsAthenaWorkGroup field's value.

func (*ResourceDetails) SetAwsAutoScalingAutoScalingGroup

func (s *ResourceDetails) SetAwsAutoScalingAutoScalingGroup(v *AwsAutoScalingAutoScalingGroupDetails) *ResourceDetails

SetAwsAutoScalingAutoScalingGroup sets the AwsAutoScalingAutoScalingGroup field's value.

func (*ResourceDetails) SetAwsAutoScalingLaunchConfiguration

func (s *ResourceDetails) SetAwsAutoScalingLaunchConfiguration(v *AwsAutoScalingLaunchConfigurationDetails) *ResourceDetails

SetAwsAutoScalingLaunchConfiguration sets the AwsAutoScalingLaunchConfiguration field's value.

func (*ResourceDetails) SetAwsBackupBackupPlan added in v1.42.9

func (s *ResourceDetails) SetAwsBackupBackupPlan(v *AwsBackupBackupPlanDetails) *ResourceDetails

SetAwsBackupBackupPlan sets the AwsBackupBackupPlan field's value.

func (*ResourceDetails) SetAwsBackupBackupVault added in v1.42.9

func (s *ResourceDetails) SetAwsBackupBackupVault(v *AwsBackupBackupVaultDetails) *ResourceDetails

SetAwsBackupBackupVault sets the AwsBackupBackupVault field's value.

func (*ResourceDetails) SetAwsBackupRecoveryPoint added in v1.42.9

func (s *ResourceDetails) SetAwsBackupRecoveryPoint(v *AwsBackupRecoveryPointDetails) *ResourceDetails

SetAwsBackupRecoveryPoint sets the AwsBackupRecoveryPoint field's value.

func (*ResourceDetails) SetAwsCertificateManagerCertificate

func (s *ResourceDetails) SetAwsCertificateManagerCertificate(v *AwsCertificateManagerCertificateDetails) *ResourceDetails

SetAwsCertificateManagerCertificate sets the AwsCertificateManagerCertificate field's value.

func (*ResourceDetails) SetAwsCloudFormationStack added in v1.42.9

func (s *ResourceDetails) SetAwsCloudFormationStack(v *AwsCloudFormationStackDetails) *ResourceDetails

SetAwsCloudFormationStack sets the AwsCloudFormationStack field's value.

func (*ResourceDetails) SetAwsCloudFrontDistribution

func (s *ResourceDetails) SetAwsCloudFrontDistribution(v *AwsCloudFrontDistributionDetails) *ResourceDetails

SetAwsCloudFrontDistribution sets the AwsCloudFrontDistribution field's value.

func (*ResourceDetails) SetAwsCloudTrailTrail

func (s *ResourceDetails) SetAwsCloudTrailTrail(v *AwsCloudTrailTrailDetails) *ResourceDetails

SetAwsCloudTrailTrail sets the AwsCloudTrailTrail field's value.

func (*ResourceDetails) SetAwsCloudWatchAlarm added in v1.42.9

func (s *ResourceDetails) SetAwsCloudWatchAlarm(v *AwsCloudWatchAlarmDetails) *ResourceDetails

SetAwsCloudWatchAlarm sets the AwsCloudWatchAlarm field's value.

func (*ResourceDetails) SetAwsCodeBuildProject

func (s *ResourceDetails) SetAwsCodeBuildProject(v *AwsCodeBuildProjectDetails) *ResourceDetails

SetAwsCodeBuildProject sets the AwsCodeBuildProject field's value.

func (*ResourceDetails) SetAwsDynamoDbTable

func (s *ResourceDetails) SetAwsDynamoDbTable(v *AwsDynamoDbTableDetails) *ResourceDetails

SetAwsDynamoDbTable sets the AwsDynamoDbTable field's value.

func (*ResourceDetails) SetAwsEc2Eip

func (s *ResourceDetails) SetAwsEc2Eip(v *AwsEc2EipDetails) *ResourceDetails

SetAwsEc2Eip sets the AwsEc2Eip field's value.

func (*ResourceDetails) SetAwsEc2Instance

func (s *ResourceDetails) SetAwsEc2Instance(v *AwsEc2InstanceDetails) *ResourceDetails

SetAwsEc2Instance sets the AwsEc2Instance field's value.

func (*ResourceDetails) SetAwsEc2LaunchTemplate added in v1.42.9

func (s *ResourceDetails) SetAwsEc2LaunchTemplate(v *AwsEc2LaunchTemplateDetails) *ResourceDetails

SetAwsEc2LaunchTemplate sets the AwsEc2LaunchTemplate field's value.

func (*ResourceDetails) SetAwsEc2NetworkAcl

func (s *ResourceDetails) SetAwsEc2NetworkAcl(v *AwsEc2NetworkAclDetails) *ResourceDetails

SetAwsEc2NetworkAcl sets the AwsEc2NetworkAcl field's value.

func (*ResourceDetails) SetAwsEc2NetworkInterface

func (s *ResourceDetails) SetAwsEc2NetworkInterface(v *AwsEc2NetworkInterfaceDetails) *ResourceDetails

SetAwsEc2NetworkInterface sets the AwsEc2NetworkInterface field's value.

func (*ResourceDetails) SetAwsEc2RouteTable added in v1.42.9

func (s *ResourceDetails) SetAwsEc2RouteTable(v *AwsEc2RouteTableDetails) *ResourceDetails

SetAwsEc2RouteTable sets the AwsEc2RouteTable field's value.

func (*ResourceDetails) SetAwsEc2SecurityGroup

func (s *ResourceDetails) SetAwsEc2SecurityGroup(v *AwsEc2SecurityGroupDetails) *ResourceDetails

SetAwsEc2SecurityGroup sets the AwsEc2SecurityGroup field's value.

func (*ResourceDetails) SetAwsEc2Subnet

func (s *ResourceDetails) SetAwsEc2Subnet(v *AwsEc2SubnetDetails) *ResourceDetails

SetAwsEc2Subnet sets the AwsEc2Subnet field's value.

func (*ResourceDetails) SetAwsEc2TransitGateway added in v1.42.9

func (s *ResourceDetails) SetAwsEc2TransitGateway(v *AwsEc2TransitGatewayDetails) *ResourceDetails

SetAwsEc2TransitGateway sets the AwsEc2TransitGateway field's value.

func (*ResourceDetails) SetAwsEc2Volume

func (s *ResourceDetails) SetAwsEc2Volume(v *AwsEc2VolumeDetails) *ResourceDetails

SetAwsEc2Volume sets the AwsEc2Volume field's value.

func (*ResourceDetails) SetAwsEc2Vpc

func (s *ResourceDetails) SetAwsEc2Vpc(v *AwsEc2VpcDetails) *ResourceDetails

SetAwsEc2Vpc sets the AwsEc2Vpc field's value.

func (*ResourceDetails) SetAwsEc2VpcEndpointService

func (s *ResourceDetails) SetAwsEc2VpcEndpointService(v *AwsEc2VpcEndpointServiceDetails) *ResourceDetails

SetAwsEc2VpcEndpointService sets the AwsEc2VpcEndpointService field's value.

func (*ResourceDetails) SetAwsEc2VpcPeeringConnection added in v1.42.9

func (s *ResourceDetails) SetAwsEc2VpcPeeringConnection(v *AwsEc2VpcPeeringConnectionDetails) *ResourceDetails

SetAwsEc2VpcPeeringConnection sets the AwsEc2VpcPeeringConnection field's value.

func (*ResourceDetails) SetAwsEc2VpnConnection

func (s *ResourceDetails) SetAwsEc2VpnConnection(v *AwsEc2VpnConnectionDetails) *ResourceDetails

SetAwsEc2VpnConnection sets the AwsEc2VpnConnection field's value.

func (*ResourceDetails) SetAwsEcrContainerImage

func (s *ResourceDetails) SetAwsEcrContainerImage(v *AwsEcrContainerImageDetails) *ResourceDetails

SetAwsEcrContainerImage sets the AwsEcrContainerImage field's value.

func (*ResourceDetails) SetAwsEcrRepository

func (s *ResourceDetails) SetAwsEcrRepository(v *AwsEcrRepositoryDetails) *ResourceDetails

SetAwsEcrRepository sets the AwsEcrRepository field's value.

func (*ResourceDetails) SetAwsEcsCluster

func (s *ResourceDetails) SetAwsEcsCluster(v *AwsEcsClusterDetails) *ResourceDetails

SetAwsEcsCluster sets the AwsEcsCluster field's value.

func (*ResourceDetails) SetAwsEcsContainer added in v1.42.9

func (s *ResourceDetails) SetAwsEcsContainer(v *AwsEcsContainerDetails) *ResourceDetails

SetAwsEcsContainer sets the AwsEcsContainer field's value.

func (*ResourceDetails) SetAwsEcsService

func (s *ResourceDetails) SetAwsEcsService(v *AwsEcsServiceDetails) *ResourceDetails

SetAwsEcsService sets the AwsEcsService field's value.

func (*ResourceDetails) SetAwsEcsTask added in v1.42.9

func (s *ResourceDetails) SetAwsEcsTask(v *AwsEcsTaskDetails) *ResourceDetails

SetAwsEcsTask sets the AwsEcsTask field's value.

func (*ResourceDetails) SetAwsEcsTaskDefinition

func (s *ResourceDetails) SetAwsEcsTaskDefinition(v *AwsEcsTaskDefinitionDetails) *ResourceDetails

SetAwsEcsTaskDefinition sets the AwsEcsTaskDefinition field's value.

func (*ResourceDetails) SetAwsEfsAccessPoint added in v1.42.9

func (s *ResourceDetails) SetAwsEfsAccessPoint(v *AwsEfsAccessPointDetails) *ResourceDetails

SetAwsEfsAccessPoint sets the AwsEfsAccessPoint field's value.

func (*ResourceDetails) SetAwsEksCluster

func (s *ResourceDetails) SetAwsEksCluster(v *AwsEksClusterDetails) *ResourceDetails

SetAwsEksCluster sets the AwsEksCluster field's value.

func (*ResourceDetails) SetAwsElasticBeanstalkEnvironment

func (s *ResourceDetails) SetAwsElasticBeanstalkEnvironment(v *AwsElasticBeanstalkEnvironmentDetails) *ResourceDetails

SetAwsElasticBeanstalkEnvironment sets the AwsElasticBeanstalkEnvironment field's value.

func (*ResourceDetails) SetAwsElasticsearchDomain

func (s *ResourceDetails) SetAwsElasticsearchDomain(v *AwsElasticsearchDomainDetails) *ResourceDetails

SetAwsElasticsearchDomain sets the AwsElasticsearchDomain field's value.

func (*ResourceDetails) SetAwsElbLoadBalancer

func (s *ResourceDetails) SetAwsElbLoadBalancer(v *AwsElbLoadBalancerDetails) *ResourceDetails

SetAwsElbLoadBalancer sets the AwsElbLoadBalancer field's value.

func (*ResourceDetails) SetAwsElbv2LoadBalancer

func (s *ResourceDetails) SetAwsElbv2LoadBalancer(v *AwsElbv2LoadBalancerDetails) *ResourceDetails

SetAwsElbv2LoadBalancer sets the AwsElbv2LoadBalancer field's value.

func (*ResourceDetails) SetAwsEventSchemasRegistry added in v1.42.9

func (s *ResourceDetails) SetAwsEventSchemasRegistry(v *AwsEventSchemasRegistryDetails) *ResourceDetails

SetAwsEventSchemasRegistry sets the AwsEventSchemasRegistry field's value.

func (*ResourceDetails) SetAwsGuardDutyDetector added in v1.42.9

func (s *ResourceDetails) SetAwsGuardDutyDetector(v *AwsGuardDutyDetectorDetails) *ResourceDetails

SetAwsGuardDutyDetector sets the AwsGuardDutyDetector field's value.

func (*ResourceDetails) SetAwsIamAccessKey

func (s *ResourceDetails) SetAwsIamAccessKey(v *AwsIamAccessKeyDetails) *ResourceDetails

SetAwsIamAccessKey sets the AwsIamAccessKey field's value.

func (*ResourceDetails) SetAwsIamGroup

func (s *ResourceDetails) SetAwsIamGroup(v *AwsIamGroupDetails) *ResourceDetails

SetAwsIamGroup sets the AwsIamGroup field's value.

func (*ResourceDetails) SetAwsIamPolicy

func (s *ResourceDetails) SetAwsIamPolicy(v *AwsIamPolicyDetails) *ResourceDetails

SetAwsIamPolicy sets the AwsIamPolicy field's value.

func (*ResourceDetails) SetAwsIamRole

func (s *ResourceDetails) SetAwsIamRole(v *AwsIamRoleDetails) *ResourceDetails

SetAwsIamRole sets the AwsIamRole field's value.

func (*ResourceDetails) SetAwsIamUser

func (s *ResourceDetails) SetAwsIamUser(v *AwsIamUserDetails) *ResourceDetails

SetAwsIamUser sets the AwsIamUser field's value.

func (*ResourceDetails) SetAwsKinesisStream added in v1.42.9

func (s *ResourceDetails) SetAwsKinesisStream(v *AwsKinesisStreamDetails) *ResourceDetails

SetAwsKinesisStream sets the AwsKinesisStream field's value.

func (*ResourceDetails) SetAwsKmsKey

func (s *ResourceDetails) SetAwsKmsKey(v *AwsKmsKeyDetails) *ResourceDetails

SetAwsKmsKey sets the AwsKmsKey field's value.

func (*ResourceDetails) SetAwsLambdaFunction

func (s *ResourceDetails) SetAwsLambdaFunction(v *AwsLambdaFunctionDetails) *ResourceDetails

SetAwsLambdaFunction sets the AwsLambdaFunction field's value.

func (*ResourceDetails) SetAwsLambdaLayerVersion

func (s *ResourceDetails) SetAwsLambdaLayerVersion(v *AwsLambdaLayerVersionDetails) *ResourceDetails

SetAwsLambdaLayerVersion sets the AwsLambdaLayerVersion field's value.

func (*ResourceDetails) SetAwsNetworkFirewallFirewall added in v1.42.9

func (s *ResourceDetails) SetAwsNetworkFirewallFirewall(v *AwsNetworkFirewallFirewallDetails) *ResourceDetails

SetAwsNetworkFirewallFirewall sets the AwsNetworkFirewallFirewall field's value.

func (*ResourceDetails) SetAwsNetworkFirewallFirewallPolicy added in v1.42.9

func (s *ResourceDetails) SetAwsNetworkFirewallFirewallPolicy(v *AwsNetworkFirewallFirewallPolicyDetails) *ResourceDetails

SetAwsNetworkFirewallFirewallPolicy sets the AwsNetworkFirewallFirewallPolicy field's value.

func (*ResourceDetails) SetAwsNetworkFirewallRuleGroup added in v1.42.9

func (s *ResourceDetails) SetAwsNetworkFirewallRuleGroup(v *AwsNetworkFirewallRuleGroupDetails) *ResourceDetails

SetAwsNetworkFirewallRuleGroup sets the AwsNetworkFirewallRuleGroup field's value.

func (*ResourceDetails) SetAwsOpenSearchServiceDomain

func (s *ResourceDetails) SetAwsOpenSearchServiceDomain(v *AwsOpenSearchServiceDomainDetails) *ResourceDetails

SetAwsOpenSearchServiceDomain sets the AwsOpenSearchServiceDomain field's value.

func (*ResourceDetails) SetAwsRdsDbCluster

func (s *ResourceDetails) SetAwsRdsDbCluster(v *AwsRdsDbClusterDetails) *ResourceDetails

SetAwsRdsDbCluster sets the AwsRdsDbCluster field's value.

func (*ResourceDetails) SetAwsRdsDbClusterSnapshot

func (s *ResourceDetails) SetAwsRdsDbClusterSnapshot(v *AwsRdsDbClusterSnapshotDetails) *ResourceDetails

SetAwsRdsDbClusterSnapshot sets the AwsRdsDbClusterSnapshot field's value.

func (*ResourceDetails) SetAwsRdsDbInstance

func (s *ResourceDetails) SetAwsRdsDbInstance(v *AwsRdsDbInstanceDetails) *ResourceDetails

SetAwsRdsDbInstance sets the AwsRdsDbInstance field's value.

func (*ResourceDetails) SetAwsRdsDbSecurityGroup added in v1.42.9

func (s *ResourceDetails) SetAwsRdsDbSecurityGroup(v *AwsRdsDbSecurityGroupDetails) *ResourceDetails

SetAwsRdsDbSecurityGroup sets the AwsRdsDbSecurityGroup field's value.

func (*ResourceDetails) SetAwsRdsDbSnapshot

func (s *ResourceDetails) SetAwsRdsDbSnapshot(v *AwsRdsDbSnapshotDetails) *ResourceDetails

SetAwsRdsDbSnapshot sets the AwsRdsDbSnapshot field's value.

func (*ResourceDetails) SetAwsRdsEventSubscription

func (s *ResourceDetails) SetAwsRdsEventSubscription(v *AwsRdsEventSubscriptionDetails) *ResourceDetails

SetAwsRdsEventSubscription sets the AwsRdsEventSubscription field's value.

func (*ResourceDetails) SetAwsRedshiftCluster

func (s *ResourceDetails) SetAwsRedshiftCluster(v *AwsRedshiftClusterDetails) *ResourceDetails

SetAwsRedshiftCluster sets the AwsRedshiftCluster field's value.

func (*ResourceDetails) SetAwsS3AccountPublicAccessBlock

func (s *ResourceDetails) SetAwsS3AccountPublicAccessBlock(v *AwsS3AccountPublicAccessBlockDetails) *ResourceDetails

SetAwsS3AccountPublicAccessBlock sets the AwsS3AccountPublicAccessBlock field's value.

func (*ResourceDetails) SetAwsS3Bucket

func (s *ResourceDetails) SetAwsS3Bucket(v *AwsS3BucketDetails) *ResourceDetails

SetAwsS3Bucket sets the AwsS3Bucket field's value.

func (*ResourceDetails) SetAwsS3Object

func (s *ResourceDetails) SetAwsS3Object(v *AwsS3ObjectDetails) *ResourceDetails

SetAwsS3Object sets the AwsS3Object field's value.

func (*ResourceDetails) SetAwsSageMakerNotebookInstance added in v1.42.9

func (s *ResourceDetails) SetAwsSageMakerNotebookInstance(v *AwsSageMakerNotebookInstanceDetails) *ResourceDetails

SetAwsSageMakerNotebookInstance sets the AwsSageMakerNotebookInstance field's value.

func (*ResourceDetails) SetAwsSecretsManagerSecret

func (s *ResourceDetails) SetAwsSecretsManagerSecret(v *AwsSecretsManagerSecretDetails) *ResourceDetails

SetAwsSecretsManagerSecret sets the AwsSecretsManagerSecret field's value.

func (*ResourceDetails) SetAwsSnsTopic

func (s *ResourceDetails) SetAwsSnsTopic(v *AwsSnsTopicDetails) *ResourceDetails

SetAwsSnsTopic sets the AwsSnsTopic field's value.

func (*ResourceDetails) SetAwsSqsQueue

func (s *ResourceDetails) SetAwsSqsQueue(v *AwsSqsQueueDetails) *ResourceDetails

SetAwsSqsQueue sets the AwsSqsQueue field's value.

func (*ResourceDetails) SetAwsSsmPatchCompliance

func (s *ResourceDetails) SetAwsSsmPatchCompliance(v *AwsSsmPatchComplianceDetails) *ResourceDetails

SetAwsSsmPatchCompliance sets the AwsSsmPatchCompliance field's value.

func (*ResourceDetails) SetAwsStepFunctionStateMachine added in v1.42.9

func (s *ResourceDetails) SetAwsStepFunctionStateMachine(v *AwsStepFunctionStateMachineDetails) *ResourceDetails

SetAwsStepFunctionStateMachine sets the AwsStepFunctionStateMachine field's value.

func (*ResourceDetails) SetAwsWafRateBasedRule

func (s *ResourceDetails) SetAwsWafRateBasedRule(v *AwsWafRateBasedRuleDetails) *ResourceDetails

SetAwsWafRateBasedRule sets the AwsWafRateBasedRule field's value.

func (*ResourceDetails) SetAwsWafRegionalRateBasedRule

func (s *ResourceDetails) SetAwsWafRegionalRateBasedRule(v *AwsWafRegionalRateBasedRuleDetails) *ResourceDetails

SetAwsWafRegionalRateBasedRule sets the AwsWafRegionalRateBasedRule field's value.

func (*ResourceDetails) SetAwsWafRegionalRule added in v1.42.9

func (s *ResourceDetails) SetAwsWafRegionalRule(v *AwsWafRegionalRuleDetails) *ResourceDetails

SetAwsWafRegionalRule sets the AwsWafRegionalRule field's value.

func (*ResourceDetails) SetAwsWafRegionalRuleGroup added in v1.42.9

func (s *ResourceDetails) SetAwsWafRegionalRuleGroup(v *AwsWafRegionalRuleGroupDetails) *ResourceDetails

SetAwsWafRegionalRuleGroup sets the AwsWafRegionalRuleGroup field's value.

func (*ResourceDetails) SetAwsWafRegionalWebAcl added in v1.42.9

func (s *ResourceDetails) SetAwsWafRegionalWebAcl(v *AwsWafRegionalWebAclDetails) *ResourceDetails

SetAwsWafRegionalWebAcl sets the AwsWafRegionalWebAcl field's value.

func (*ResourceDetails) SetAwsWafRule added in v1.42.9

func (s *ResourceDetails) SetAwsWafRule(v *AwsWafRuleDetails) *ResourceDetails

SetAwsWafRule sets the AwsWafRule field's value.

func (*ResourceDetails) SetAwsWafRuleGroup added in v1.42.9

func (s *ResourceDetails) SetAwsWafRuleGroup(v *AwsWafRuleGroupDetails) *ResourceDetails

SetAwsWafRuleGroup sets the AwsWafRuleGroup field's value.

func (*ResourceDetails) SetAwsWafWebAcl

func (s *ResourceDetails) SetAwsWafWebAcl(v *AwsWafWebAclDetails) *ResourceDetails

SetAwsWafWebAcl sets the AwsWafWebAcl field's value.

func (*ResourceDetails) SetAwsWafv2RuleGroup added in v1.42.9

func (s *ResourceDetails) SetAwsWafv2RuleGroup(v *AwsWafv2RuleGroupDetails) *ResourceDetails

SetAwsWafv2RuleGroup sets the AwsWafv2RuleGroup field's value.

func (*ResourceDetails) SetAwsWafv2WebAcl added in v1.42.9

func (s *ResourceDetails) SetAwsWafv2WebAcl(v *AwsWafv2WebAclDetails) *ResourceDetails

SetAwsWafv2WebAcl sets the AwsWafv2WebAcl field's value.

func (*ResourceDetails) SetAwsXrayEncryptionConfig

func (s *ResourceDetails) SetAwsXrayEncryptionConfig(v *AwsXrayEncryptionConfigDetails) *ResourceDetails

SetAwsXrayEncryptionConfig sets the AwsXrayEncryptionConfig field's value.

func (*ResourceDetails) SetContainer

func (s *ResourceDetails) SetContainer(v *ContainerDetails) *ResourceDetails

SetContainer sets the Container field's value.

func (*ResourceDetails) SetOther

func (s *ResourceDetails) SetOther(v map[string]*string) *ResourceDetails

SetOther sets the Other field's value.

func (ResourceDetails) String

func (s ResourceDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceDetails) Validate

func (s *ResourceDetails) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request was rejected because we can't find the specified resource.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Result

type Result struct {

	// An Amazon Web Services account ID of the account that was not processed.
	AccountId *string `type:"string"`

	// The reason that the account was not processed.
	ProcessingResult *string `type:"string"`
	// contains filtered or unexported fields
}

Details about the account that was not processed.

func (Result) GoString

func (s Result) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Result) SetAccountId

func (s *Result) SetAccountId(v string) *Result

SetAccountId sets the AccountId field's value.

func (*Result) SetProcessingResult

func (s *Result) SetProcessingResult(v string) *Result

SetProcessingResult sets the ProcessingResult field's value.

func (Result) String

func (s Result) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RouteSetDetails added in v1.42.9

type RouteSetDetails struct {

	// The ID of the carrier gateway.
	CarrierGatewayId *string `type:"string"`

	// The Amazon Resource Name (ARN) of the core network.
	CoreNetworkArn *string `type:"string"`

	// The IPv4 CIDR block used for the destination match.
	DestinationCidrBlock *string `type:"string"`

	// The IPv6 CIDR block used for the destination match.
	DestinationIpv6CidrBlock *string `type:"string"`

	// The prefix of the destination Amazon Web Service.
	DestinationPrefixListId *string `type:"string"`

	// The ID of the egress-only internet gateway.
	EgressOnlyInternetGatewayId *string `type:"string"`

	// The ID of a gateway attached to your VPC.
	GatewayId *string `type:"string"`

	// The ID of a NAT instance in your VPC.
	InstanceId *string `type:"string"`

	// The ID of the Amazon Web Services account that owns the instance.
	InstanceOwnerId *string `type:"string"`

	// The ID of the local gateway.
	LocalGatewayId *string `type:"string"`

	// The ID of a NAT gateway.
	NatGatewayId *string `type:"string"`

	// The ID of the network interface.
	NetworkInterfaceId *string `type:"string"`

	// Describes how the route was created.
	Origin *string `type:"string"`

	// The state of the route.
	State *string `type:"string"`

	// The ID of a transit gateway.
	TransitGatewayId *string `type:"string"`

	// The ID of a VPC peering connection.
	VpcPeeringConnectionId *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the routes in the route table.

func (RouteSetDetails) GoString added in v1.42.9

func (s RouteSetDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RouteSetDetails) SetCarrierGatewayId added in v1.42.9

func (s *RouteSetDetails) SetCarrierGatewayId(v string) *RouteSetDetails

SetCarrierGatewayId sets the CarrierGatewayId field's value.

func (*RouteSetDetails) SetCoreNetworkArn added in v1.42.9

func (s *RouteSetDetails) SetCoreNetworkArn(v string) *RouteSetDetails

SetCoreNetworkArn sets the CoreNetworkArn field's value.

func (*RouteSetDetails) SetDestinationCidrBlock added in v1.42.9

func (s *RouteSetDetails) SetDestinationCidrBlock(v string) *RouteSetDetails

SetDestinationCidrBlock sets the DestinationCidrBlock field's value.

func (*RouteSetDetails) SetDestinationIpv6CidrBlock added in v1.42.9

func (s *RouteSetDetails) SetDestinationIpv6CidrBlock(v string) *RouteSetDetails

SetDestinationIpv6CidrBlock sets the DestinationIpv6CidrBlock field's value.

func (*RouteSetDetails) SetDestinationPrefixListId added in v1.42.9

func (s *RouteSetDetails) SetDestinationPrefixListId(v string) *RouteSetDetails

SetDestinationPrefixListId sets the DestinationPrefixListId field's value.

func (*RouteSetDetails) SetEgressOnlyInternetGatewayId added in v1.42.9

func (s *RouteSetDetails) SetEgressOnlyInternetGatewayId(v string) *RouteSetDetails

SetEgressOnlyInternetGatewayId sets the EgressOnlyInternetGatewayId field's value.

func (*RouteSetDetails) SetGatewayId added in v1.42.9

func (s *RouteSetDetails) SetGatewayId(v string) *RouteSetDetails

SetGatewayId sets the GatewayId field's value.

func (*RouteSetDetails) SetInstanceId added in v1.42.9

func (s *RouteSetDetails) SetInstanceId(v string) *RouteSetDetails

SetInstanceId sets the InstanceId field's value.

func (*RouteSetDetails) SetInstanceOwnerId added in v1.42.9

func (s *RouteSetDetails) SetInstanceOwnerId(v string) *RouteSetDetails

SetInstanceOwnerId sets the InstanceOwnerId field's value.

func (*RouteSetDetails) SetLocalGatewayId added in v1.42.9

func (s *RouteSetDetails) SetLocalGatewayId(v string) *RouteSetDetails

SetLocalGatewayId sets the LocalGatewayId field's value.

func (*RouteSetDetails) SetNatGatewayId added in v1.42.9

func (s *RouteSetDetails) SetNatGatewayId(v string) *RouteSetDetails

SetNatGatewayId sets the NatGatewayId field's value.

func (*RouteSetDetails) SetNetworkInterfaceId added in v1.42.9

func (s *RouteSetDetails) SetNetworkInterfaceId(v string) *RouteSetDetails

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (*RouteSetDetails) SetOrigin added in v1.42.9

func (s *RouteSetDetails) SetOrigin(v string) *RouteSetDetails

SetOrigin sets the Origin field's value.

func (*RouteSetDetails) SetState added in v1.42.9

func (s *RouteSetDetails) SetState(v string) *RouteSetDetails

SetState sets the State field's value.

func (*RouteSetDetails) SetTransitGatewayId added in v1.42.9

func (s *RouteSetDetails) SetTransitGatewayId(v string) *RouteSetDetails

SetTransitGatewayId sets the TransitGatewayId field's value.

func (*RouteSetDetails) SetVpcPeeringConnectionId added in v1.42.9

func (s *RouteSetDetails) SetVpcPeeringConnectionId(v string) *RouteSetDetails

SetVpcPeeringConnectionId sets the VpcPeeringConnectionId field's value.

func (RouteSetDetails) String added in v1.42.9

func (s RouteSetDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupDetails added in v1.42.9

type RuleGroupDetails struct {

	// Additional settings to use in the specified rules.
	RuleVariables *RuleGroupVariables `type:"structure"`

	// The rules and actions for the rule group.
	//
	// For stateful rule groups, can contain RulesString, RulesSourceList, or StatefulRules.
	//
	// For stateless rule groups, contains StatelessRulesAndCustomActions.
	RulesSource *RuleGroupSource `type:"structure"`
	// contains filtered or unexported fields
}

Details about the rule group.

func (RuleGroupDetails) GoString added in v1.42.9

func (s RuleGroupDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupDetails) SetRuleVariables added in v1.42.9

func (s *RuleGroupDetails) SetRuleVariables(v *RuleGroupVariables) *RuleGroupDetails

SetRuleVariables sets the RuleVariables field's value.

func (*RuleGroupDetails) SetRulesSource added in v1.42.9

func (s *RuleGroupDetails) SetRulesSource(v *RuleGroupSource) *RuleGroupDetails

SetRulesSource sets the RulesSource field's value.

func (RuleGroupDetails) String added in v1.42.9

func (s RuleGroupDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupSource added in v1.42.9

type RuleGroupSource struct {

	// Stateful inspection criteria for a domain list rule group. A domain list
	// rule group determines access by specific protocols to specific domains.
	RulesSourceList *RuleGroupSourceListDetails `type:"structure"`

	// Stateful inspection criteria, provided in Suricata compatible intrusion prevention
	// system (IPS) rules.
	RulesString *string `type:"string"`

	// Suricata rule specifications.
	StatefulRules []*RuleGroupSourceStatefulRulesDetails `type:"list"`

	// The stateless rules and custom actions used by a stateless rule group.
	StatelessRulesAndCustomActions *RuleGroupSourceStatelessRulesAndCustomActionsDetails `type:"structure"`
	// contains filtered or unexported fields
}

The rules and actions for the rule group.

func (RuleGroupSource) GoString added in v1.42.9

func (s RuleGroupSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupSource) SetRulesSourceList added in v1.42.9

func (s *RuleGroupSource) SetRulesSourceList(v *RuleGroupSourceListDetails) *RuleGroupSource

SetRulesSourceList sets the RulesSourceList field's value.

func (*RuleGroupSource) SetRulesString added in v1.42.9

func (s *RuleGroupSource) SetRulesString(v string) *RuleGroupSource

SetRulesString sets the RulesString field's value.

func (*RuleGroupSource) SetStatefulRules added in v1.42.9

SetStatefulRules sets the StatefulRules field's value.

func (*RuleGroupSource) SetStatelessRulesAndCustomActions added in v1.42.9

SetStatelessRulesAndCustomActions sets the StatelessRulesAndCustomActions field's value.

func (RuleGroupSource) String added in v1.42.9

func (s RuleGroupSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupSourceCustomActionsDetails added in v1.42.9

type RuleGroupSourceCustomActionsDetails struct {

	// The definition of a custom action.
	ActionDefinition *StatelessCustomActionDefinition `type:"structure"`

	// A descriptive name of the custom action.
	ActionName *string `type:"string"`
	// contains filtered or unexported fields
}

A custom action definition. A custom action is an optional, non-standard action to use for stateless packet handling.

func (RuleGroupSourceCustomActionsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupSourceCustomActionsDetails) SetActionDefinition added in v1.42.9

SetActionDefinition sets the ActionDefinition field's value.

func (*RuleGroupSourceCustomActionsDetails) SetActionName added in v1.42.9

SetActionName sets the ActionName field's value.

func (RuleGroupSourceCustomActionsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupSourceListDetails added in v1.42.9

type RuleGroupSourceListDetails struct {

	// Indicates whether to allow or deny access to the domains listed in Targets.
	GeneratedRulesType *string `type:"string"`

	// The protocols that you want to inspect. Specify LS_SNI for HTTPS. Specify
	// HTTP_HOST for HTTP. You can specify either or both.
	TargetTypes []*string `type:"list"`

	// The domains that you want to inspect for in your traffic flows. You can provide
	// full domain names, or use the '.' prefix as a wildcard. For example, .example.com
	// matches all domains that end with example.com.
	Targets []*string `type:"list"`
	// contains filtered or unexported fields
}

Stateful inspection criteria for a domain list rule group.

func (RuleGroupSourceListDetails) GoString added in v1.42.9

func (s RuleGroupSourceListDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupSourceListDetails) SetGeneratedRulesType added in v1.42.9

func (s *RuleGroupSourceListDetails) SetGeneratedRulesType(v string) *RuleGroupSourceListDetails

SetGeneratedRulesType sets the GeneratedRulesType field's value.

func (*RuleGroupSourceListDetails) SetTargetTypes added in v1.42.9

SetTargetTypes sets the TargetTypes field's value.

func (*RuleGroupSourceListDetails) SetTargets added in v1.42.9

SetTargets sets the Targets field's value.

func (RuleGroupSourceListDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupSourceStatefulRulesDetails added in v1.42.9

type RuleGroupSourceStatefulRulesDetails struct {

	// Defines what Network Firewall should do with the packets in a traffic flow
	// when the flow matches the stateful rule criteria.
	Action *string `type:"string"`

	// The stateful inspection criteria for the rule.
	Header *RuleGroupSourceStatefulRulesHeaderDetails `type:"structure"`

	// Additional options for the rule.
	RuleOptions []*RuleGroupSourceStatefulRulesOptionsDetails `type:"list"`
	// contains filtered or unexported fields
}

A Suricata rule specification.

func (RuleGroupSourceStatefulRulesDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupSourceStatefulRulesDetails) SetAction added in v1.42.9

SetAction sets the Action field's value.

func (*RuleGroupSourceStatefulRulesDetails) SetHeader added in v1.42.9

SetHeader sets the Header field's value.

func (*RuleGroupSourceStatefulRulesDetails) SetRuleOptions added in v1.42.9

SetRuleOptions sets the RuleOptions field's value.

func (RuleGroupSourceStatefulRulesDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupSourceStatefulRulesHeaderDetails added in v1.42.9

type RuleGroupSourceStatefulRulesHeaderDetails struct {

	// The destination IP address or address range to inspect for, in CIDR notation.
	// To match with any address, specify ANY.
	Destination *string `type:"string"`

	// The destination port to inspect for. You can specify an individual port,
	// such as 1994. You also can specify a port range, such as 1990:1994. To match
	// with any port, specify ANY.
	DestinationPort *string `type:"string"`

	// The direction of traffic flow to inspect. If set to ANY, the inspection matches
	// bidirectional traffic, both from the source to the destination and from the
	// destination to the source. If set to FORWARD, the inspection only matches
	// traffic going from the source to the destination.
	Direction *string `type:"string"`

	// The protocol to inspect for. To inspector for all protocols, use IP.
	Protocol *string `type:"string"`

	// The source IP address or address range to inspect for, in CIDR notation.
	// To match with any address, specify ANY.
	Source *string `type:"string"`

	// The source port to inspect for. You can specify an individual port, such
	// as 1994. You also can specify a port range, such as 1990:1994. To match with
	// any port, specify ANY.
	SourcePort *string `type:"string"`
	// contains filtered or unexported fields
}

The inspection criteria for a stateful rule.

func (RuleGroupSourceStatefulRulesHeaderDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupSourceStatefulRulesHeaderDetails) SetDestination added in v1.42.9

SetDestination sets the Destination field's value.

func (*RuleGroupSourceStatefulRulesHeaderDetails) SetDestinationPort added in v1.42.9

SetDestinationPort sets the DestinationPort field's value.

func (*RuleGroupSourceStatefulRulesHeaderDetails) SetDirection added in v1.42.9

SetDirection sets the Direction field's value.

func (*RuleGroupSourceStatefulRulesHeaderDetails) SetProtocol added in v1.42.9

SetProtocol sets the Protocol field's value.

func (*RuleGroupSourceStatefulRulesHeaderDetails) SetSource added in v1.42.9

SetSource sets the Source field's value.

func (*RuleGroupSourceStatefulRulesHeaderDetails) SetSourcePort added in v1.42.9

SetSourcePort sets the SourcePort field's value.

func (RuleGroupSourceStatefulRulesHeaderDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupSourceStatefulRulesOptionsDetails added in v1.42.9

type RuleGroupSourceStatefulRulesOptionsDetails struct {

	// A keyword to look for.
	Keyword *string `type:"string"`

	// A list of settings.
	Settings []*string `type:"list"`
	// contains filtered or unexported fields
}

A rule option for a stateful rule.

func (RuleGroupSourceStatefulRulesOptionsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupSourceStatefulRulesOptionsDetails) SetKeyword added in v1.42.9

SetKeyword sets the Keyword field's value.

func (*RuleGroupSourceStatefulRulesOptionsDetails) SetSettings added in v1.42.9

SetSettings sets the Settings field's value.

func (RuleGroupSourceStatefulRulesOptionsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupSourceStatelessRuleDefinition added in v1.42.9

type RuleGroupSourceStatelessRuleDefinition struct {

	// The actions to take on a packet that matches one of the stateless rule definition's
	// match attributes. You must specify a standard action (aws:pass, aws:drop,
	// or aws:forward_to_sfe). You can then add custom actions.
	Actions []*string `type:"list"`

	// The criteria for Network Firewall to use to inspect an individual packet
	// in a stateless rule inspection.
	MatchAttributes *RuleGroupSourceStatelessRuleMatchAttributes `type:"structure"`
	// contains filtered or unexported fields
}

The definition of the stateless rule.

func (RuleGroupSourceStatelessRuleDefinition) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupSourceStatelessRuleDefinition) SetActions added in v1.42.9

SetActions sets the Actions field's value.

func (*RuleGroupSourceStatelessRuleDefinition) SetMatchAttributes added in v1.42.9

SetMatchAttributes sets the MatchAttributes field's value.

func (RuleGroupSourceStatelessRuleDefinition) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupSourceStatelessRuleMatchAttributes added in v1.42.9

type RuleGroupSourceStatelessRuleMatchAttributes struct {

	// A list of port ranges to specify the destination ports to inspect for.
	DestinationPorts []*RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts `type:"list"`

	// The destination IP addresses and address ranges to inspect for, in CIDR notation.
	Destinations []*RuleGroupSourceStatelessRuleMatchAttributesDestinations `type:"list"`

	// The protocols to inspect for.
	Protocols []*int64 `type:"list"`

	// A list of port ranges to specify the source ports to inspect for.
	SourcePorts []*RuleGroupSourceStatelessRuleMatchAttributesSourcePorts `type:"list"`

	// The source IP addresses and address ranges to inspect for, in CIDR notation.
	Sources []*RuleGroupSourceStatelessRuleMatchAttributesSources `type:"list"`

	// The TCP flags and masks to inspect for.
	TcpFlags []*RuleGroupSourceStatelessRuleMatchAttributesTcpFlags `type:"list"`
	// contains filtered or unexported fields
}

Criteria for the stateless rule.

func (RuleGroupSourceStatelessRuleMatchAttributes) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupSourceStatelessRuleMatchAttributes) SetDestinationPorts added in v1.42.9

SetDestinationPorts sets the DestinationPorts field's value.

func (*RuleGroupSourceStatelessRuleMatchAttributes) SetDestinations added in v1.42.9

SetDestinations sets the Destinations field's value.

func (*RuleGroupSourceStatelessRuleMatchAttributes) SetProtocols added in v1.42.9

SetProtocols sets the Protocols field's value.

func (*RuleGroupSourceStatelessRuleMatchAttributes) SetSourcePorts added in v1.42.9

SetSourcePorts sets the SourcePorts field's value.

func (*RuleGroupSourceStatelessRuleMatchAttributes) SetSources added in v1.42.9

SetSources sets the Sources field's value.

func (*RuleGroupSourceStatelessRuleMatchAttributes) SetTcpFlags added in v1.42.9

SetTcpFlags sets the TcpFlags field's value.

func (RuleGroupSourceStatelessRuleMatchAttributes) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts added in v1.42.9

type RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts struct {

	// The starting port value for the port range.
	FromPort *int64 `type:"integer"`

	// The ending port value for the port range.
	ToPort *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A port range to specify the destination ports to inspect for.

func (RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts) SetFromPort added in v1.42.9

SetFromPort sets the FromPort field's value.

func (*RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts) SetToPort added in v1.42.9

SetToPort sets the ToPort field's value.

func (RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupSourceStatelessRuleMatchAttributesDestinations added in v1.42.9

type RuleGroupSourceStatelessRuleMatchAttributesDestinations struct {

	// An IP address or a block of IP addresses.
	AddressDefinition *string `type:"string"`
	// contains filtered or unexported fields
}

A destination IP address or range.

func (RuleGroupSourceStatelessRuleMatchAttributesDestinations) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupSourceStatelessRuleMatchAttributesDestinations) SetAddressDefinition added in v1.42.9

SetAddressDefinition sets the AddressDefinition field's value.

func (RuleGroupSourceStatelessRuleMatchAttributesDestinations) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupSourceStatelessRuleMatchAttributesSourcePorts added in v1.42.9

type RuleGroupSourceStatelessRuleMatchAttributesSourcePorts struct {

	// The starting port value for the port range.
	FromPort *int64 `type:"integer"`

	// The ending port value for the port range.
	ToPort *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A port range to specify the source ports to inspect for.

func (RuleGroupSourceStatelessRuleMatchAttributesSourcePorts) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupSourceStatelessRuleMatchAttributesSourcePorts) SetFromPort added in v1.42.9

SetFromPort sets the FromPort field's value.

func (*RuleGroupSourceStatelessRuleMatchAttributesSourcePorts) SetToPort added in v1.42.9

SetToPort sets the ToPort field's value.

func (RuleGroupSourceStatelessRuleMatchAttributesSourcePorts) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupSourceStatelessRuleMatchAttributesSources added in v1.42.9

type RuleGroupSourceStatelessRuleMatchAttributesSources struct {

	// An IP address or a block of IP addresses.
	AddressDefinition *string `type:"string"`
	// contains filtered or unexported fields
}

A source IP addresses and address range to inspect for.

func (RuleGroupSourceStatelessRuleMatchAttributesSources) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupSourceStatelessRuleMatchAttributesSources) SetAddressDefinition added in v1.42.9

SetAddressDefinition sets the AddressDefinition field's value.

func (RuleGroupSourceStatelessRuleMatchAttributesSources) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupSourceStatelessRuleMatchAttributesTcpFlags added in v1.42.9

type RuleGroupSourceStatelessRuleMatchAttributesTcpFlags struct {

	// Defines the flags from the Masks setting that must be set in order for the
	// packet to match. Flags that are listed must be set. Flags that are not listed
	// must not be set.
	Flags []*string `type:"list"`

	// The set of flags to consider in the inspection. If not specified, then all
	// flags are inspected.
	Masks []*string `type:"list"`
	// contains filtered or unexported fields
}

A set of TCP flags and masks to inspect for.

func (RuleGroupSourceStatelessRuleMatchAttributesTcpFlags) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupSourceStatelessRuleMatchAttributesTcpFlags) SetFlags added in v1.42.9

SetFlags sets the Flags field's value.

func (*RuleGroupSourceStatelessRuleMatchAttributesTcpFlags) SetMasks added in v1.42.9

SetMasks sets the Masks field's value.

func (RuleGroupSourceStatelessRuleMatchAttributesTcpFlags) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupSourceStatelessRulesAndCustomActionsDetails added in v1.42.9

type RuleGroupSourceStatelessRulesAndCustomActionsDetails struct {

	// Custom actions for the rule group.
	CustomActions []*RuleGroupSourceCustomActionsDetails `type:"list"`

	// Stateless rules for the rule group.
	StatelessRules []*RuleGroupSourceStatelessRulesDetails `type:"list"`
	// contains filtered or unexported fields
}

Stateless rules and custom actions for a stateless rule group.

func (RuleGroupSourceStatelessRulesAndCustomActionsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupSourceStatelessRulesAndCustomActionsDetails) SetCustomActions added in v1.42.9

SetCustomActions sets the CustomActions field's value.

func (*RuleGroupSourceStatelessRulesAndCustomActionsDetails) SetStatelessRules added in v1.42.9

SetStatelessRules sets the StatelessRules field's value.

func (RuleGroupSourceStatelessRulesAndCustomActionsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupSourceStatelessRulesDetails added in v1.42.9

type RuleGroupSourceStatelessRulesDetails struct {

	// Indicates the order in which to run this rule relative to all of the rules
	// in the stateless rule group.
	Priority *int64 `type:"integer"`

	// Provides the definition of the stateless rule.
	RuleDefinition *RuleGroupSourceStatelessRuleDefinition `type:"structure"`
	// contains filtered or unexported fields
}

A stateless rule in the rule group.

func (RuleGroupSourceStatelessRulesDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupSourceStatelessRulesDetails) SetPriority added in v1.42.9

SetPriority sets the Priority field's value.

func (*RuleGroupSourceStatelessRulesDetails) SetRuleDefinition added in v1.42.9

SetRuleDefinition sets the RuleDefinition field's value.

func (RuleGroupSourceStatelessRulesDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupVariables added in v1.42.9

type RuleGroupVariables struct {

	// A list of IP addresses and address ranges, in CIDR notation.
	IpSets *RuleGroupVariablesIpSetsDetails `type:"structure"`

	// A list of port ranges.
	PortSets *RuleGroupVariablesPortSetsDetails `type:"structure"`
	// contains filtered or unexported fields
}

Additional settings to use in the specified rules.

func (RuleGroupVariables) GoString added in v1.42.9

func (s RuleGroupVariables) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupVariables) SetIpSets added in v1.42.9

SetIpSets sets the IpSets field's value.

func (*RuleGroupVariables) SetPortSets added in v1.42.9

SetPortSets sets the PortSets field's value.

func (RuleGroupVariables) String added in v1.42.9

func (s RuleGroupVariables) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupVariablesIpSetsDetails added in v1.42.9

type RuleGroupVariablesIpSetsDetails struct {

	// The list of IP addresses and ranges.
	Definition []*string `type:"list"`
	// contains filtered or unexported fields
}

A list of IP addresses and address ranges, in CIDR notation.

func (RuleGroupVariablesIpSetsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupVariablesIpSetsDetails) SetDefinition added in v1.42.9

SetDefinition sets the Definition field's value.

func (RuleGroupVariablesIpSetsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupVariablesPortSetsDetails added in v1.42.9

type RuleGroupVariablesPortSetsDetails struct {

	// The list of port ranges.
	Definition []*string `type:"list"`
	// contains filtered or unexported fields
}

A list of port ranges.

func (RuleGroupVariablesPortSetsDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupVariablesPortSetsDetails) SetDefinition added in v1.42.9

SetDefinition sets the Definition field's value.

func (RuleGroupVariablesPortSetsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SecurityControl added in v1.42.9

type SecurityControl struct {

	// The description of a security control across standards. This typically summarizes
	// how Security Hub evaluates the control and the conditions under which it
	// produces a failed finding. This parameter doesn't reference a specific standard.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// A link to Security Hub documentation that explains how to remediate a failed
	// finding for a security control.
	//
	// RemediationUrl is a required field
	RemediationUrl *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) for a security control across standards, such
	// as arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This
	// parameter doesn't mention a specific standard.
	//
	// SecurityControlArn is a required field
	SecurityControlArn *string `type:"string" required:"true"`

	// The unique identifier of a security control across standards. Values for
	// this field typically consist of an Amazon Web Service name and a number,
	// such as APIGateway.3.
	//
	// SecurityControlId is a required field
	SecurityControlId *string `type:"string" required:"true"`

	// The enablement status of a security control in a specific standard.
	//
	// SecurityControlStatus is a required field
	SecurityControlStatus *string `type:"string" required:"true" enum:"ControlStatus"`

	// The severity of a security control. For more information about how Security
	// Hub determines control severity, see Assigning severity to control findings
	// (https://docs.aws.amazon.com/securityhub/latest/userguide/controls-findings-create-update.html#control-findings-severity)
	// in the Security Hub User Guide.
	//
	// SeverityRating is a required field
	SeverityRating *string `type:"string" required:"true" enum:"SeverityRating"`

	// The title of a security control.
	//
	// Title is a required field
	Title *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A security control in Security Hub describes a security best practice related to a specific resource.

func (SecurityControl) GoString added in v1.42.9

func (s SecurityControl) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SecurityControl) SetDescription added in v1.42.9

func (s *SecurityControl) SetDescription(v string) *SecurityControl

SetDescription sets the Description field's value.

func (*SecurityControl) SetRemediationUrl added in v1.42.9

func (s *SecurityControl) SetRemediationUrl(v string) *SecurityControl

SetRemediationUrl sets the RemediationUrl field's value.

func (*SecurityControl) SetSecurityControlArn added in v1.42.9

func (s *SecurityControl) SetSecurityControlArn(v string) *SecurityControl

SetSecurityControlArn sets the SecurityControlArn field's value.

func (*SecurityControl) SetSecurityControlId added in v1.42.9

func (s *SecurityControl) SetSecurityControlId(v string) *SecurityControl

SetSecurityControlId sets the SecurityControlId field's value.

func (*SecurityControl) SetSecurityControlStatus added in v1.42.9

func (s *SecurityControl) SetSecurityControlStatus(v string) *SecurityControl

SetSecurityControlStatus sets the SecurityControlStatus field's value.

func (*SecurityControl) SetSeverityRating added in v1.42.9

func (s *SecurityControl) SetSeverityRating(v string) *SecurityControl

SetSeverityRating sets the SeverityRating field's value.

func (*SecurityControl) SetTitle added in v1.42.9

func (s *SecurityControl) SetTitle(v string) *SecurityControl

SetTitle sets the Title field's value.

func (SecurityControl) String added in v1.42.9

func (s SecurityControl) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SecurityControlDefinition added in v1.42.9

type SecurityControlDefinition struct {

	// Specifies whether a security control is available in the current Amazon Web
	// Services Region.
	//
	// CurrentRegionAvailability is a required field
	CurrentRegionAvailability *string `type:"string" required:"true" enum:"RegionAvailabilityStatus"`

	// The description of a security control across standards. This typically summarizes
	// how Security Hub evaluates the control and the conditions under which it
	// produces a failed finding. This parameter doesn't reference a specific standard.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// A link to Security Hub documentation that explains how to remediate a failed
	// finding for a security control.
	//
	// RemediationUrl is a required field
	RemediationUrl *string `type:"string" required:"true"`

	// The unique identifier of a security control across standards. Values for
	// this field typically consist of an Amazon Web Service name and a number (for
	// example, APIGateway.3). This parameter differs from SecurityControlArn, which
	// is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references
	// the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).
	//
	// SecurityControlId is a required field
	SecurityControlId *string `type:"string" required:"true"`

	// The severity of a security control. For more information about how Security
	// Hub determines control severity, see Assigning severity to control findings
	// (https://docs.aws.amazon.com/securityhub/latest/userguide/controls-findings-create-update.html#control-findings-severity)
	// in the Security Hub User Guide.
	//
	// SeverityRating is a required field
	SeverityRating *string `type:"string" required:"true" enum:"SeverityRating"`

	// The title of a security control.
	//
	// Title is a required field
	Title *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides metadata for a security control, including its unique standard-agnostic identifier, title, description, severity, availability in Amazon Web Services Regions, and a link to remediation steps.

func (SecurityControlDefinition) GoString added in v1.42.9

func (s SecurityControlDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SecurityControlDefinition) SetCurrentRegionAvailability added in v1.42.9

func (s *SecurityControlDefinition) SetCurrentRegionAvailability(v string) *SecurityControlDefinition

SetCurrentRegionAvailability sets the CurrentRegionAvailability field's value.

func (*SecurityControlDefinition) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*SecurityControlDefinition) SetRemediationUrl added in v1.42.9

SetRemediationUrl sets the RemediationUrl field's value.

func (*SecurityControlDefinition) SetSecurityControlId added in v1.42.9

func (s *SecurityControlDefinition) SetSecurityControlId(v string) *SecurityControlDefinition

SetSecurityControlId sets the SecurityControlId field's value.

func (*SecurityControlDefinition) SetSeverityRating added in v1.42.9

SetSeverityRating sets the SeverityRating field's value.

func (*SecurityControlDefinition) SetTitle added in v1.42.9

SetTitle sets the Title field's value.

func (SecurityControlDefinition) String added in v1.42.9

func (s SecurityControlDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SecurityHub

type SecurityHub struct {
	*client.Client
}

SecurityHub provides the API operation methods for making requests to AWS SecurityHub. See this package's package overview docs for details on the service.

SecurityHub methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *SecurityHub

New creates a new instance of the SecurityHub client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a SecurityHub client from just a session.
svc := securityhub.New(mySession)

// Create a SecurityHub client with additional configuration
svc := securityhub.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*SecurityHub) AcceptAdministratorInvitation

func (c *SecurityHub) AcceptAdministratorInvitation(input *AcceptAdministratorInvitationInput) (*AcceptAdministratorInvitationOutput, error)

AcceptAdministratorInvitation API operation for AWS SecurityHub.

Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from.

This operation is only used by member accounts that are not added through Organizations.

When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation AcceptAdministratorInvitation for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

  • InvalidAccessException The account doesn't have permission to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AcceptAdministratorInvitation

Example (Shared00)

To accept an invitation be a member account The following example demonstrates how an account can accept an invitation from the Security Hub administrator account to be a member account. This operation is applicable only to member accounts that are not added through AWS Organizations.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.AcceptAdministratorInvitationInput{
		AdministratorId: aws.String("123456789012"),
		InvitationId:    aws.String("7ab938c5d52d7904ad09f9e7c20cc4eb"),
	}

	result, err := svc.AcceptAdministratorInvitation(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) AcceptAdministratorInvitationRequest

func (c *SecurityHub) AcceptAdministratorInvitationRequest(input *AcceptAdministratorInvitationInput) (req *request.Request, output *AcceptAdministratorInvitationOutput)

AcceptAdministratorInvitationRequest generates a "aws/request.Request" representing the client's request for the AcceptAdministratorInvitation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AcceptAdministratorInvitation for more information on using the AcceptAdministratorInvitation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AcceptAdministratorInvitationRequest method.
req, resp := client.AcceptAdministratorInvitationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AcceptAdministratorInvitation

func (*SecurityHub) AcceptAdministratorInvitationWithContext

func (c *SecurityHub) AcceptAdministratorInvitationWithContext(ctx aws.Context, input *AcceptAdministratorInvitationInput, opts ...request.Option) (*AcceptAdministratorInvitationOutput, error)

AcceptAdministratorInvitationWithContext is the same as AcceptAdministratorInvitation with the addition of the ability to pass a context and additional request options.

See AcceptAdministratorInvitation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) AcceptInvitation deprecated

func (c *SecurityHub) AcceptInvitation(input *AcceptInvitationInput) (*AcceptInvitationOutput, error)

AcceptInvitation API operation for AWS SecurityHub.

This method is deprecated. Instead, use AcceptAdministratorInvitation.

The Security Hub console continues to use AcceptInvitation. It will eventually change to use AcceptAdministratorInvitation. Any IAM policies that specifically control access to this function must continue to use AcceptInvitation. You should also add AcceptAdministratorInvitation to your policies to ensure that the correct permissions are in place after the console begins to use AcceptAdministratorInvitation.

Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from.

This operation is only used by member accounts that are not added through Organizations.

When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation AcceptInvitation for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

  • InvalidAccessException The account doesn't have permission to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AcceptInvitation

Deprecated: This API has been deprecated, use AcceptAdministratorInvitation API instead.

func (*SecurityHub) AcceptInvitationRequest deprecated

func (c *SecurityHub) AcceptInvitationRequest(input *AcceptInvitationInput) (req *request.Request, output *AcceptInvitationOutput)

AcceptInvitationRequest generates a "aws/request.Request" representing the client's request for the AcceptInvitation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AcceptInvitation for more information on using the AcceptInvitation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AcceptInvitationRequest method.
req, resp := client.AcceptInvitationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AcceptInvitation

Deprecated: This API has been deprecated, use AcceptAdministratorInvitation API instead.

func (*SecurityHub) AcceptInvitationWithContext deprecated

func (c *SecurityHub) AcceptInvitationWithContext(ctx aws.Context, input *AcceptInvitationInput, opts ...request.Option) (*AcceptInvitationOutput, error)

AcceptInvitationWithContext is the same as AcceptInvitation with the addition of the ability to pass a context and additional request options.

See AcceptInvitation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: This API has been deprecated, use AcceptAdministratorInvitation API instead.

func (*SecurityHub) BatchDeleteAutomationRules added in v1.42.9

func (c *SecurityHub) BatchDeleteAutomationRules(input *BatchDeleteAutomationRulesInput) (*BatchDeleteAutomationRulesOutput, error)

BatchDeleteAutomationRules API operation for AWS SecurityHub.

Deletes one or more automation rules.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation BatchDeleteAutomationRules for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchDeleteAutomationRules

Example (Shared00)

To delete one or more automation rules The following example deletes the specified automation rules.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.BatchDeleteAutomationRulesInput{
		AutomationRulesArns: []*string{
			aws.String("arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"),
			aws.String("arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"),
		},
	}

	result, err := svc.BatchDeleteAutomationRules(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) BatchDeleteAutomationRulesRequest added in v1.42.9

func (c *SecurityHub) BatchDeleteAutomationRulesRequest(input *BatchDeleteAutomationRulesInput) (req *request.Request, output *BatchDeleteAutomationRulesOutput)

BatchDeleteAutomationRulesRequest generates a "aws/request.Request" representing the client's request for the BatchDeleteAutomationRules operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchDeleteAutomationRules for more information on using the BatchDeleteAutomationRules API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchDeleteAutomationRulesRequest method.
req, resp := client.BatchDeleteAutomationRulesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchDeleteAutomationRules

func (*SecurityHub) BatchDeleteAutomationRulesWithContext added in v1.42.9

func (c *SecurityHub) BatchDeleteAutomationRulesWithContext(ctx aws.Context, input *BatchDeleteAutomationRulesInput, opts ...request.Option) (*BatchDeleteAutomationRulesOutput, error)

BatchDeleteAutomationRulesWithContext is the same as BatchDeleteAutomationRules with the addition of the ability to pass a context and additional request options.

See BatchDeleteAutomationRules for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) BatchDisableStandards

func (c *SecurityHub) BatchDisableStandards(input *BatchDisableStandardsInput) (*BatchDisableStandardsOutput, error)

BatchDisableStandards API operation for AWS SecurityHub.

Disables the standards specified by the provided StandardsSubscriptionArns.

For more information, see Security Standards (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html) section of the Security Hub User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation BatchDisableStandards for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchDisableStandards

Example (Shared00)

To disable one or more security standards The following example disables a security standard in Security Hub.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.BatchDisableStandardsInput{
		StandardsSubscriptionArns: []*string{
			aws.String("arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1"),
		},
	}

	result, err := svc.BatchDisableStandards(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) BatchDisableStandardsRequest

func (c *SecurityHub) BatchDisableStandardsRequest(input *BatchDisableStandardsInput) (req *request.Request, output *BatchDisableStandardsOutput)

BatchDisableStandardsRequest generates a "aws/request.Request" representing the client's request for the BatchDisableStandards operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchDisableStandards for more information on using the BatchDisableStandards API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchDisableStandardsRequest method.
req, resp := client.BatchDisableStandardsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchDisableStandards

func (*SecurityHub) BatchDisableStandardsWithContext

func (c *SecurityHub) BatchDisableStandardsWithContext(ctx aws.Context, input *BatchDisableStandardsInput, opts ...request.Option) (*BatchDisableStandardsOutput, error)

BatchDisableStandardsWithContext is the same as BatchDisableStandards with the addition of the ability to pass a context and additional request options.

See BatchDisableStandards for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) BatchEnableStandards

func (c *SecurityHub) BatchEnableStandards(input *BatchEnableStandardsInput) (*BatchEnableStandardsOutput, error)

BatchEnableStandards API operation for AWS SecurityHub.

Enables the standards specified by the provided StandardsArn. To obtain the ARN for a standard, use the DescribeStandards operation.

For more information, see the Security Standards (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html) section of the Security Hub User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation BatchEnableStandards for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchEnableStandards

Example (Shared00)

To enable security standards The following example enables the security standard specified by the StandardArn. You can use this operation to enable one or more Security Hub standards.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.BatchEnableStandardsInput{
		StandardsSubscriptionRequests: []*securityhub.StandardsSubscriptionRequest{
			{
				StandardsArn: aws.String("arn:aws:securityhub:us-west-1::standards/pci-dss/v/3.2.1"),
			},
		},
	}

	result, err := svc.BatchEnableStandards(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) BatchEnableStandardsRequest

func (c *SecurityHub) BatchEnableStandardsRequest(input *BatchEnableStandardsInput) (req *request.Request, output *BatchEnableStandardsOutput)

BatchEnableStandardsRequest generates a "aws/request.Request" representing the client's request for the BatchEnableStandards operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchEnableStandards for more information on using the BatchEnableStandards API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchEnableStandardsRequest method.
req, resp := client.BatchEnableStandardsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchEnableStandards

func (*SecurityHub) BatchEnableStandardsWithContext

func (c *SecurityHub) BatchEnableStandardsWithContext(ctx aws.Context, input *BatchEnableStandardsInput, opts ...request.Option) (*BatchEnableStandardsOutput, error)

BatchEnableStandardsWithContext is the same as BatchEnableStandards with the addition of the ability to pass a context and additional request options.

See BatchEnableStandards for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) BatchGetAutomationRules added in v1.42.9

func (c *SecurityHub) BatchGetAutomationRules(input *BatchGetAutomationRulesInput) (*BatchGetAutomationRulesOutput, error)

BatchGetAutomationRules API operation for AWS SecurityHub.

Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation BatchGetAutomationRules for usage and error information.

Returned Error Types:

  • AccessDeniedException You don't have permission to perform the action specified in the request.

  • InternalException Internal server error.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchGetAutomationRules

Example (Shared00)

To update one ore more automation rules The following example updates the specified automation rules.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.BatchGetAutomationRulesInput{
		AutomationRulesArns: []*string{
			aws.String("arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"),
			aws.String("arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"),
		},
	}

	result, err := svc.BatchGetAutomationRules(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeAccessDeniedException:
				fmt.Println(securityhub.ErrCodeAccessDeniedException, aerr.Error())
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) BatchGetAutomationRulesRequest added in v1.42.9

func (c *SecurityHub) BatchGetAutomationRulesRequest(input *BatchGetAutomationRulesInput) (req *request.Request, output *BatchGetAutomationRulesOutput)

BatchGetAutomationRulesRequest generates a "aws/request.Request" representing the client's request for the BatchGetAutomationRules operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchGetAutomationRules for more information on using the BatchGetAutomationRules API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchGetAutomationRulesRequest method.
req, resp := client.BatchGetAutomationRulesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchGetAutomationRules

func (*SecurityHub) BatchGetAutomationRulesWithContext added in v1.42.9

func (c *SecurityHub) BatchGetAutomationRulesWithContext(ctx aws.Context, input *BatchGetAutomationRulesInput, opts ...request.Option) (*BatchGetAutomationRulesOutput, error)

BatchGetAutomationRulesWithContext is the same as BatchGetAutomationRules with the addition of the ability to pass a context and additional request options.

See BatchGetAutomationRules for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) BatchGetSecurityControls added in v1.42.9

func (c *SecurityHub) BatchGetSecurityControls(input *BatchGetSecurityControlsInput) (*BatchGetSecurityControlsOutput, error)

BatchGetSecurityControls API operation for AWS SecurityHub.

Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation BatchGetSecurityControls for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchGetSecurityControls

Example (Shared00)

To get security control details The following example gets details for the specified controls in the current AWS account and AWS Region.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.BatchGetSecurityControlsInput{
		SecurityControlIds: []*string{
			aws.String("ACM.1"),
			aws.String("APIGateway.1"),
		},
	}

	result, err := svc.BatchGetSecurityControls(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) BatchGetSecurityControlsRequest added in v1.42.9

func (c *SecurityHub) BatchGetSecurityControlsRequest(input *BatchGetSecurityControlsInput) (req *request.Request, output *BatchGetSecurityControlsOutput)

BatchGetSecurityControlsRequest generates a "aws/request.Request" representing the client's request for the BatchGetSecurityControls operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchGetSecurityControls for more information on using the BatchGetSecurityControls API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchGetSecurityControlsRequest method.
req, resp := client.BatchGetSecurityControlsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchGetSecurityControls

func (*SecurityHub) BatchGetSecurityControlsWithContext added in v1.42.9

func (c *SecurityHub) BatchGetSecurityControlsWithContext(ctx aws.Context, input *BatchGetSecurityControlsInput, opts ...request.Option) (*BatchGetSecurityControlsOutput, error)

BatchGetSecurityControlsWithContext is the same as BatchGetSecurityControls with the addition of the ability to pass a context and additional request options.

See BatchGetSecurityControls for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) BatchGetStandardsControlAssociations added in v1.42.9

BatchGetStandardsControlAssociations API operation for AWS SecurityHub.

For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation BatchGetStandardsControlAssociations for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchGetStandardsControlAssociations

Example (Shared00)

To get enablement status of a batch of controls The following example retrieves the enablement status of the specified controls in the specified standards.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.BatchGetStandardsControlAssociationsInput{
		StandardsControlAssociationIds: []*securityhub.StandardsControlAssociationId{
			{
				SecurityControlId: aws.String("CloudTrail.1"),
				StandardsArn:      aws.String("arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"),
			},
			{
				SecurityControlId: aws.String("CloudWatch.12"),
				StandardsArn:      aws.String("arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"),
			},
		},
	}

	result, err := svc.BatchGetStandardsControlAssociations(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) BatchGetStandardsControlAssociationsRequest added in v1.42.9

func (c *SecurityHub) BatchGetStandardsControlAssociationsRequest(input *BatchGetStandardsControlAssociationsInput) (req *request.Request, output *BatchGetStandardsControlAssociationsOutput)

BatchGetStandardsControlAssociationsRequest generates a "aws/request.Request" representing the client's request for the BatchGetStandardsControlAssociations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchGetStandardsControlAssociations for more information on using the BatchGetStandardsControlAssociations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchGetStandardsControlAssociationsRequest method.
req, resp := client.BatchGetStandardsControlAssociationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchGetStandardsControlAssociations

func (*SecurityHub) BatchGetStandardsControlAssociationsWithContext added in v1.42.9

func (c *SecurityHub) BatchGetStandardsControlAssociationsWithContext(ctx aws.Context, input *BatchGetStandardsControlAssociationsInput, opts ...request.Option) (*BatchGetStandardsControlAssociationsOutput, error)

BatchGetStandardsControlAssociationsWithContext is the same as BatchGetStandardsControlAssociations with the addition of the ability to pass a context and additional request options.

See BatchGetStandardsControlAssociations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) BatchImportFindings

func (c *SecurityHub) BatchImportFindings(input *BatchImportFindingsInput) (*BatchImportFindingsOutput, error)

BatchImportFindings API operation for AWS SecurityHub.

Imports security findings generated by a finding provider into Security Hub. This action is requested by the finding provider to import its findings into Security Hub.

BatchImportFindings must be called by one of the following:

  • The Amazon Web Services account that is associated with a finding if you are using the default product ARN (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-custom-providers.html#securityhub-custom-providers-bfi-reqs) or are a partner sending findings from within a customer's Amazon Web Services account. In these cases, the identifier of the account that you are calling BatchImportFindings from needs to be the same as the AwsAccountId attribute for the finding.

  • An Amazon Web Services account that Security Hub has allow-listed for an official partner integration. In this case, you can call BatchImportFindings from the allow-listed account and send findings from different customer accounts in the same batch.

The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.

After a finding is created, BatchImportFindings cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.

  • Note

  • UserDefinedFields

  • VerificationState

  • Workflow

Finding providers also should not use BatchImportFindings to update the following attributes.

  • Confidence

  • Criticality

  • RelatedFindings

  • Severity

  • Types

Instead, finding providers use FindingProviderFields to provide values for these attributes.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation BatchImportFindings for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchImportFindings

Example (Shared00)

To import security findings from a third party provider to Security Hub The following example imports findings from a third party provider to Security Hub.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.BatchImportFindingsInput{
		Findings: []*securityhub.AwsSecurityFinding{
			{
				AwsAccountId: aws.String("123456789012"),
				CreatedAt:    aws.String("2020-05-27T17:05:54.832Z"),
				Description:  aws.String("Vulnerability in a CloudTrail trail"),
				FindingProviderFields: &securityhub.FindingProviderFields{
					Severity: &securityhub.FindingProviderSeverity{
						Label:    aws.String("LOW"),
						Original: aws.String("10"),
					},
					Types: []*string{
						aws.String("Software and Configuration Checks/Vulnerabilities/CVE"),
					},
				},
				GeneratorId: aws.String("TestGeneratorId"),
				Id:          aws.String("Id1"),
				ProductArn:  aws.String("arn:aws:securityhub:us-west-1:123456789012:product/123456789012/default"),
				Resources: []*securityhub.Resource{
					{
						Id:        aws.String("arn:aws:cloudtrail:us-west-1:123456789012:trail/TrailName"),
						Partition: aws.String("aws"),
						Region:    aws.String("us-west-1"),
						Type:      aws.String("AwsCloudTrailTrail"),
					},
				},
				SchemaVersion: aws.String("2018-10-08"),
				Title:         aws.String("CloudTrail trail vulnerability"),
				UpdatedAt:     aws.String("2020-06-02T16:05:54.832Z"),
			},
		},
	}

	result, err := svc.BatchImportFindings(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) BatchImportFindingsRequest

func (c *SecurityHub) BatchImportFindingsRequest(input *BatchImportFindingsInput) (req *request.Request, output *BatchImportFindingsOutput)

BatchImportFindingsRequest generates a "aws/request.Request" representing the client's request for the BatchImportFindings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchImportFindings for more information on using the BatchImportFindings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchImportFindingsRequest method.
req, resp := client.BatchImportFindingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchImportFindings

func (*SecurityHub) BatchImportFindingsWithContext

func (c *SecurityHub) BatchImportFindingsWithContext(ctx aws.Context, input *BatchImportFindingsInput, opts ...request.Option) (*BatchImportFindingsOutput, error)

BatchImportFindingsWithContext is the same as BatchImportFindings with the addition of the ability to pass a context and additional request options.

See BatchImportFindings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) BatchUpdateAutomationRules added in v1.42.9

func (c *SecurityHub) BatchUpdateAutomationRules(input *BatchUpdateAutomationRulesInput) (*BatchUpdateAutomationRulesOutput, error)

BatchUpdateAutomationRules API operation for AWS SecurityHub.

Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input parameters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation BatchUpdateAutomationRules for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchUpdateAutomationRules

Example (Shared00)

To update one ore more automation rules The following example updates the specified automation rules.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.BatchUpdateAutomationRulesInput{
		UpdateAutomationRulesRequestItems: []*securityhub.UpdateAutomationRulesRequestItem{
			{
				RuleArn:    aws.String("arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"),
				RuleOrder:  aws.Int64(15),
				RuleStatus: aws.String("ENABLED"),
			},
			{
				RuleArn:    aws.String("arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"),
				RuleStatus: aws.String("DISABLED"),
			},
		},
	}

	result, err := svc.BatchUpdateAutomationRules(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) BatchUpdateAutomationRulesRequest added in v1.42.9

func (c *SecurityHub) BatchUpdateAutomationRulesRequest(input *BatchUpdateAutomationRulesInput) (req *request.Request, output *BatchUpdateAutomationRulesOutput)

BatchUpdateAutomationRulesRequest generates a "aws/request.Request" representing the client's request for the BatchUpdateAutomationRules operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchUpdateAutomationRules for more information on using the BatchUpdateAutomationRules API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchUpdateAutomationRulesRequest method.
req, resp := client.BatchUpdateAutomationRulesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchUpdateAutomationRules

func (*SecurityHub) BatchUpdateAutomationRulesWithContext added in v1.42.9

func (c *SecurityHub) BatchUpdateAutomationRulesWithContext(ctx aws.Context, input *BatchUpdateAutomationRulesInput, opts ...request.Option) (*BatchUpdateAutomationRulesOutput, error)

BatchUpdateAutomationRulesWithContext is the same as BatchUpdateAutomationRules with the addition of the ability to pass a context and additional request options.

See BatchUpdateAutomationRules for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) BatchUpdateFindings

func (c *SecurityHub) BatchUpdateFindings(input *BatchUpdateFindingsInput) (*BatchUpdateFindingsOutput, error)

BatchUpdateFindings API operation for AWS SecurityHub.

Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.

Updates from BatchUpdateFindings do not affect the value of UpdatedAt for a finding.

Administrator and member accounts can use BatchUpdateFindings to update the following finding fields and objects.

  • Confidence

  • Criticality

  • Note

  • RelatedFindings

  • Severity

  • Types

  • UserDefinedFields

  • VerificationState

  • Workflow

You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings (https://docs.aws.amazon.com/securityhub/latest/userguide/finding-update-batchupdatefindings.html#batchupdatefindings-configure-access) in the Security Hub User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation BatchUpdateFindings for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchUpdateFindings

Example (Shared00)

To update Security Hub findings The following example updates Security Hub findings. The finding identifier parameter specifies which findings to update. Only specific finding fields can be updated with this operation.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.BatchUpdateFindingsInput{
		Confidence:  aws.Int64(80),
		Criticality: aws.Int64(80),
		FindingIdentifiers: []*securityhub.AwsSecurityFindingIdentifier{
			{
				Id:         aws.String("arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"),
				ProductArn: aws.String("arn:aws:securityhub:us-west-1::product/aws/securityhub"),
			},
			{
				Id:         aws.String("arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"),
				ProductArn: aws.String("arn:aws:securityhub:us-west-1::product/aws/securityhub"),
			},
		},
		Note: &securityhub.NoteUpdate{
			Text:      aws.String("Known issue that is not a risk."),
			UpdatedBy: aws.String("user1"),
		},
		RelatedFindings: []*securityhub.RelatedFinding{
			{
				Id:         aws.String("arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333"),
				ProductArn: aws.String("arn:aws:securityhub:us-west-1::product/aws/securityhub"),
			},
		},
		Severity: &securityhub.SeverityUpdate{
			Label: aws.String("LOW"),
		},
		Types: []*string{
			aws.String("Software and Configuration Checks/Vulnerabilities/CVE"),
		},
		UserDefinedFields: map[string]*string{
			"reviewedByCio": aws.String("true"),
		},
		VerificationState: aws.String("TRUE_POSITIVE"),
		Workflow: &securityhub.WorkflowUpdate{
			Status: aws.String("RESOLVED"),
		},
	}

	result, err := svc.BatchUpdateFindings(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) BatchUpdateFindingsRequest

func (c *SecurityHub) BatchUpdateFindingsRequest(input *BatchUpdateFindingsInput) (req *request.Request, output *BatchUpdateFindingsOutput)

BatchUpdateFindingsRequest generates a "aws/request.Request" representing the client's request for the BatchUpdateFindings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchUpdateFindings for more information on using the BatchUpdateFindings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchUpdateFindingsRequest method.
req, resp := client.BatchUpdateFindingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchUpdateFindings

func (*SecurityHub) BatchUpdateFindingsWithContext

func (c *SecurityHub) BatchUpdateFindingsWithContext(ctx aws.Context, input *BatchUpdateFindingsInput, opts ...request.Option) (*BatchUpdateFindingsOutput, error)

BatchUpdateFindingsWithContext is the same as BatchUpdateFindings with the addition of the ability to pass a context and additional request options.

See BatchUpdateFindings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) BatchUpdateStandardsControlAssociations added in v1.42.9

BatchUpdateStandardsControlAssociations API operation for AWS SecurityHub.

For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation BatchUpdateStandardsControlAssociations for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchUpdateStandardsControlAssociations

Example (Shared00)

To update enablement status of a batch of controls The following example disables CloudWatch.12 in CIS AWS Foundations Benchmark v1.2.0. The example returns an error for CloudTrail.1 because an invalid standard ARN is provided.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.BatchUpdateStandardsControlAssociationsInput{
		StandardsControlAssociationUpdates: []*securityhub.StandardsControlAssociationUpdate{
			{
				AssociationStatus: aws.String("DISABLED"),
				SecurityControlId: aws.String("CloudTrail.1"),
				StandardsArn:      aws.String("arn:aws:securityhub:::ruleset/sample-standard/v/1.1.0"),
				UpdatedReason:     aws.String("Not relevant to environment"),
			},
			{
				AssociationStatus: aws.String("DISABLED"),
				SecurityControlId: aws.String("CloudWatch.12"),
				StandardsArn:      aws.String("arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"),
				UpdatedReason:     aws.String("Not relevant to environment"),
			},
		},
	}

	result, err := svc.BatchUpdateStandardsControlAssociations(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) BatchUpdateStandardsControlAssociationsRequest added in v1.42.9

func (c *SecurityHub) BatchUpdateStandardsControlAssociationsRequest(input *BatchUpdateStandardsControlAssociationsInput) (req *request.Request, output *BatchUpdateStandardsControlAssociationsOutput)

BatchUpdateStandardsControlAssociationsRequest generates a "aws/request.Request" representing the client's request for the BatchUpdateStandardsControlAssociations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchUpdateStandardsControlAssociations for more information on using the BatchUpdateStandardsControlAssociations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchUpdateStandardsControlAssociationsRequest method.
req, resp := client.BatchUpdateStandardsControlAssociationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/BatchUpdateStandardsControlAssociations

func (*SecurityHub) BatchUpdateStandardsControlAssociationsWithContext added in v1.42.9

func (c *SecurityHub) BatchUpdateStandardsControlAssociationsWithContext(ctx aws.Context, input *BatchUpdateStandardsControlAssociationsInput, opts ...request.Option) (*BatchUpdateStandardsControlAssociationsOutput, error)

BatchUpdateStandardsControlAssociationsWithContext is the same as BatchUpdateStandardsControlAssociations with the addition of the ability to pass a context and additional request options.

See BatchUpdateStandardsControlAssociations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) CreateActionTarget

func (c *SecurityHub) CreateActionTarget(input *CreateActionTargetInput) (*CreateActionTargetOutput, error)

CreateActionTarget API operation for AWS SecurityHub.

Creates a custom action target in Security Hub.

You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation CreateActionTarget for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceConflictException The resource specified in the request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CreateActionTarget

Example (Shared00)

To create a custom action target The following example creates a custom action target in Security Hub. Custom actions on findings and insights automatically trigger actions in Amazon CloudWatch Events.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.CreateActionTargetInput{
		Description: aws.String("Action to send the finding for remediation tracking"),
		Id:          aws.String("Remediation"),
		Name:        aws.String("Send to remediation"),
	}

	result, err := svc.CreateActionTarget(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeResourceConflictException:
				fmt.Println(securityhub.ErrCodeResourceConflictException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) CreateActionTargetRequest

func (c *SecurityHub) CreateActionTargetRequest(input *CreateActionTargetInput) (req *request.Request, output *CreateActionTargetOutput)

CreateActionTargetRequest generates a "aws/request.Request" representing the client's request for the CreateActionTarget operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateActionTarget for more information on using the CreateActionTarget API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateActionTargetRequest method.
req, resp := client.CreateActionTargetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CreateActionTarget

func (*SecurityHub) CreateActionTargetWithContext

func (c *SecurityHub) CreateActionTargetWithContext(ctx aws.Context, input *CreateActionTargetInput, opts ...request.Option) (*CreateActionTargetOutput, error)

CreateActionTargetWithContext is the same as CreateActionTarget with the addition of the ability to pass a context and additional request options.

See CreateActionTarget for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) CreateAutomationRule added in v1.42.9

func (c *SecurityHub) CreateAutomationRule(input *CreateAutomationRuleInput) (*CreateAutomationRuleOutput, error)

CreateAutomationRule API operation for AWS SecurityHub.

Creates an automation rule based on input parameters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation CreateAutomationRule for usage and error information.

Returned Error Types:

  • AccessDeniedException You don't have permission to perform the action specified in the request.

  • InternalException Internal server error.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CreateAutomationRule

Example (Shared00)

To create an automation rule The following example creates an automation rule.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.CreateAutomationRuleInput{
		Actions: []*securityhub.AutomationRulesAction{
			{
				FindingFieldsUpdate: &securityhub.AutomationRulesFindingFieldsUpdate{
					Note: &securityhub.NoteUpdate{
						Text:      aws.String("This is a critical S3 bucket, please look into this ASAP"),
						UpdatedBy: aws.String("test-user"),
					},
					Severity: &securityhub.SeverityUpdate{
						Label: aws.String("CRITICAL"),
					},
				},
				Type: aws.String("FINDING_FIELDS_UPDATE"),
			},
		},
		Criteria: &securityhub.AutomationRulesFindingFilters{
			ComplianceStatus: []*securityhub.StringFilter{
				{
					Comparison: aws.String("EQUALS"),
					Value:      aws.String("FAILED"),
				},
			},
			ProductName: []*securityhub.StringFilter{
				{
					Comparison: aws.String("EQUALS"),
					Value:      aws.String("Security Hub"),
				},
			},
			RecordState: []*securityhub.StringFilter{
				{
					Comparison: aws.String("EQUALS"),
					Value:      aws.String("ACTIVE"),
				},
			},
			ResourceId: []*securityhub.StringFilter{
				{
					Comparison: aws.String("EQUALS"),
					Value:      aws.String("arn:aws:s3:::examplebucket/developers/design_info.doc"),
				},
			},
			WorkflowStatus: []*securityhub.StringFilter{
				{
					Comparison: aws.String("EQUALS"),
					Value:      aws.String("NEW"),
				},
			},
		},
		Description: aws.String("Elevate finding severity to Critical for important resources"),
		IsTerminal:  aws.Bool(false),
		RuleName:    aws.String("Elevate severity for important resources"),
		RuleOrder:   aws.Int64(1),
		RuleStatus:  aws.String("ENABLED"),
		Tags: map[string]*string{
			"important-resources-rule": aws.String("s3-bucket"),
		},
	}

	result, err := svc.CreateAutomationRule(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeAccessDeniedException:
				fmt.Println(securityhub.ErrCodeAccessDeniedException, aerr.Error())
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) CreateAutomationRuleRequest added in v1.42.9

func (c *SecurityHub) CreateAutomationRuleRequest(input *CreateAutomationRuleInput) (req *request.Request, output *CreateAutomationRuleOutput)

CreateAutomationRuleRequest generates a "aws/request.Request" representing the client's request for the CreateAutomationRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAutomationRule for more information on using the CreateAutomationRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateAutomationRuleRequest method.
req, resp := client.CreateAutomationRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CreateAutomationRule

func (*SecurityHub) CreateAutomationRuleWithContext added in v1.42.9

func (c *SecurityHub) CreateAutomationRuleWithContext(ctx aws.Context, input *CreateAutomationRuleInput, opts ...request.Option) (*CreateAutomationRuleOutput, error)

CreateAutomationRuleWithContext is the same as CreateAutomationRule with the addition of the ability to pass a context and additional request options.

See CreateAutomationRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) CreateFindingAggregator

func (c *SecurityHub) CreateFindingAggregator(input *CreateFindingAggregatorInput) (*CreateFindingAggregatorOutput, error)

CreateFindingAggregator API operation for AWS SecurityHub.

Used to enable finding aggregation. Must be called from the aggregation Region.

For more details about cross-Region replication, see Configuring finding aggregation (https://docs.aws.amazon.com/securityhub/latest/userguide/finding-aggregation.html) in the Security Hub User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation CreateFindingAggregator for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • AccessDeniedException You don't have permission to perform the action specified in the request.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CreateFindingAggregator

Example (Shared00)

To enable cross-Region aggregation The following example creates a finding aggregator. This is required to enable cross-Region aggregation.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.CreateFindingAggregatorInput{
		RegionLinkingMode: aws.String("SPECIFIED_REGIONS"),
		Regions: []*string{
			aws.String("us-west-1"),
			aws.String("us-west-2"),
		},
	}

	result, err := svc.CreateFindingAggregator(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeAccessDeniedException:
				fmt.Println(securityhub.ErrCodeAccessDeniedException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) CreateFindingAggregatorRequest

func (c *SecurityHub) CreateFindingAggregatorRequest(input *CreateFindingAggregatorInput) (req *request.Request, output *CreateFindingAggregatorOutput)

CreateFindingAggregatorRequest generates a "aws/request.Request" representing the client's request for the CreateFindingAggregator operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFindingAggregator for more information on using the CreateFindingAggregator API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateFindingAggregatorRequest method.
req, resp := client.CreateFindingAggregatorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CreateFindingAggregator

func (*SecurityHub) CreateFindingAggregatorWithContext

func (c *SecurityHub) CreateFindingAggregatorWithContext(ctx aws.Context, input *CreateFindingAggregatorInput, opts ...request.Option) (*CreateFindingAggregatorOutput, error)

CreateFindingAggregatorWithContext is the same as CreateFindingAggregator with the addition of the ability to pass a context and additional request options.

See CreateFindingAggregator for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) CreateInsight

func (c *SecurityHub) CreateInsight(input *CreateInsightInput) (*CreateInsightOutput, error)

CreateInsight API operation for AWS SecurityHub.

Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation.

To group the related findings in the insight, use the GroupByAttribute.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation CreateInsight for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • ResourceConflictException The resource specified in the request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CreateInsight

Example (Shared00)

To create a custom insight The following example creates a custom insight in Security Hub. An insight is a collection of findings that relate to a security issue.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.CreateInsightInput{
		Filters: &securityhub.AwsSecurityFindingFilters{
			ResourceType: []*securityhub.StringFilter{
				{
					Comparison: aws.String("EQUALS"),
					Value:      aws.String("AwsIamRole"),
				},
			},
			SeverityLabel: []*securityhub.StringFilter{
				{
					Comparison: aws.String("EQUALS"),
					Value:      aws.String("CRITICAL"),
				},
			},
		},
		GroupByAttribute: aws.String("ResourceId"),
		Name:             aws.String("Critical role findings"),
	}

	result, err := svc.CreateInsight(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeResourceConflictException:
				fmt.Println(securityhub.ErrCodeResourceConflictException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) CreateInsightRequest

func (c *SecurityHub) CreateInsightRequest(input *CreateInsightInput) (req *request.Request, output *CreateInsightOutput)

CreateInsightRequest generates a "aws/request.Request" representing the client's request for the CreateInsight operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateInsight for more information on using the CreateInsight API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateInsightRequest method.
req, resp := client.CreateInsightRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CreateInsight

func (*SecurityHub) CreateInsightWithContext

func (c *SecurityHub) CreateInsightWithContext(ctx aws.Context, input *CreateInsightInput, opts ...request.Option) (*CreateInsightOutput, error)

CreateInsightWithContext is the same as CreateInsight with the addition of the ability to pass a context and additional request options.

See CreateInsight for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) CreateMembers

func (c *SecurityHub) CreateMembers(input *CreateMembersInput) (*CreateMembersOutput, error)

CreateMembers API operation for AWS SecurityHub.

Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account.

CreateMembers is always used to add accounts that are not organization members.

For accounts that are managed using Organizations, CreateMembers is only used in the following cases:

  • Security Hub is not configured to automatically add new organization accounts.

  • The account was disassociated or deleted in Security Hub.

This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the EnableSecurityHub operation.

For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the InviteMembers operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub.

Accounts that are managed using Organizations do not receive an invitation. They automatically become a member account in Security Hub.

  • If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.

  • For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.

A permissions policy is added that permits the administrator account to view the findings generated in the member account.

To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation CreateMembers for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • ResourceConflictException The resource specified in the request conflicts with an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CreateMembers

Example (Shared00)

To add a member account The following example creates a member association between the specified accounts and the administrator account (the account that makes the request). This operation is used to add accounts that aren't part of an organization.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.CreateMembersInput{
		AccountDetails: []*securityhub.AccountDetails{
			{
				AccountId: aws.String("123456789012"),
			},
			{
				AccountId: aws.String("111122223333"),
			},
		},
	}

	result, err := svc.CreateMembers(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeResourceConflictException:
				fmt.Println(securityhub.ErrCodeResourceConflictException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) CreateMembersRequest

func (c *SecurityHub) CreateMembersRequest(input *CreateMembersInput) (req *request.Request, output *CreateMembersOutput)

CreateMembersRequest generates a "aws/request.Request" representing the client's request for the CreateMembers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateMembers for more information on using the CreateMembers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateMembersRequest method.
req, resp := client.CreateMembersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/CreateMembers

func (*SecurityHub) CreateMembersWithContext

func (c *SecurityHub) CreateMembersWithContext(ctx aws.Context, input *CreateMembersInput, opts ...request.Option) (*CreateMembersOutput, error)

CreateMembersWithContext is the same as CreateMembers with the addition of the ability to pass a context and additional request options.

See CreateMembers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DeclineInvitations

func (c *SecurityHub) DeclineInvitations(input *DeclineInvitationsInput) (*DeclineInvitationsOutput, error)

DeclineInvitations API operation for AWS SecurityHub.

Declines invitations to become a member account.

A prospective member account uses this operation to decline an invitation to become a member.

This operation is only called by member accounts that aren't part of an organization. Organization accounts don't receive invitations.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation DeclineInvitations for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DeclineInvitations

Example (Shared00)

To decline invitation to become a member account The following example declines an invitation from the Security Hub administrator account to become a member account. The invited account makes the request.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.DeclineInvitationsInput{
		AccountIds: []*string{
			aws.String("123456789012"),
			aws.String("111122223333"),
		},
	}

	result, err := svc.DeclineInvitations(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) DeclineInvitationsRequest

func (c *SecurityHub) DeclineInvitationsRequest(input *DeclineInvitationsInput) (req *request.Request, output *DeclineInvitationsOutput)

DeclineInvitationsRequest generates a "aws/request.Request" representing the client's request for the DeclineInvitations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeclineInvitations for more information on using the DeclineInvitations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeclineInvitationsRequest method.
req, resp := client.DeclineInvitationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DeclineInvitations

func (*SecurityHub) DeclineInvitationsWithContext

func (c *SecurityHub) DeclineInvitationsWithContext(ctx aws.Context, input *DeclineInvitationsInput, opts ...request.Option) (*DeclineInvitationsOutput, error)

DeclineInvitationsWithContext is the same as DeclineInvitations with the addition of the ability to pass a context and additional request options.

See DeclineInvitations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DeleteActionTarget

func (c *SecurityHub) DeleteActionTarget(input *DeleteActionTargetInput) (*DeleteActionTargetOutput, error)

DeleteActionTarget API operation for AWS SecurityHub.

Deletes a custom action target from Security Hub.

Deleting a custom action target does not affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation DeleteActionTarget for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DeleteActionTarget

Example (Shared00)

To delete a custom action target The following example deletes a custom action target that triggers target actions in Amazon CloudWatch Events. Deleting a custom action target doesn't affect findings or insights that were already sent to CloudWatch Events based on the custom action.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.DeleteActionTargetInput{
		ActionTargetArn: aws.String("arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation"),
	}

	result, err := svc.DeleteActionTarget(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) DeleteActionTargetRequest

func (c *SecurityHub) DeleteActionTargetRequest(input *DeleteActionTargetInput) (req *request.Request, output *DeleteActionTargetOutput)

DeleteActionTargetRequest generates a "aws/request.Request" representing the client's request for the DeleteActionTarget operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteActionTarget for more information on using the DeleteActionTarget API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteActionTargetRequest method.
req, resp := client.DeleteActionTargetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DeleteActionTarget

func (*SecurityHub) DeleteActionTargetWithContext

func (c *SecurityHub) DeleteActionTargetWithContext(ctx aws.Context, input *DeleteActionTargetInput, opts ...request.Option) (*DeleteActionTargetOutput, error)

DeleteActionTargetWithContext is the same as DeleteActionTarget with the addition of the ability to pass a context and additional request options.

See DeleteActionTarget for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DeleteFindingAggregator

func (c *SecurityHub) DeleteFindingAggregator(input *DeleteFindingAggregatorInput) (*DeleteFindingAggregatorOutput, error)

DeleteFindingAggregator API operation for AWS SecurityHub.

Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation.

When you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation DeleteFindingAggregator for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • AccessDeniedException You don't have permission to perform the action specified in the request.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DeleteFindingAggregator

Example (Shared00)

To delete a finding aggregator The following example deletes a finding aggregator in Security Hub. Deleting the finding aggregator stops cross-Region aggregation. This operation produces no output.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.DeleteFindingAggregatorInput{
		FindingAggregatorArn: aws.String("arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"),
	}

	result, err := svc.DeleteFindingAggregator(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeAccessDeniedException:
				fmt.Println(securityhub.ErrCodeAccessDeniedException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) DeleteFindingAggregatorRequest

func (c *SecurityHub) DeleteFindingAggregatorRequest(input *DeleteFindingAggregatorInput) (req *request.Request, output *DeleteFindingAggregatorOutput)

DeleteFindingAggregatorRequest generates a "aws/request.Request" representing the client's request for the DeleteFindingAggregator operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFindingAggregator for more information on using the DeleteFindingAggregator API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteFindingAggregatorRequest method.
req, resp := client.DeleteFindingAggregatorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DeleteFindingAggregator

func (*SecurityHub) DeleteFindingAggregatorWithContext

func (c *SecurityHub) DeleteFindingAggregatorWithContext(ctx aws.Context, input *DeleteFindingAggregatorInput, opts ...request.Option) (*DeleteFindingAggregatorOutput, error)

DeleteFindingAggregatorWithContext is the same as DeleteFindingAggregator with the addition of the ability to pass a context and additional request options.

See DeleteFindingAggregator for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DeleteInsight

func (c *SecurityHub) DeleteInsight(input *DeleteInsightInput) (*DeleteInsightOutput, error)

DeleteInsight API operation for AWS SecurityHub.

Deletes the insight specified by the InsightArn.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation DeleteInsight for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DeleteInsight

Example (Shared00)

To delete a custom insight The following example deletes a custom insight in Security Hub.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.DeleteInsightInput{
		InsightArn: aws.String("arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"),
	}

	result, err := svc.DeleteInsight(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) DeleteInsightRequest

func (c *SecurityHub) DeleteInsightRequest(input *DeleteInsightInput) (req *request.Request, output *DeleteInsightOutput)

DeleteInsightRequest generates a "aws/request.Request" representing the client's request for the DeleteInsight operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteInsight for more information on using the DeleteInsight API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteInsightRequest method.
req, resp := client.DeleteInsightRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DeleteInsight

func (*SecurityHub) DeleteInsightWithContext

func (c *SecurityHub) DeleteInsightWithContext(ctx aws.Context, input *DeleteInsightInput, opts ...request.Option) (*DeleteInsightOutput, error)

DeleteInsightWithContext is the same as DeleteInsight with the addition of the ability to pass a context and additional request options.

See DeleteInsight for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DeleteInvitations

func (c *SecurityHub) DeleteInvitations(input *DeleteInvitationsInput) (*DeleteInvitationsOutput, error)

DeleteInvitations API operation for AWS SecurityHub.

Deletes invitations received by the Amazon Web Services account to become a member account.

A Security Hub administrator account can use this operation to delete invitations sent to one or more member accounts.

This operation is only used to delete invitations that are sent to member accounts that aren't part of an organization. Organization accounts don't receive invitations.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation DeleteInvitations for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

  • InvalidAccessException The account doesn't have permission to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DeleteInvitations

Example (Shared00)

To delete a custom insight The following example deletes an invitation sent by the Security Hub administrator account to a prospective member account. This operation is used only for invitations sent to accounts that aren't part of an organization. Organization accounts don't receive invitations.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.DeleteInvitationsInput{
		AccountIds: []*string{
			aws.String("123456789012"),
		},
	}

	result, err := svc.DeleteInvitations(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) DeleteInvitationsRequest

func (c *SecurityHub) DeleteInvitationsRequest(input *DeleteInvitationsInput) (req *request.Request, output *DeleteInvitationsOutput)

DeleteInvitationsRequest generates a "aws/request.Request" representing the client's request for the DeleteInvitations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteInvitations for more information on using the DeleteInvitations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteInvitationsRequest method.
req, resp := client.DeleteInvitationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DeleteInvitations

func (*SecurityHub) DeleteInvitationsWithContext

func (c *SecurityHub) DeleteInvitationsWithContext(ctx aws.Context, input *DeleteInvitationsInput, opts ...request.Option) (*DeleteInvitationsOutput, error)

DeleteInvitationsWithContext is the same as DeleteInvitations with the addition of the ability to pass a context and additional request options.

See DeleteInvitations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DeleteMembers

func (c *SecurityHub) DeleteMembers(input *DeleteMembersInput) (*DeleteMembersOutput, error)

DeleteMembers API operation for AWS SecurityHub.

Deletes the specified member accounts from Security Hub.

Can be used to delete member accounts that belong to an organization as well as member accounts that were invited manually.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation DeleteMembers for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DeleteMembers

Example (Shared00)

To delete a member account The following example deletes the specified member account from Security Hub. This operation can be used to delete member accounts that are part of an organization or that were invited manually.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.DeleteMembersInput{
		AccountIds: []*string{
			aws.String("123456789111"),
			aws.String("123456789222"),
		},
	}

	result, err := svc.DeleteMembers(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) DeleteMembersRequest

func (c *SecurityHub) DeleteMembersRequest(input *DeleteMembersInput) (req *request.Request, output *DeleteMembersOutput)

DeleteMembersRequest generates a "aws/request.Request" representing the client's request for the DeleteMembers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteMembers for more information on using the DeleteMembers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteMembersRequest method.
req, resp := client.DeleteMembersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DeleteMembers

func (*SecurityHub) DeleteMembersWithContext

func (c *SecurityHub) DeleteMembersWithContext(ctx aws.Context, input *DeleteMembersInput, opts ...request.Option) (*DeleteMembersOutput, error)

DeleteMembersWithContext is the same as DeleteMembers with the addition of the ability to pass a context and additional request options.

See DeleteMembers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DescribeActionTargets

func (c *SecurityHub) DescribeActionTargets(input *DescribeActionTargetsInput) (*DescribeActionTargetsOutput, error)

DescribeActionTargets API operation for AWS SecurityHub.

Returns a list of the custom action targets in Security Hub in your account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation DescribeActionTargets for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DescribeActionTargets

Example (Shared00)

To return custom action targets The following example returns a list of custom action targets. You use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.DescribeActionTargetsInput{
		ActionTargetArns: []*string{
			aws.String("arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation"),
		},
	}

	result, err := svc.DescribeActionTargets(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) DescribeActionTargetsPages

func (c *SecurityHub) DescribeActionTargetsPages(input *DescribeActionTargetsInput, fn func(*DescribeActionTargetsOutput, bool) bool) error

DescribeActionTargetsPages iterates over the pages of a DescribeActionTargets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeActionTargets method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeActionTargets operation.
pageNum := 0
err := client.DescribeActionTargetsPages(params,
    func(page *securityhub.DescribeActionTargetsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecurityHub) DescribeActionTargetsPagesWithContext

func (c *SecurityHub) DescribeActionTargetsPagesWithContext(ctx aws.Context, input *DescribeActionTargetsInput, fn func(*DescribeActionTargetsOutput, bool) bool, opts ...request.Option) error

DescribeActionTargetsPagesWithContext same as DescribeActionTargetsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DescribeActionTargetsRequest

func (c *SecurityHub) DescribeActionTargetsRequest(input *DescribeActionTargetsInput) (req *request.Request, output *DescribeActionTargetsOutput)

DescribeActionTargetsRequest generates a "aws/request.Request" representing the client's request for the DescribeActionTargets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeActionTargets for more information on using the DescribeActionTargets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeActionTargetsRequest method.
req, resp := client.DescribeActionTargetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DescribeActionTargets

func (*SecurityHub) DescribeActionTargetsWithContext

func (c *SecurityHub) DescribeActionTargetsWithContext(ctx aws.Context, input *DescribeActionTargetsInput, opts ...request.Option) (*DescribeActionTargetsOutput, error)

DescribeActionTargetsWithContext is the same as DescribeActionTargets with the addition of the ability to pass a context and additional request options.

See DescribeActionTargets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DescribeHub

func (c *SecurityHub) DescribeHub(input *DescribeHubInput) (*DescribeHubOutput, error)

DescribeHub API operation for AWS SecurityHub.

Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation DescribeHub for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DescribeHub

Example (Shared00)

To return details about Hub resource The following example returns details about the Hub resource in the calling account. The Hub resource represents the implementation of the AWS Security Hub service in the calling account.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.DescribeHubInput{
		HubArn: aws.String("arn:aws:securityhub:us-west-1:123456789012:hub/default"),
	}

	result, err := svc.DescribeHub(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) DescribeHubRequest

func (c *SecurityHub) DescribeHubRequest(input *DescribeHubInput) (req *request.Request, output *DescribeHubOutput)

DescribeHubRequest generates a "aws/request.Request" representing the client's request for the DescribeHub operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeHub for more information on using the DescribeHub API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeHubRequest method.
req, resp := client.DescribeHubRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DescribeHub

func (*SecurityHub) DescribeHubWithContext

func (c *SecurityHub) DescribeHubWithContext(ctx aws.Context, input *DescribeHubInput, opts ...request.Option) (*DescribeHubOutput, error)

DescribeHubWithContext is the same as DescribeHub with the addition of the ability to pass a context and additional request options.

See DescribeHub for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DescribeOrganizationConfiguration

DescribeOrganizationConfiguration API operation for AWS SecurityHub.

Returns information about the Organizations configuration for Security Hub. Can only be called from a Security Hub administrator account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation DescribeOrganizationConfiguration for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DescribeOrganizationConfiguration

Example (Shared00)

To get information about Organizations configuration The following example returns details about the way in which AWS Organizations is configured for a Security Hub account that belongs to an organization. Only a Security Hub administrator account can call this operation.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.DescribeOrganizationConfigurationInput{}

	result, err := svc.DescribeOrganizationConfiguration(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) DescribeOrganizationConfigurationRequest

func (c *SecurityHub) DescribeOrganizationConfigurationRequest(input *DescribeOrganizationConfigurationInput) (req *request.Request, output *DescribeOrganizationConfigurationOutput)

DescribeOrganizationConfigurationRequest generates a "aws/request.Request" representing the client's request for the DescribeOrganizationConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeOrganizationConfiguration for more information on using the DescribeOrganizationConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeOrganizationConfigurationRequest method.
req, resp := client.DescribeOrganizationConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DescribeOrganizationConfiguration

func (*SecurityHub) DescribeOrganizationConfigurationWithContext

func (c *SecurityHub) DescribeOrganizationConfigurationWithContext(ctx aws.Context, input *DescribeOrganizationConfigurationInput, opts ...request.Option) (*DescribeOrganizationConfigurationOutput, error)

DescribeOrganizationConfigurationWithContext is the same as DescribeOrganizationConfiguration with the addition of the ability to pass a context and additional request options.

See DescribeOrganizationConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DescribeProducts

func (c *SecurityHub) DescribeProducts(input *DescribeProductsInput) (*DescribeProductsOutput, error)

DescribeProducts API operation for AWS SecurityHub.

Returns information about product integrations in Security Hub.

You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration.

If you do not provide an integration ARN, then the results include all of the available product integrations.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation DescribeProducts for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DescribeProducts

Example (Shared00)

To get information about Security Hub integrations The following example returns details about AWS services and third-party products that Security Hub integrates with.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.DescribeProductsInput{
		MaxResults: aws.Int64(1),
		NextToken:  aws.String("NULL"),
		ProductArn: aws.String("arn:aws:securityhub:us-east-1:517716713836:product/crowdstrike/crowdstrike-falcon"),
	}

	result, err := svc.DescribeProducts(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) DescribeProductsPages

func (c *SecurityHub) DescribeProductsPages(input *DescribeProductsInput, fn func(*DescribeProductsOutput, bool) bool) error

DescribeProductsPages iterates over the pages of a DescribeProducts operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeProducts method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeProducts operation.
pageNum := 0
err := client.DescribeProductsPages(params,
    func(page *securityhub.DescribeProductsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecurityHub) DescribeProductsPagesWithContext

func (c *SecurityHub) DescribeProductsPagesWithContext(ctx aws.Context, input *DescribeProductsInput, fn func(*DescribeProductsOutput, bool) bool, opts ...request.Option) error

DescribeProductsPagesWithContext same as DescribeProductsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DescribeProductsRequest

func (c *SecurityHub) DescribeProductsRequest(input *DescribeProductsInput) (req *request.Request, output *DescribeProductsOutput)

DescribeProductsRequest generates a "aws/request.Request" representing the client's request for the DescribeProducts operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeProducts for more information on using the DescribeProducts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeProductsRequest method.
req, resp := client.DescribeProductsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DescribeProducts

func (*SecurityHub) DescribeProductsWithContext

func (c *SecurityHub) DescribeProductsWithContext(ctx aws.Context, input *DescribeProductsInput, opts ...request.Option) (*DescribeProductsOutput, error)

DescribeProductsWithContext is the same as DescribeProducts with the addition of the ability to pass a context and additional request options.

See DescribeProducts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DescribeStandards

func (c *SecurityHub) DescribeStandards(input *DescribeStandardsInput) (*DescribeStandardsOutput, error)

DescribeStandards API operation for AWS SecurityHub.

Returns a list of the available standards in Security Hub.

For each standard, the results include the standard ARN, the name, and a description.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation DescribeStandards for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DescribeStandards

Example (Shared00)

To get available Security Hub standards The following example returns a list of available security standards in Security Hub.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.DescribeStandardsInput{}

	result, err := svc.DescribeStandards(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) DescribeStandardsControls

func (c *SecurityHub) DescribeStandardsControls(input *DescribeStandardsControlsInput) (*DescribeStandardsControlsOutput, error)

DescribeStandardsControls API operation for AWS SecurityHub.

Returns a list of security standards controls.

For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation DescribeStandardsControls for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DescribeStandardsControls

Example (Shared00)

To get a list of controls for a security standard The following example returns a list of security controls and control details that apply to a specified security standard. The list includes controls that are enabled and disabled in the standard.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.DescribeStandardsControlsInput{
		MaxResults:               aws.Int64(2),
		NextToken:                aws.String("NULL"),
		StandardsSubscriptionArn: aws.String("arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1"),
	}

	result, err := svc.DescribeStandardsControls(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) DescribeStandardsControlsPages

func (c *SecurityHub) DescribeStandardsControlsPages(input *DescribeStandardsControlsInput, fn func(*DescribeStandardsControlsOutput, bool) bool) error

DescribeStandardsControlsPages iterates over the pages of a DescribeStandardsControls operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeStandardsControls method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeStandardsControls operation.
pageNum := 0
err := client.DescribeStandardsControlsPages(params,
    func(page *securityhub.DescribeStandardsControlsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecurityHub) DescribeStandardsControlsPagesWithContext

func (c *SecurityHub) DescribeStandardsControlsPagesWithContext(ctx aws.Context, input *DescribeStandardsControlsInput, fn func(*DescribeStandardsControlsOutput, bool) bool, opts ...request.Option) error

DescribeStandardsControlsPagesWithContext same as DescribeStandardsControlsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DescribeStandardsControlsRequest

func (c *SecurityHub) DescribeStandardsControlsRequest(input *DescribeStandardsControlsInput) (req *request.Request, output *DescribeStandardsControlsOutput)

DescribeStandardsControlsRequest generates a "aws/request.Request" representing the client's request for the DescribeStandardsControls operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStandardsControls for more information on using the DescribeStandardsControls API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeStandardsControlsRequest method.
req, resp := client.DescribeStandardsControlsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DescribeStandardsControls

func (*SecurityHub) DescribeStandardsControlsWithContext

func (c *SecurityHub) DescribeStandardsControlsWithContext(ctx aws.Context, input *DescribeStandardsControlsInput, opts ...request.Option) (*DescribeStandardsControlsOutput, error)

DescribeStandardsControlsWithContext is the same as DescribeStandardsControls with the addition of the ability to pass a context and additional request options.

See DescribeStandardsControls for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DescribeStandardsPages

func (c *SecurityHub) DescribeStandardsPages(input *DescribeStandardsInput, fn func(*DescribeStandardsOutput, bool) bool) error

DescribeStandardsPages iterates over the pages of a DescribeStandards operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeStandards method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeStandards operation.
pageNum := 0
err := client.DescribeStandardsPages(params,
    func(page *securityhub.DescribeStandardsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecurityHub) DescribeStandardsPagesWithContext

func (c *SecurityHub) DescribeStandardsPagesWithContext(ctx aws.Context, input *DescribeStandardsInput, fn func(*DescribeStandardsOutput, bool) bool, opts ...request.Option) error

DescribeStandardsPagesWithContext same as DescribeStandardsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DescribeStandardsRequest

func (c *SecurityHub) DescribeStandardsRequest(input *DescribeStandardsInput) (req *request.Request, output *DescribeStandardsOutput)

DescribeStandardsRequest generates a "aws/request.Request" representing the client's request for the DescribeStandards operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStandards for more information on using the DescribeStandards API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeStandardsRequest method.
req, resp := client.DescribeStandardsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DescribeStandards

func (*SecurityHub) DescribeStandardsWithContext

func (c *SecurityHub) DescribeStandardsWithContext(ctx aws.Context, input *DescribeStandardsInput, opts ...request.Option) (*DescribeStandardsOutput, error)

DescribeStandardsWithContext is the same as DescribeStandards with the addition of the ability to pass a context and additional request options.

See DescribeStandards for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DisableImportFindingsForProduct

DisableImportFindingsForProduct API operation for AWS SecurityHub.

Disables the integration of the specified product with Security Hub. After the integration is disabled, findings from that product are no longer sent to Security Hub.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation DisableImportFindingsForProduct for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DisableImportFindingsForProduct

Example (Shared00)

To end a Security Hub integration The following example ends an integration between Security Hub and the specified product that sends findings to Security Hub. After the integration ends, the product no longer sends findings to Security Hub.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.DisableImportFindingsForProductInput{
		ProductSubscriptionArn: aws.String("arn:aws:securityhub:us-east-1:517716713836:product/crowdstrike/crowdstrike-falcon"),
	}

	result, err := svc.DisableImportFindingsForProduct(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) DisableImportFindingsForProductRequest

func (c *SecurityHub) DisableImportFindingsForProductRequest(input *DisableImportFindingsForProductInput) (req *request.Request, output *DisableImportFindingsForProductOutput)

DisableImportFindingsForProductRequest generates a "aws/request.Request" representing the client's request for the DisableImportFindingsForProduct operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisableImportFindingsForProduct for more information on using the DisableImportFindingsForProduct API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisableImportFindingsForProductRequest method.
req, resp := client.DisableImportFindingsForProductRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DisableImportFindingsForProduct

func (*SecurityHub) DisableImportFindingsForProductWithContext

func (c *SecurityHub) DisableImportFindingsForProductWithContext(ctx aws.Context, input *DisableImportFindingsForProductInput, opts ...request.Option) (*DisableImportFindingsForProductOutput, error)

DisableImportFindingsForProductWithContext is the same as DisableImportFindingsForProduct with the addition of the ability to pass a context and additional request options.

See DisableImportFindingsForProduct for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DisableOrganizationAdminAccount

DisableOrganizationAdminAccount API operation for AWS SecurityHub.

Disables a Security Hub administrator account. Can only be called by the organization management account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation DisableOrganizationAdminAccount for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DisableOrganizationAdminAccount

Example (Shared00)

To remove a Security Hub administrator account The following example removes the Security Hub administrator account in the Region from which the operation was executed. This operation doesn't remove the delegated administrator account in AWS Organizations.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.DisableOrganizationAdminAccountInput{
		AdminAccountId: aws.String("123456789012"),
	}

	result, err := svc.DisableOrganizationAdminAccount(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) DisableOrganizationAdminAccountRequest

func (c *SecurityHub) DisableOrganizationAdminAccountRequest(input *DisableOrganizationAdminAccountInput) (req *request.Request, output *DisableOrganizationAdminAccountOutput)

DisableOrganizationAdminAccountRequest generates a "aws/request.Request" representing the client's request for the DisableOrganizationAdminAccount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisableOrganizationAdminAccount for more information on using the DisableOrganizationAdminAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisableOrganizationAdminAccountRequest method.
req, resp := client.DisableOrganizationAdminAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DisableOrganizationAdminAccount

func (*SecurityHub) DisableOrganizationAdminAccountWithContext

func (c *SecurityHub) DisableOrganizationAdminAccountWithContext(ctx aws.Context, input *DisableOrganizationAdminAccountInput, opts ...request.Option) (*DisableOrganizationAdminAccountOutput, error)

DisableOrganizationAdminAccountWithContext is the same as DisableOrganizationAdminAccount with the addition of the ability to pass a context and additional request options.

See DisableOrganizationAdminAccount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DisableSecurityHub

func (c *SecurityHub) DisableSecurityHub(input *DisableSecurityHubInput) (*DisableSecurityHubOutput, error)

DisableSecurityHub API operation for AWS SecurityHub.

Disables Security Hub in your account only in the current Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub.

When you disable Security Hub for an administrator account, it doesn't disable Security Hub for any associated member accounts.

When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and cannot be recovered. Any standards that were enabled are disabled, and your administrator and member account associations are removed.

If you want to save your existing findings, you must export them before you disable Security Hub.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation DisableSecurityHub for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DisableSecurityHub

Example (Shared00)

To deactivate Security Hub The following example deactivates Security Hub for the current account and Region.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.DisableSecurityHubInput{}

	result, err := svc.DisableSecurityHub(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) DisableSecurityHubRequest

func (c *SecurityHub) DisableSecurityHubRequest(input *DisableSecurityHubInput) (req *request.Request, output *DisableSecurityHubOutput)

DisableSecurityHubRequest generates a "aws/request.Request" representing the client's request for the DisableSecurityHub operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisableSecurityHub for more information on using the DisableSecurityHub API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisableSecurityHubRequest method.
req, resp := client.DisableSecurityHubRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DisableSecurityHub

func (*SecurityHub) DisableSecurityHubWithContext

func (c *SecurityHub) DisableSecurityHubWithContext(ctx aws.Context, input *DisableSecurityHubInput, opts ...request.Option) (*DisableSecurityHubOutput, error)

DisableSecurityHubWithContext is the same as DisableSecurityHub with the addition of the ability to pass a context and additional request options.

See DisableSecurityHub for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DisassociateFromAdministratorAccount

DisassociateFromAdministratorAccount API operation for AWS SecurityHub.

Disassociates the current Security Hub member account from the associated administrator account.

This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation DisassociateFromAdministratorAccount for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DisassociateFromAdministratorAccount

Example (Shared00)

To disassociate requesting account from administrator account The following example dissociates the requesting account from its associated administrator account.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.DisassociateFromAdministratorAccountInput{}

	result, err := svc.DisassociateFromAdministratorAccount(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) DisassociateFromAdministratorAccountRequest

func (c *SecurityHub) DisassociateFromAdministratorAccountRequest(input *DisassociateFromAdministratorAccountInput) (req *request.Request, output *DisassociateFromAdministratorAccountOutput)

DisassociateFromAdministratorAccountRequest generates a "aws/request.Request" representing the client's request for the DisassociateFromAdministratorAccount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateFromAdministratorAccount for more information on using the DisassociateFromAdministratorAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisassociateFromAdministratorAccountRequest method.
req, resp := client.DisassociateFromAdministratorAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DisassociateFromAdministratorAccount

func (*SecurityHub) DisassociateFromAdministratorAccountWithContext

func (c *SecurityHub) DisassociateFromAdministratorAccountWithContext(ctx aws.Context, input *DisassociateFromAdministratorAccountInput, opts ...request.Option) (*DisassociateFromAdministratorAccountOutput, error)

DisassociateFromAdministratorAccountWithContext is the same as DisassociateFromAdministratorAccount with the addition of the ability to pass a context and additional request options.

See DisassociateFromAdministratorAccount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) DisassociateFromMasterAccount deprecated

func (c *SecurityHub) DisassociateFromMasterAccount(input *DisassociateFromMasterAccountInput) (*DisassociateFromMasterAccountOutput, error)

DisassociateFromMasterAccount API operation for AWS SecurityHub.

This method is deprecated. Instead, use DisassociateFromAdministratorAccount.

The Security Hub console continues to use DisassociateFromMasterAccount. It will eventually change to use DisassociateFromAdministratorAccount. Any IAM policies that specifically control access to this function must continue to use DisassociateFromMasterAccount. You should also add DisassociateFromAdministratorAccount to your policies to ensure that the correct permissions are in place after the console begins to use DisassociateFromAdministratorAccount.

Disassociates the current Security Hub member account from the associated administrator account.

This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation DisassociateFromMasterAccount for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DisassociateFromMasterAccount

Deprecated: This API has been deprecated, use DisassociateFromAdministratorAccount API instead.

func (*SecurityHub) DisassociateFromMasterAccountRequest deprecated

func (c *SecurityHub) DisassociateFromMasterAccountRequest(input *DisassociateFromMasterAccountInput) (req *request.Request, output *DisassociateFromMasterAccountOutput)

DisassociateFromMasterAccountRequest generates a "aws/request.Request" representing the client's request for the DisassociateFromMasterAccount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateFromMasterAccount for more information on using the DisassociateFromMasterAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisassociateFromMasterAccountRequest method.
req, resp := client.DisassociateFromMasterAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DisassociateFromMasterAccount

Deprecated: This API has been deprecated, use DisassociateFromAdministratorAccount API instead.

func (*SecurityHub) DisassociateFromMasterAccountWithContext deprecated

func (c *SecurityHub) DisassociateFromMasterAccountWithContext(ctx aws.Context, input *DisassociateFromMasterAccountInput, opts ...request.Option) (*DisassociateFromMasterAccountOutput, error)

DisassociateFromMasterAccountWithContext is the same as DisassociateFromMasterAccount with the addition of the ability to pass a context and additional request options.

See DisassociateFromMasterAccount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: This API has been deprecated, use DisassociateFromAdministratorAccount API instead.

func (*SecurityHub) DisassociateMembers

func (c *SecurityHub) DisassociateMembers(input *DisassociateMembersInput) (*DisassociateMembersOutput, error)

DisassociateMembers API operation for AWS SecurityHub.

Disassociates the specified member accounts from the associated administrator account.

Can be used to disassociate both accounts that are managed using Organizations and accounts that were invited manually.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation DisassociateMembers for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DisassociateMembers

Example (Shared00)

To disassociate member accounts from administrator account The following example dissociates the specified member accounts from the associated administrator account.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.DisassociateMembersInput{
		AccountIds: []*string{
			aws.String("123456789012"),
			aws.String("111122223333"),
		},
	}

	result, err := svc.DisassociateMembers(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) DisassociateMembersRequest

func (c *SecurityHub) DisassociateMembersRequest(input *DisassociateMembersInput) (req *request.Request, output *DisassociateMembersOutput)

DisassociateMembersRequest generates a "aws/request.Request" representing the client's request for the DisassociateMembers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateMembers for more information on using the DisassociateMembers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisassociateMembersRequest method.
req, resp := client.DisassociateMembersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DisassociateMembers

func (*SecurityHub) DisassociateMembersWithContext

func (c *SecurityHub) DisassociateMembersWithContext(ctx aws.Context, input *DisassociateMembersInput, opts ...request.Option) (*DisassociateMembersOutput, error)

DisassociateMembersWithContext is the same as DisassociateMembers with the addition of the ability to pass a context and additional request options.

See DisassociateMembers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) EnableImportFindingsForProduct

func (c *SecurityHub) EnableImportFindingsForProduct(input *EnableImportFindingsForProductInput) (*EnableImportFindingsForProductOutput, error)

EnableImportFindingsForProduct API operation for AWS SecurityHub.

Enables the integration of a partner product with Security Hub. Integrated products send findings to Security Hub.

When you enable a product integration, a permissions policy that grants permission for the product to send findings to Security Hub is applied.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation EnableImportFindingsForProduct for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • ResourceConflictException The resource specified in the request conflicts with an existing resource.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/EnableImportFindingsForProduct

Example (Shared00)

To activate an integration The following example activates an integration between Security Hub and a third party partner product that sends findings to Security Hub.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.EnableImportFindingsForProductInput{
		ProductArn: aws.String("arn:aws:securityhub:us-east-1:517716713836:product/crowdstrike/crowdstrike-falcon"),
	}

	result, err := svc.EnableImportFindingsForProduct(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeResourceConflictException:
				fmt.Println(securityhub.ErrCodeResourceConflictException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) EnableImportFindingsForProductRequest

func (c *SecurityHub) EnableImportFindingsForProductRequest(input *EnableImportFindingsForProductInput) (req *request.Request, output *EnableImportFindingsForProductOutput)

EnableImportFindingsForProductRequest generates a "aws/request.Request" representing the client's request for the EnableImportFindingsForProduct operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See EnableImportFindingsForProduct for more information on using the EnableImportFindingsForProduct API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the EnableImportFindingsForProductRequest method.
req, resp := client.EnableImportFindingsForProductRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/EnableImportFindingsForProduct

func (*SecurityHub) EnableImportFindingsForProductWithContext

func (c *SecurityHub) EnableImportFindingsForProductWithContext(ctx aws.Context, input *EnableImportFindingsForProductInput, opts ...request.Option) (*EnableImportFindingsForProductOutput, error)

EnableImportFindingsForProductWithContext is the same as EnableImportFindingsForProduct with the addition of the ability to pass a context and additional request options.

See EnableImportFindingsForProduct for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) EnableOrganizationAdminAccount

func (c *SecurityHub) EnableOrganizationAdminAccount(input *EnableOrganizationAdminAccountInput) (*EnableOrganizationAdminAccountOutput, error)

EnableOrganizationAdminAccount API operation for AWS SecurityHub.

Designates the Security Hub administrator account for an organization. Can only be called by the organization management account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation EnableOrganizationAdminAccount for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/EnableOrganizationAdminAccount

Example (Shared00)

To designate a Security Hub administrator The following example designates the specified account as the Security Hub administrator account. The requesting account must be the organization management account.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.EnableOrganizationAdminAccountInput{
		AdminAccountId: aws.String("123456789012"),
	}

	result, err := svc.EnableOrganizationAdminAccount(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) EnableOrganizationAdminAccountRequest

func (c *SecurityHub) EnableOrganizationAdminAccountRequest(input *EnableOrganizationAdminAccountInput) (req *request.Request, output *EnableOrganizationAdminAccountOutput)

EnableOrganizationAdminAccountRequest generates a "aws/request.Request" representing the client's request for the EnableOrganizationAdminAccount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See EnableOrganizationAdminAccount for more information on using the EnableOrganizationAdminAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the EnableOrganizationAdminAccountRequest method.
req, resp := client.EnableOrganizationAdminAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/EnableOrganizationAdminAccount

func (*SecurityHub) EnableOrganizationAdminAccountWithContext

func (c *SecurityHub) EnableOrganizationAdminAccountWithContext(ctx aws.Context, input *EnableOrganizationAdminAccountInput, opts ...request.Option) (*EnableOrganizationAdminAccountOutput, error)

EnableOrganizationAdminAccountWithContext is the same as EnableOrganizationAdminAccount with the addition of the ability to pass a context and additional request options.

See EnableOrganizationAdminAccount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) EnableSecurityHub

func (c *SecurityHub) EnableSecurityHub(input *EnableSecurityHubInput) (*EnableSecurityHubOutput, error)

EnableSecurityHub API operation for AWS SecurityHub.

Enables Security Hub for your account in the current Region or the Region you specify in the request.

When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from other services that are integrated with Security Hub.

When you use the EnableSecurityHub operation to enable Security Hub, you also automatically enable the following standards:

  • Center for Internet Security (CIS) Amazon Web Services Foundations Benchmark v1.2.0

  • Amazon Web Services Foundational Security Best Practices

Other standards are not automatically enabled.

To opt out of automatically enabled standards, set EnableDefaultStandards to false.

After you enable Security Hub, to enable a standard, use the BatchEnableStandards operation. To disable a standard, use the BatchDisableStandards operation.

To learn more, see the setup information (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-settingup.html) in the Security Hub User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation EnableSecurityHub for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • ResourceConflictException The resource specified in the request conflicts with an existing resource.

  • AccessDeniedException You don't have permission to perform the action specified in the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/EnableSecurityHub

Example (Shared00)

To activate Security Hub The following example activates the Security Hub service in the requesting AWS account. The service is activated in the current AWS Region or the Region that you specify in the request. Some standards are automatically turned on in your account unless you opt out. To determine which standards are automatically turned on, see the Security Hub documentation.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.EnableSecurityHubInput{
		EnableDefaultStandards: aws.Bool(true),
		Tags: map[string]*string{
			"Department": aws.String("Security"),
		},
	}

	result, err := svc.EnableSecurityHub(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeResourceConflictException:
				fmt.Println(securityhub.ErrCodeResourceConflictException, aerr.Error())
			case securityhub.ErrCodeAccessDeniedException:
				fmt.Println(securityhub.ErrCodeAccessDeniedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) EnableSecurityHubRequest

func (c *SecurityHub) EnableSecurityHubRequest(input *EnableSecurityHubInput) (req *request.Request, output *EnableSecurityHubOutput)

EnableSecurityHubRequest generates a "aws/request.Request" representing the client's request for the EnableSecurityHub operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See EnableSecurityHub for more information on using the EnableSecurityHub API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the EnableSecurityHubRequest method.
req, resp := client.EnableSecurityHubRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/EnableSecurityHub

func (*SecurityHub) EnableSecurityHubWithContext

func (c *SecurityHub) EnableSecurityHubWithContext(ctx aws.Context, input *EnableSecurityHubInput, opts ...request.Option) (*EnableSecurityHubOutput, error)

EnableSecurityHubWithContext is the same as EnableSecurityHub with the addition of the ability to pass a context and additional request options.

See EnableSecurityHub for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) GetAdministratorAccount

func (c *SecurityHub) GetAdministratorAccount(input *GetAdministratorAccountInput) (*GetAdministratorAccountOutput, error)

GetAdministratorAccount API operation for AWS SecurityHub.

Provides the details for the Security Hub administrator account for the current member account.

Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation GetAdministratorAccount for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetAdministratorAccount

Example (Shared00)

To get details about the Security Hub administrator account The following example provides details about the Security Hub administrator account for the requesting member account.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.GetAdministratorAccountInput{}

	result, err := svc.GetAdministratorAccount(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) GetAdministratorAccountRequest

func (c *SecurityHub) GetAdministratorAccountRequest(input *GetAdministratorAccountInput) (req *request.Request, output *GetAdministratorAccountOutput)

GetAdministratorAccountRequest generates a "aws/request.Request" representing the client's request for the GetAdministratorAccount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAdministratorAccount for more information on using the GetAdministratorAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetAdministratorAccountRequest method.
req, resp := client.GetAdministratorAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetAdministratorAccount

func (*SecurityHub) GetAdministratorAccountWithContext

func (c *SecurityHub) GetAdministratorAccountWithContext(ctx aws.Context, input *GetAdministratorAccountInput, opts ...request.Option) (*GetAdministratorAccountOutput, error)

GetAdministratorAccountWithContext is the same as GetAdministratorAccount with the addition of the ability to pass a context and additional request options.

See GetAdministratorAccount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) GetEnabledStandards

func (c *SecurityHub) GetEnabledStandards(input *GetEnabledStandardsInput) (*GetEnabledStandardsOutput, error)

GetEnabledStandards API operation for AWS SecurityHub.

Returns a list of the standards that are currently enabled.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation GetEnabledStandards for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetEnabledStandards

Example (Shared00)

To return a list of enabled standards The following example returns a list of Security Hub standards that are currently enabled in your account.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.GetEnabledStandardsInput{
		StandardsSubscriptionArns: []*string{
			aws.String("arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1"),
		},
	}

	result, err := svc.GetEnabledStandards(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) GetEnabledStandardsPages

func (c *SecurityHub) GetEnabledStandardsPages(input *GetEnabledStandardsInput, fn func(*GetEnabledStandardsOutput, bool) bool) error

GetEnabledStandardsPages iterates over the pages of a GetEnabledStandards operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetEnabledStandards method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetEnabledStandards operation.
pageNum := 0
err := client.GetEnabledStandardsPages(params,
    func(page *securityhub.GetEnabledStandardsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecurityHub) GetEnabledStandardsPagesWithContext

func (c *SecurityHub) GetEnabledStandardsPagesWithContext(ctx aws.Context, input *GetEnabledStandardsInput, fn func(*GetEnabledStandardsOutput, bool) bool, opts ...request.Option) error

GetEnabledStandardsPagesWithContext same as GetEnabledStandardsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) GetEnabledStandardsRequest

func (c *SecurityHub) GetEnabledStandardsRequest(input *GetEnabledStandardsInput) (req *request.Request, output *GetEnabledStandardsOutput)

GetEnabledStandardsRequest generates a "aws/request.Request" representing the client's request for the GetEnabledStandards operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetEnabledStandards for more information on using the GetEnabledStandards API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetEnabledStandardsRequest method.
req, resp := client.GetEnabledStandardsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetEnabledStandards

func (*SecurityHub) GetEnabledStandardsWithContext

func (c *SecurityHub) GetEnabledStandardsWithContext(ctx aws.Context, input *GetEnabledStandardsInput, opts ...request.Option) (*GetEnabledStandardsOutput, error)

GetEnabledStandardsWithContext is the same as GetEnabledStandards with the addition of the ability to pass a context and additional request options.

See GetEnabledStandards for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) GetFindingAggregator

func (c *SecurityHub) GetFindingAggregator(input *GetFindingAggregatorInput) (*GetFindingAggregatorOutput, error)

GetFindingAggregator API operation for AWS SecurityHub.

Returns the current finding aggregation configuration.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation GetFindingAggregator for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • AccessDeniedException You don't have permission to perform the action specified in the request.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetFindingAggregator

Example (Shared00)

To get cross-Region aggregation details The following example returns cross-Region aggregation details for the requesting account.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.GetFindingAggregatorInput{
		FindingAggregatorArn: aws.String("arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"),
	}

	result, err := svc.GetFindingAggregator(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeAccessDeniedException:
				fmt.Println(securityhub.ErrCodeAccessDeniedException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) GetFindingAggregatorRequest

func (c *SecurityHub) GetFindingAggregatorRequest(input *GetFindingAggregatorInput) (req *request.Request, output *GetFindingAggregatorOutput)

GetFindingAggregatorRequest generates a "aws/request.Request" representing the client's request for the GetFindingAggregator operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetFindingAggregator for more information on using the GetFindingAggregator API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetFindingAggregatorRequest method.
req, resp := client.GetFindingAggregatorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetFindingAggregator

func (*SecurityHub) GetFindingAggregatorWithContext

func (c *SecurityHub) GetFindingAggregatorWithContext(ctx aws.Context, input *GetFindingAggregatorInput, opts ...request.Option) (*GetFindingAggregatorOutput, error)

GetFindingAggregatorWithContext is the same as GetFindingAggregator with the addition of the ability to pass a context and additional request options.

See GetFindingAggregator for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) GetFindingHistory added in v1.42.9

func (c *SecurityHub) GetFindingHistory(input *GetFindingHistoryInput) (*GetFindingHistoryOutput, error)

GetFindingHistory API operation for AWS SecurityHub.

Returns history for a Security Hub finding in the last 90 days. The history includes changes made to any fields in the Amazon Web Services Security Finding Format (ASFF).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation GetFindingHistory for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetFindingHistory

Example (Shared00)

To get finding history The following example retrieves the history of the specified finding during the specified time frame. If the time frame permits, Security Hub returns finding history for the last 90 days.

package main

import (
	"fmt"
	"time"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func parseTime(layout, value string) *time.Time {
	t, err := time.Parse(layout, value)
	if err != nil {
		panic(err)
	}
	return &t
}

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.GetFindingHistoryInput{
		EndTime: parseTime("2006-01-02T15:04:05.999999999Z", "2021-09-31T15:53:35.573Z"),
		FindingIdentifier: &securityhub.AwsSecurityFindingIdentifier{
			Id:         aws.String("a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"),
			ProductArn: aws.String("arn:aws:securityhub:us-west-2:123456789012:product/123456789012/default"),
		},
		MaxResults: aws.Int64(2),
		StartTime:  parseTime("2006-01-02T15:04:05.999999999Z", "2021-09-30T15:53:35.573Z"),
	}

	result, err := svc.GetFindingHistory(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) GetFindingHistoryPages added in v1.42.9

func (c *SecurityHub) GetFindingHistoryPages(input *GetFindingHistoryInput, fn func(*GetFindingHistoryOutput, bool) bool) error

GetFindingHistoryPages iterates over the pages of a GetFindingHistory operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetFindingHistory method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetFindingHistory operation.
pageNum := 0
err := client.GetFindingHistoryPages(params,
    func(page *securityhub.GetFindingHistoryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecurityHub) GetFindingHistoryPagesWithContext added in v1.42.9

func (c *SecurityHub) GetFindingHistoryPagesWithContext(ctx aws.Context, input *GetFindingHistoryInput, fn func(*GetFindingHistoryOutput, bool) bool, opts ...request.Option) error

GetFindingHistoryPagesWithContext same as GetFindingHistoryPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) GetFindingHistoryRequest added in v1.42.9

func (c *SecurityHub) GetFindingHistoryRequest(input *GetFindingHistoryInput) (req *request.Request, output *GetFindingHistoryOutput)

GetFindingHistoryRequest generates a "aws/request.Request" representing the client's request for the GetFindingHistory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetFindingHistory for more information on using the GetFindingHistory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetFindingHistoryRequest method.
req, resp := client.GetFindingHistoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetFindingHistory

func (*SecurityHub) GetFindingHistoryWithContext added in v1.42.9

func (c *SecurityHub) GetFindingHistoryWithContext(ctx aws.Context, input *GetFindingHistoryInput, opts ...request.Option) (*GetFindingHistoryOutput, error)

GetFindingHistoryWithContext is the same as GetFindingHistory with the addition of the ability to pass a context and additional request options.

See GetFindingHistory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) GetFindings

func (c *SecurityHub) GetFindings(input *GetFindingsInput) (*GetFindingsOutput, error)

GetFindings API operation for AWS SecurityHub.

Returns a list of findings that match the specified criteria.

If finding aggregation is enabled, then when you call GetFindings from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation GetFindings for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetFindings

Example (Shared00)

To get a list of findings The following example returns a filtered and sorted list of Security Hub findings.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.GetFindingsInput{
		Filters: &securityhub.AwsSecurityFindingFilters{
			AwsAccountId: []*securityhub.StringFilter{
				{
					Comparison: aws.String("PREFIX"),
					Value:      aws.String("123456789012"),
				},
			},
		},
		MaxResults: aws.Int64(1),
	}

	result, err := svc.GetFindings(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) GetFindingsPages

func (c *SecurityHub) GetFindingsPages(input *GetFindingsInput, fn func(*GetFindingsOutput, bool) bool) error

GetFindingsPages iterates over the pages of a GetFindings operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetFindings method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetFindings operation.
pageNum := 0
err := client.GetFindingsPages(params,
    func(page *securityhub.GetFindingsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecurityHub) GetFindingsPagesWithContext

func (c *SecurityHub) GetFindingsPagesWithContext(ctx aws.Context, input *GetFindingsInput, fn func(*GetFindingsOutput, bool) bool, opts ...request.Option) error

GetFindingsPagesWithContext same as GetFindingsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) GetFindingsRequest

func (c *SecurityHub) GetFindingsRequest(input *GetFindingsInput) (req *request.Request, output *GetFindingsOutput)

GetFindingsRequest generates a "aws/request.Request" representing the client's request for the GetFindings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetFindings for more information on using the GetFindings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetFindingsRequest method.
req, resp := client.GetFindingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetFindings

func (*SecurityHub) GetFindingsWithContext

func (c *SecurityHub) GetFindingsWithContext(ctx aws.Context, input *GetFindingsInput, opts ...request.Option) (*GetFindingsOutput, error)

GetFindingsWithContext is the same as GetFindings with the addition of the ability to pass a context and additional request options.

See GetFindings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) GetInsightResults

func (c *SecurityHub) GetInsightResults(input *GetInsightResultsInput) (*GetInsightResultsOutput, error)

GetInsightResults API operation for AWS SecurityHub.

Lists the results of the Security Hub insight specified by the insight ARN.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation GetInsightResults for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetInsightResults

Example (Shared00)

To get the results of a Security Hub insight The following example returns the results of the Security Hub insight specified by the insight ARN.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.GetInsightResultsInput{
		InsightArn: aws.String("arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"),
	}

	result, err := svc.GetInsightResults(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) GetInsightResultsRequest

func (c *SecurityHub) GetInsightResultsRequest(input *GetInsightResultsInput) (req *request.Request, output *GetInsightResultsOutput)

GetInsightResultsRequest generates a "aws/request.Request" representing the client's request for the GetInsightResults operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInsightResults for more information on using the GetInsightResults API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInsightResultsRequest method.
req, resp := client.GetInsightResultsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetInsightResults

func (*SecurityHub) GetInsightResultsWithContext

func (c *SecurityHub) GetInsightResultsWithContext(ctx aws.Context, input *GetInsightResultsInput, opts ...request.Option) (*GetInsightResultsOutput, error)

GetInsightResultsWithContext is the same as GetInsightResults with the addition of the ability to pass a context and additional request options.

See GetInsightResults for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) GetInsights

func (c *SecurityHub) GetInsights(input *GetInsightsInput) (*GetInsightsOutput, error)

GetInsights API operation for AWS SecurityHub.

Lists and describes insights for the specified insight ARNs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation GetInsights for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetInsights

Example (Shared00)

To get details of a Security Hub insight The following example returns details of the Security Hub insight with the specified ARN.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.GetInsightsInput{
		InsightArns: []*string{
			aws.String("arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"),
		},
	}

	result, err := svc.GetInsights(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) GetInsightsPages

func (c *SecurityHub) GetInsightsPages(input *GetInsightsInput, fn func(*GetInsightsOutput, bool) bool) error

GetInsightsPages iterates over the pages of a GetInsights operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetInsights method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetInsights operation.
pageNum := 0
err := client.GetInsightsPages(params,
    func(page *securityhub.GetInsightsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecurityHub) GetInsightsPagesWithContext

func (c *SecurityHub) GetInsightsPagesWithContext(ctx aws.Context, input *GetInsightsInput, fn func(*GetInsightsOutput, bool) bool, opts ...request.Option) error

GetInsightsPagesWithContext same as GetInsightsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) GetInsightsRequest

func (c *SecurityHub) GetInsightsRequest(input *GetInsightsInput) (req *request.Request, output *GetInsightsOutput)

GetInsightsRequest generates a "aws/request.Request" representing the client's request for the GetInsights operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInsights for more information on using the GetInsights API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInsightsRequest method.
req, resp := client.GetInsightsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetInsights

func (*SecurityHub) GetInsightsWithContext

func (c *SecurityHub) GetInsightsWithContext(ctx aws.Context, input *GetInsightsInput, opts ...request.Option) (*GetInsightsOutput, error)

GetInsightsWithContext is the same as GetInsights with the addition of the ability to pass a context and additional request options.

See GetInsights for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) GetInvitationsCount

func (c *SecurityHub) GetInvitationsCount(input *GetInvitationsCountInput) (*GetInvitationsCountOutput, error)

GetInvitationsCount API operation for AWS SecurityHub.

Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation GetInvitationsCount for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetInvitationsCount

Example (Shared00)

To get a count of membership invitations The following example returns a count of invitations that the Security Hub administrator sent to the current member account, not including the currently accepted invitation.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.GetInvitationsCountInput{}

	result, err := svc.GetInvitationsCount(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) GetInvitationsCountRequest

func (c *SecurityHub) GetInvitationsCountRequest(input *GetInvitationsCountInput) (req *request.Request, output *GetInvitationsCountOutput)

GetInvitationsCountRequest generates a "aws/request.Request" representing the client's request for the GetInvitationsCount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInvitationsCount for more information on using the GetInvitationsCount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInvitationsCountRequest method.
req, resp := client.GetInvitationsCountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetInvitationsCount

func (*SecurityHub) GetInvitationsCountWithContext

func (c *SecurityHub) GetInvitationsCountWithContext(ctx aws.Context, input *GetInvitationsCountInput, opts ...request.Option) (*GetInvitationsCountOutput, error)

GetInvitationsCountWithContext is the same as GetInvitationsCount with the addition of the ability to pass a context and additional request options.

See GetInvitationsCount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) GetMasterAccount deprecated

func (c *SecurityHub) GetMasterAccount(input *GetMasterAccountInput) (*GetMasterAccountOutput, error)

GetMasterAccount API operation for AWS SecurityHub.

This method is deprecated. Instead, use GetAdministratorAccount.

The Security Hub console continues to use GetMasterAccount. It will eventually change to use GetAdministratorAccount. Any IAM policies that specifically control access to this function must continue to use GetMasterAccount. You should also add GetAdministratorAccount to your policies to ensure that the correct permissions are in place after the console begins to use GetAdministratorAccount.

Provides the details for the Security Hub administrator account for the current member account.

Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation GetMasterAccount for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetMasterAccount

Deprecated: This API has been deprecated, use GetAdministratorAccount API instead.

func (*SecurityHub) GetMasterAccountRequest deprecated

func (c *SecurityHub) GetMasterAccountRequest(input *GetMasterAccountInput) (req *request.Request, output *GetMasterAccountOutput)

GetMasterAccountRequest generates a "aws/request.Request" representing the client's request for the GetMasterAccount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMasterAccount for more information on using the GetMasterAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetMasterAccountRequest method.
req, resp := client.GetMasterAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetMasterAccount

Deprecated: This API has been deprecated, use GetAdministratorAccount API instead.

func (*SecurityHub) GetMasterAccountWithContext deprecated

func (c *SecurityHub) GetMasterAccountWithContext(ctx aws.Context, input *GetMasterAccountInput, opts ...request.Option) (*GetMasterAccountOutput, error)

GetMasterAccountWithContext is the same as GetMasterAccount with the addition of the ability to pass a context and additional request options.

See GetMasterAccount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: This API has been deprecated, use GetAdministratorAccount API instead.

func (*SecurityHub) GetMembers

func (c *SecurityHub) GetMembers(input *GetMembersInput) (*GetMembersOutput, error)

GetMembers API operation for AWS SecurityHub.

Returns the details for the Security Hub member accounts for the specified account IDs.

An administrator account can be either the delegated Security Hub administrator account for an organization or an administrator account that enabled Security Hub manually.

The results include both member accounts that are managed using Organizations and accounts that were invited manually.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation GetMembers for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetMembers

Example (Shared00)

To get member account details The following example returns details for the Security Hub member accounts with the specified AWS account IDs. An administrator account may be the delegated Security Hub administrator account for an organization or an administrator account that enabled Security Hub manually. The Security Hub administrator must call this operation.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.GetMembersInput{
		AccountIds: []*string{
			aws.String("444455556666"),
			aws.String("777788889999"),
		},
	}

	result, err := svc.GetMembers(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) GetMembersRequest

func (c *SecurityHub) GetMembersRequest(input *GetMembersInput) (req *request.Request, output *GetMembersOutput)

GetMembersRequest generates a "aws/request.Request" representing the client's request for the GetMembers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMembers for more information on using the GetMembers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetMembersRequest method.
req, resp := client.GetMembersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetMembers

func (*SecurityHub) GetMembersWithContext

func (c *SecurityHub) GetMembersWithContext(ctx aws.Context, input *GetMembersInput, opts ...request.Option) (*GetMembersOutput, error)

GetMembersWithContext is the same as GetMembers with the addition of the ability to pass a context and additional request options.

See GetMembers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) InviteMembers

func (c *SecurityHub) InviteMembers(input *InviteMembersInput) (*InviteMembersOutput, error)

InviteMembers API operation for AWS SecurityHub.

Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.

This operation is only used to invite accounts that do not belong to an organization. Organization accounts do not receive invitations.

Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub.

When the account owner enables Security Hub and accepts the invitation to become a member account, the administrator account can view the findings generated from the member account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation InviteMembers for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/InviteMembers

Example (Shared00)

To invite accounts to become members The following example invites the specified AWS accounts to become member accounts associated with the calling Security Hub administrator account. You only use this operation to invite accounts that don't belong to an AWS Organizations organization.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.InviteMembersInput{
		AccountIds: []*string{
			aws.String("111122223333"),
			aws.String("444455556666"),
		},
	}

	result, err := svc.InviteMembers(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) InviteMembersRequest

func (c *SecurityHub) InviteMembersRequest(input *InviteMembersInput) (req *request.Request, output *InviteMembersOutput)

InviteMembersRequest generates a "aws/request.Request" representing the client's request for the InviteMembers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See InviteMembers for more information on using the InviteMembers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the InviteMembersRequest method.
req, resp := client.InviteMembersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/InviteMembers

func (*SecurityHub) InviteMembersWithContext

func (c *SecurityHub) InviteMembersWithContext(ctx aws.Context, input *InviteMembersInput, opts ...request.Option) (*InviteMembersOutput, error)

InviteMembersWithContext is the same as InviteMembers with the addition of the ability to pass a context and additional request options.

See InviteMembers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) ListAutomationRules added in v1.42.9

func (c *SecurityHub) ListAutomationRules(input *ListAutomationRulesInput) (*ListAutomationRulesOutput, error)

ListAutomationRules API operation for AWS SecurityHub.

A list of automation rules and their metadata for the calling account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation ListAutomationRules for usage and error information.

Returned Error Types:

  • AccessDeniedException You don't have permission to perform the action specified in the request.

  • InternalException Internal server error.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListAutomationRules

Example (Shared00)

To list automation rules The following example lists automation rules and rule metadata in the calling account.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.ListAutomationRulesInput{
		MaxResults: aws.Int64(2),
		NextToken:  aws.String("example-token"),
	}

	result, err := svc.ListAutomationRules(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeAccessDeniedException:
				fmt.Println(securityhub.ErrCodeAccessDeniedException, aerr.Error())
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) ListAutomationRulesRequest added in v1.42.9

func (c *SecurityHub) ListAutomationRulesRequest(input *ListAutomationRulesInput) (req *request.Request, output *ListAutomationRulesOutput)

ListAutomationRulesRequest generates a "aws/request.Request" representing the client's request for the ListAutomationRules operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAutomationRules for more information on using the ListAutomationRules API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAutomationRulesRequest method.
req, resp := client.ListAutomationRulesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListAutomationRules

func (*SecurityHub) ListAutomationRulesWithContext added in v1.42.9

func (c *SecurityHub) ListAutomationRulesWithContext(ctx aws.Context, input *ListAutomationRulesInput, opts ...request.Option) (*ListAutomationRulesOutput, error)

ListAutomationRulesWithContext is the same as ListAutomationRules with the addition of the ability to pass a context and additional request options.

See ListAutomationRules for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) ListEnabledProductsForImport

func (c *SecurityHub) ListEnabledProductsForImport(input *ListEnabledProductsForImportInput) (*ListEnabledProductsForImportOutput, error)

ListEnabledProductsForImport API operation for AWS SecurityHub.

Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation ListEnabledProductsForImport for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListEnabledProductsForImport

Example (Shared00)

To list ARNs for enabled integrations The following example returns a list of subscription Amazon Resource Names (ARNs) for the product integrations that you have currently enabled in Security Hub.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.ListEnabledProductsForImportInput{}

	result, err := svc.ListEnabledProductsForImport(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) ListEnabledProductsForImportPages

func (c *SecurityHub) ListEnabledProductsForImportPages(input *ListEnabledProductsForImportInput, fn func(*ListEnabledProductsForImportOutput, bool) bool) error

ListEnabledProductsForImportPages iterates over the pages of a ListEnabledProductsForImport operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListEnabledProductsForImport method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListEnabledProductsForImport operation.
pageNum := 0
err := client.ListEnabledProductsForImportPages(params,
    func(page *securityhub.ListEnabledProductsForImportOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecurityHub) ListEnabledProductsForImportPagesWithContext

func (c *SecurityHub) ListEnabledProductsForImportPagesWithContext(ctx aws.Context, input *ListEnabledProductsForImportInput, fn func(*ListEnabledProductsForImportOutput, bool) bool, opts ...request.Option) error

ListEnabledProductsForImportPagesWithContext same as ListEnabledProductsForImportPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) ListEnabledProductsForImportRequest

func (c *SecurityHub) ListEnabledProductsForImportRequest(input *ListEnabledProductsForImportInput) (req *request.Request, output *ListEnabledProductsForImportOutput)

ListEnabledProductsForImportRequest generates a "aws/request.Request" representing the client's request for the ListEnabledProductsForImport operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEnabledProductsForImport for more information on using the ListEnabledProductsForImport API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListEnabledProductsForImportRequest method.
req, resp := client.ListEnabledProductsForImportRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListEnabledProductsForImport

func (*SecurityHub) ListEnabledProductsForImportWithContext

func (c *SecurityHub) ListEnabledProductsForImportWithContext(ctx aws.Context, input *ListEnabledProductsForImportInput, opts ...request.Option) (*ListEnabledProductsForImportOutput, error)

ListEnabledProductsForImportWithContext is the same as ListEnabledProductsForImport with the addition of the ability to pass a context and additional request options.

See ListEnabledProductsForImport for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) ListFindingAggregators

func (c *SecurityHub) ListFindingAggregators(input *ListFindingAggregatorsInput) (*ListFindingAggregatorsOutput, error)

ListFindingAggregators API operation for AWS SecurityHub.

If finding aggregation is enabled, then ListFindingAggregators returns the ARN of the finding aggregator. You can run this operation from any Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation ListFindingAggregators for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • AccessDeniedException You don't have permission to perform the action specified in the request.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListFindingAggregators

Example (Shared00)

To update the enablement status of a standard control The following example disables the specified control in the specified security standard.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.ListFindingAggregatorsInput{}

	result, err := svc.ListFindingAggregators(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeAccessDeniedException:
				fmt.Println(securityhub.ErrCodeAccessDeniedException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) ListFindingAggregatorsPages

func (c *SecurityHub) ListFindingAggregatorsPages(input *ListFindingAggregatorsInput, fn func(*ListFindingAggregatorsOutput, bool) bool) error

ListFindingAggregatorsPages iterates over the pages of a ListFindingAggregators operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFindingAggregators method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListFindingAggregators operation.
pageNum := 0
err := client.ListFindingAggregatorsPages(params,
    func(page *securityhub.ListFindingAggregatorsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecurityHub) ListFindingAggregatorsPagesWithContext

func (c *SecurityHub) ListFindingAggregatorsPagesWithContext(ctx aws.Context, input *ListFindingAggregatorsInput, fn func(*ListFindingAggregatorsOutput, bool) bool, opts ...request.Option) error

ListFindingAggregatorsPagesWithContext same as ListFindingAggregatorsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) ListFindingAggregatorsRequest

func (c *SecurityHub) ListFindingAggregatorsRequest(input *ListFindingAggregatorsInput) (req *request.Request, output *ListFindingAggregatorsOutput)

ListFindingAggregatorsRequest generates a "aws/request.Request" representing the client's request for the ListFindingAggregators operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFindingAggregators for more information on using the ListFindingAggregators API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListFindingAggregatorsRequest method.
req, resp := client.ListFindingAggregatorsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListFindingAggregators

func (*SecurityHub) ListFindingAggregatorsWithContext

func (c *SecurityHub) ListFindingAggregatorsWithContext(ctx aws.Context, input *ListFindingAggregatorsInput, opts ...request.Option) (*ListFindingAggregatorsOutput, error)

ListFindingAggregatorsWithContext is the same as ListFindingAggregators with the addition of the ability to pass a context and additional request options.

See ListFindingAggregators for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) ListInvitations

func (c *SecurityHub) ListInvitations(input *ListInvitationsInput) (*ListInvitationsOutput, error)

ListInvitations API operation for AWS SecurityHub.

Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.

This operation is only used by accounts that are managed by invitation. Accounts that are managed using the integration with Organizations do not receive invitations.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation ListInvitations for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListInvitations

Example (Shared00)

To list membership invitations to calling account The following example returns a list of Security Hub member invitations sent to the calling AWS account. Only accounts that are invited manually use this operation. It's not for use by accounts that are managed through AWS Organizations.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.ListInvitationsInput{}

	result, err := svc.ListInvitations(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) ListInvitationsPages

func (c *SecurityHub) ListInvitationsPages(input *ListInvitationsInput, fn func(*ListInvitationsOutput, bool) bool) error

ListInvitationsPages iterates over the pages of a ListInvitations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListInvitations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListInvitations operation.
pageNum := 0
err := client.ListInvitationsPages(params,
    func(page *securityhub.ListInvitationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecurityHub) ListInvitationsPagesWithContext

func (c *SecurityHub) ListInvitationsPagesWithContext(ctx aws.Context, input *ListInvitationsInput, fn func(*ListInvitationsOutput, bool) bool, opts ...request.Option) error

ListInvitationsPagesWithContext same as ListInvitationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) ListInvitationsRequest

func (c *SecurityHub) ListInvitationsRequest(input *ListInvitationsInput) (req *request.Request, output *ListInvitationsOutput)

ListInvitationsRequest generates a "aws/request.Request" representing the client's request for the ListInvitations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListInvitations for more information on using the ListInvitations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListInvitationsRequest method.
req, resp := client.ListInvitationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListInvitations

func (*SecurityHub) ListInvitationsWithContext

func (c *SecurityHub) ListInvitationsWithContext(ctx aws.Context, input *ListInvitationsInput, opts ...request.Option) (*ListInvitationsOutput, error)

ListInvitationsWithContext is the same as ListInvitations with the addition of the ability to pass a context and additional request options.

See ListInvitations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) ListMembers

func (c *SecurityHub) ListMembers(input *ListMembersInput) (*ListMembersOutput, error)

ListMembers API operation for AWS SecurityHub.

Lists details about all member accounts for the current Security Hub administrator account.

The results include both member accounts that belong to an organization and member accounts that were invited manually.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation ListMembers for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListMembers

Example (Shared00)

To list member account details The following example returns details about member accounts for the calling Security Hub administrator account. The response includes member accounts that are managed through AWS Organizations and those that were invited manually.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.ListMembersInput{}

	result, err := svc.ListMembers(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) ListMembersPages

func (c *SecurityHub) ListMembersPages(input *ListMembersInput, fn func(*ListMembersOutput, bool) bool) error

ListMembersPages iterates over the pages of a ListMembers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListMembers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListMembers operation.
pageNum := 0
err := client.ListMembersPages(params,
    func(page *securityhub.ListMembersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecurityHub) ListMembersPagesWithContext

func (c *SecurityHub) ListMembersPagesWithContext(ctx aws.Context, input *ListMembersInput, fn func(*ListMembersOutput, bool) bool, opts ...request.Option) error

ListMembersPagesWithContext same as ListMembersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) ListMembersRequest

func (c *SecurityHub) ListMembersRequest(input *ListMembersInput) (req *request.Request, output *ListMembersOutput)

ListMembersRequest generates a "aws/request.Request" representing the client's request for the ListMembers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListMembers for more information on using the ListMembers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListMembersRequest method.
req, resp := client.ListMembersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListMembers

func (*SecurityHub) ListMembersWithContext

func (c *SecurityHub) ListMembersWithContext(ctx aws.Context, input *ListMembersInput, opts ...request.Option) (*ListMembersOutput, error)

ListMembersWithContext is the same as ListMembers with the addition of the ability to pass a context and additional request options.

See ListMembers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) ListOrganizationAdminAccounts

func (c *SecurityHub) ListOrganizationAdminAccounts(input *ListOrganizationAdminAccountsInput) (*ListOrganizationAdminAccountsOutput, error)

ListOrganizationAdminAccounts API operation for AWS SecurityHub.

Lists the Security Hub administrator accounts. Can only be called by the organization management account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation ListOrganizationAdminAccounts for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListOrganizationAdminAccounts

Example (Shared00)

To list administrator acccounts for an organization The following example lists the Security Hub administrator accounts for an organization. Only the organization management account can call this operation.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.ListOrganizationAdminAccountsInput{}

	result, err := svc.ListOrganizationAdminAccounts(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) ListOrganizationAdminAccountsPages

func (c *SecurityHub) ListOrganizationAdminAccountsPages(input *ListOrganizationAdminAccountsInput, fn func(*ListOrganizationAdminAccountsOutput, bool) bool) error

ListOrganizationAdminAccountsPages iterates over the pages of a ListOrganizationAdminAccounts operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListOrganizationAdminAccounts method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListOrganizationAdminAccounts operation.
pageNum := 0
err := client.ListOrganizationAdminAccountsPages(params,
    func(page *securityhub.ListOrganizationAdminAccountsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecurityHub) ListOrganizationAdminAccountsPagesWithContext

func (c *SecurityHub) ListOrganizationAdminAccountsPagesWithContext(ctx aws.Context, input *ListOrganizationAdminAccountsInput, fn func(*ListOrganizationAdminAccountsOutput, bool) bool, opts ...request.Option) error

ListOrganizationAdminAccountsPagesWithContext same as ListOrganizationAdminAccountsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) ListOrganizationAdminAccountsRequest

func (c *SecurityHub) ListOrganizationAdminAccountsRequest(input *ListOrganizationAdminAccountsInput) (req *request.Request, output *ListOrganizationAdminAccountsOutput)

ListOrganizationAdminAccountsRequest generates a "aws/request.Request" representing the client's request for the ListOrganizationAdminAccounts operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListOrganizationAdminAccounts for more information on using the ListOrganizationAdminAccounts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListOrganizationAdminAccountsRequest method.
req, resp := client.ListOrganizationAdminAccountsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListOrganizationAdminAccounts

func (*SecurityHub) ListOrganizationAdminAccountsWithContext

func (c *SecurityHub) ListOrganizationAdminAccountsWithContext(ctx aws.Context, input *ListOrganizationAdminAccountsInput, opts ...request.Option) (*ListOrganizationAdminAccountsOutput, error)

ListOrganizationAdminAccountsWithContext is the same as ListOrganizationAdminAccounts with the addition of the ability to pass a context and additional request options.

See ListOrganizationAdminAccounts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) ListSecurityControlDefinitions added in v1.42.9

func (c *SecurityHub) ListSecurityControlDefinitions(input *ListSecurityControlDefinitionsInput) (*ListSecurityControlDefinitionsOutput, error)

ListSecurityControlDefinitions API operation for AWS SecurityHub.

Lists all of the security controls that apply to a specified standard.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation ListSecurityControlDefinitions for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListSecurityControlDefinitions

Example (Shared00)

To list security controls that apply to a standard The following example lists security controls that apply to a specified Security Hub standard.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.ListSecurityControlDefinitionsInput{
		MaxResults:   aws.Int64(3),
		NextToken:    aws.String("NULL"),
		StandardsArn: aws.String("arn:aws:securityhub:::standards/aws-foundational-security-best-practices/v/1.0.0"),
	}

	result, err := svc.ListSecurityControlDefinitions(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) ListSecurityControlDefinitionsPages added in v1.42.9

func (c *SecurityHub) ListSecurityControlDefinitionsPages(input *ListSecurityControlDefinitionsInput, fn func(*ListSecurityControlDefinitionsOutput, bool) bool) error

ListSecurityControlDefinitionsPages iterates over the pages of a ListSecurityControlDefinitions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSecurityControlDefinitions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListSecurityControlDefinitions operation.
pageNum := 0
err := client.ListSecurityControlDefinitionsPages(params,
    func(page *securityhub.ListSecurityControlDefinitionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecurityHub) ListSecurityControlDefinitionsPagesWithContext added in v1.42.9

func (c *SecurityHub) ListSecurityControlDefinitionsPagesWithContext(ctx aws.Context, input *ListSecurityControlDefinitionsInput, fn func(*ListSecurityControlDefinitionsOutput, bool) bool, opts ...request.Option) error

ListSecurityControlDefinitionsPagesWithContext same as ListSecurityControlDefinitionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) ListSecurityControlDefinitionsRequest added in v1.42.9

func (c *SecurityHub) ListSecurityControlDefinitionsRequest(input *ListSecurityControlDefinitionsInput) (req *request.Request, output *ListSecurityControlDefinitionsOutput)

ListSecurityControlDefinitionsRequest generates a "aws/request.Request" representing the client's request for the ListSecurityControlDefinitions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSecurityControlDefinitions for more information on using the ListSecurityControlDefinitions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListSecurityControlDefinitionsRequest method.
req, resp := client.ListSecurityControlDefinitionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListSecurityControlDefinitions

func (*SecurityHub) ListSecurityControlDefinitionsWithContext added in v1.42.9

func (c *SecurityHub) ListSecurityControlDefinitionsWithContext(ctx aws.Context, input *ListSecurityControlDefinitionsInput, opts ...request.Option) (*ListSecurityControlDefinitionsOutput, error)

ListSecurityControlDefinitionsWithContext is the same as ListSecurityControlDefinitions with the addition of the ability to pass a context and additional request options.

See ListSecurityControlDefinitions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) ListStandardsControlAssociations added in v1.42.9

ListStandardsControlAssociations API operation for AWS SecurityHub.

Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation ListStandardsControlAssociations for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListStandardsControlAssociations

Example (Shared00)

To say whether standard The following example specifies whether a control is currently enabled or disabled in each enabled standard in the calling account. The response also provides other details about the control.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.ListStandardsControlAssociationsInput{
		SecurityControlId: aws.String("S3.1"),
	}

	result, err := svc.ListStandardsControlAssociations(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) ListStandardsControlAssociationsPages added in v1.42.9

func (c *SecurityHub) ListStandardsControlAssociationsPages(input *ListStandardsControlAssociationsInput, fn func(*ListStandardsControlAssociationsOutput, bool) bool) error

ListStandardsControlAssociationsPages iterates over the pages of a ListStandardsControlAssociations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListStandardsControlAssociations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListStandardsControlAssociations operation.
pageNum := 0
err := client.ListStandardsControlAssociationsPages(params,
    func(page *securityhub.ListStandardsControlAssociationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SecurityHub) ListStandardsControlAssociationsPagesWithContext added in v1.42.9

func (c *SecurityHub) ListStandardsControlAssociationsPagesWithContext(ctx aws.Context, input *ListStandardsControlAssociationsInput, fn func(*ListStandardsControlAssociationsOutput, bool) bool, opts ...request.Option) error

ListStandardsControlAssociationsPagesWithContext same as ListStandardsControlAssociationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) ListStandardsControlAssociationsRequest added in v1.42.9

func (c *SecurityHub) ListStandardsControlAssociationsRequest(input *ListStandardsControlAssociationsInput) (req *request.Request, output *ListStandardsControlAssociationsOutput)

ListStandardsControlAssociationsRequest generates a "aws/request.Request" representing the client's request for the ListStandardsControlAssociations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStandardsControlAssociations for more information on using the ListStandardsControlAssociations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListStandardsControlAssociationsRequest method.
req, resp := client.ListStandardsControlAssociationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListStandardsControlAssociations

func (*SecurityHub) ListStandardsControlAssociationsWithContext added in v1.42.9

func (c *SecurityHub) ListStandardsControlAssociationsWithContext(ctx aws.Context, input *ListStandardsControlAssociationsInput, opts ...request.Option) (*ListStandardsControlAssociationsOutput, error)

ListStandardsControlAssociationsWithContext is the same as ListStandardsControlAssociations with the addition of the ability to pass a context and additional request options.

See ListStandardsControlAssociations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) ListTagsForResource

func (c *SecurityHub) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS SecurityHub.

Returns a list of tags associated with a resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListTagsForResource

Example (Shared00)

To get a list of tags for a resource The following example returns a list of tags associated with the specified resource.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.ListTagsForResourceInput{
		ResourceArn: aws.String("arn:aws:securityhub:us-west-1:123456789012:hub/default"),
	}

	result, err := svc.ListTagsForResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) ListTagsForResourceRequest

func (c *SecurityHub) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListTagsForResource

func (*SecurityHub) ListTagsForResourceWithContext

func (c *SecurityHub) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) TagResource

func (c *SecurityHub) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS SecurityHub.

Adds one or more tags to a resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation TagResource for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/TagResource

Example (Shared00)

To tag a resource The following example adds the 'Department' and 'Area' tags to the specified resource.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.TagResourceInput{
		ResourceArn: aws.String("arn:aws:securityhub:us-west-1:123456789012:hub/default"),
		Tags: map[string]*string{
			"Area":       aws.String("USMidwest"),
			"Department": aws.String("Operations"),
		},
	}

	result, err := svc.TagResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) TagResourceRequest

func (c *SecurityHub) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/TagResource

func (*SecurityHub) TagResourceWithContext

func (c *SecurityHub) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) UntagResource

func (c *SecurityHub) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS SecurityHub.

Removes one or more tags from a resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation UntagResource for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UntagResource

Example (Shared00)

To remove tags from a resource The following example removes the 'Department' tag from the specified resource.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.UntagResourceInput{
		ResourceArn: aws.String("arn:aws:securityhub:us-west-1:123456789012:hub/default"),
		TagKeys: []*string{
			aws.String("Department"),
		},
	}

	result, err := svc.UntagResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) UntagResourceRequest

func (c *SecurityHub) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UntagResource

func (*SecurityHub) UntagResourceWithContext

func (c *SecurityHub) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) UpdateActionTarget

func (c *SecurityHub) UpdateActionTarget(input *UpdateActionTargetInput) (*UpdateActionTargetOutput, error)

UpdateActionTarget API operation for AWS SecurityHub.

Updates the name and description of a custom action target in Security Hub.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation UpdateActionTarget for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateActionTarget

Example (Shared00)

To update the name and description of a custom action target The following example updates the name and description of a custom action target in Security Hub. You can create custom actions to automatically respond to Security Hub findings using Amazon EventBridge.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.UpdateActionTargetInput{
		ActionTargetArn: aws.String("arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation"),
		Description:     aws.String("Sends specified findings to customer service chat"),
		Name:            aws.String("Chat custom action"),
	}

	result, err := svc.UpdateActionTarget(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) UpdateActionTargetRequest

func (c *SecurityHub) UpdateActionTargetRequest(input *UpdateActionTargetInput) (req *request.Request, output *UpdateActionTargetOutput)

UpdateActionTargetRequest generates a "aws/request.Request" representing the client's request for the UpdateActionTarget operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateActionTarget for more information on using the UpdateActionTarget API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateActionTargetRequest method.
req, resp := client.UpdateActionTargetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateActionTarget

func (*SecurityHub) UpdateActionTargetWithContext

func (c *SecurityHub) UpdateActionTargetWithContext(ctx aws.Context, input *UpdateActionTargetInput, opts ...request.Option) (*UpdateActionTargetOutput, error)

UpdateActionTargetWithContext is the same as UpdateActionTarget with the addition of the ability to pass a context and additional request options.

See UpdateActionTarget for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) UpdateFindingAggregator

func (c *SecurityHub) UpdateFindingAggregator(input *UpdateFindingAggregatorInput) (*UpdateFindingAggregatorOutput, error)

UpdateFindingAggregator API operation for AWS SecurityHub.

Updates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use UpdateFindingAggregator to change the aggregation Region.

You must run UpdateFindingAggregator from the current aggregation Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation UpdateFindingAggregator for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • AccessDeniedException You don't have permission to perform the action specified in the request.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateFindingAggregator

Example (Shared00)

To update cross-Region aggregation settings The following example updates the cross-Region aggregation configuration. You use this operation to change the list of linked Regions and the treatment of new Regions. However, you cannot use this operation to change the aggregation Region.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.UpdateFindingAggregatorInput{
		FindingAggregatorArn: aws.String("arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"),
		RegionLinkingMode:    aws.String("SPECIFIED_REGIONS"),
		Regions: []*string{
			aws.String("us-west-1"),
			aws.String("us-west-2"),
		},
	}

	result, err := svc.UpdateFindingAggregator(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeAccessDeniedException:
				fmt.Println(securityhub.ErrCodeAccessDeniedException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) UpdateFindingAggregatorRequest

func (c *SecurityHub) UpdateFindingAggregatorRequest(input *UpdateFindingAggregatorInput) (req *request.Request, output *UpdateFindingAggregatorOutput)

UpdateFindingAggregatorRequest generates a "aws/request.Request" representing the client's request for the UpdateFindingAggregator operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateFindingAggregator for more information on using the UpdateFindingAggregator API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateFindingAggregatorRequest method.
req, resp := client.UpdateFindingAggregatorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateFindingAggregator

func (*SecurityHub) UpdateFindingAggregatorWithContext

func (c *SecurityHub) UpdateFindingAggregatorWithContext(ctx aws.Context, input *UpdateFindingAggregatorInput, opts ...request.Option) (*UpdateFindingAggregatorOutput, error)

UpdateFindingAggregatorWithContext is the same as UpdateFindingAggregator with the addition of the ability to pass a context and additional request options.

See UpdateFindingAggregator for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) UpdateFindings

func (c *SecurityHub) UpdateFindings(input *UpdateFindingsInput) (*UpdateFindingsOutput, error)

UpdateFindings API operation for AWS SecurityHub.

UpdateFindings is deprecated. Instead of UpdateFindings, use BatchUpdateFindings.

Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation UpdateFindings for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateFindings

func (*SecurityHub) UpdateFindingsRequest

func (c *SecurityHub) UpdateFindingsRequest(input *UpdateFindingsInput) (req *request.Request, output *UpdateFindingsOutput)

UpdateFindingsRequest generates a "aws/request.Request" representing the client's request for the UpdateFindings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateFindings for more information on using the UpdateFindings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateFindingsRequest method.
req, resp := client.UpdateFindingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateFindings

func (*SecurityHub) UpdateFindingsWithContext

func (c *SecurityHub) UpdateFindingsWithContext(ctx aws.Context, input *UpdateFindingsInput, opts ...request.Option) (*UpdateFindingsOutput, error)

UpdateFindingsWithContext is the same as UpdateFindings with the addition of the ability to pass a context and additional request options.

See UpdateFindings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) UpdateInsight

func (c *SecurityHub) UpdateInsight(input *UpdateInsightInput) (*UpdateInsightOutput, error)

UpdateInsight API operation for AWS SecurityHub.

Updates the Security Hub insight identified by the specified insight ARN.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation UpdateInsight for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateInsight

Example (Shared00)

To update an insight The following example updates the specified Security Hub insight.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.UpdateInsightInput{
		Filters: &securityhub.AwsSecurityFindingFilters{
			ResourceType: []*securityhub.StringFilter{
				{
					Comparison: aws.String("EQUALS"),
					Value:      aws.String("AwsIamRole"),
				},
			},
			SeverityLabel: []*securityhub.StringFilter{
				{
					Comparison: aws.String("EQUALS"),
					Value:      aws.String("HIGH"),
				},
			},
		},
		InsightArn: aws.String("arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"),
		Name:       aws.String("High severity role findings"),
	}

	result, err := svc.UpdateInsight(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) UpdateInsightRequest

func (c *SecurityHub) UpdateInsightRequest(input *UpdateInsightInput) (req *request.Request, output *UpdateInsightOutput)

UpdateInsightRequest generates a "aws/request.Request" representing the client's request for the UpdateInsight operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateInsight for more information on using the UpdateInsight API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateInsightRequest method.
req, resp := client.UpdateInsightRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateInsight

func (*SecurityHub) UpdateInsightWithContext

func (c *SecurityHub) UpdateInsightWithContext(ctx aws.Context, input *UpdateInsightInput, opts ...request.Option) (*UpdateInsightOutput, error)

UpdateInsightWithContext is the same as UpdateInsight with the addition of the ability to pass a context and additional request options.

See UpdateInsight for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) UpdateOrganizationConfiguration

UpdateOrganizationConfiguration API operation for AWS SecurityHub.

Used to update the configuration related to Organizations. Can only be called from a Security Hub administrator account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation UpdateOrganizationConfiguration for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateOrganizationConfiguration

Example (Shared00)

To update organization configuration The following example updates the configuration for an organization so that Security Hub is automatically activated for new member accounts. Only the Security Hub administrator account can call this operation.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.UpdateOrganizationConfigurationInput{
		AutoEnable: aws.Bool(true),
	}

	result, err := svc.UpdateOrganizationConfiguration(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) UpdateOrganizationConfigurationRequest

func (c *SecurityHub) UpdateOrganizationConfigurationRequest(input *UpdateOrganizationConfigurationInput) (req *request.Request, output *UpdateOrganizationConfigurationOutput)

UpdateOrganizationConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateOrganizationConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateOrganizationConfiguration for more information on using the UpdateOrganizationConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateOrganizationConfigurationRequest method.
req, resp := client.UpdateOrganizationConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateOrganizationConfiguration

func (*SecurityHub) UpdateOrganizationConfigurationWithContext

func (c *SecurityHub) UpdateOrganizationConfigurationWithContext(ctx aws.Context, input *UpdateOrganizationConfigurationInput, opts ...request.Option) (*UpdateOrganizationConfigurationOutput, error)

UpdateOrganizationConfigurationWithContext is the same as UpdateOrganizationConfiguration with the addition of the ability to pass a context and additional request options.

See UpdateOrganizationConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) UpdateSecurityHubConfiguration

func (c *SecurityHub) UpdateSecurityHubConfiguration(input *UpdateSecurityHubConfigurationInput) (*UpdateSecurityHubConfigurationOutput, error)

UpdateSecurityHubConfiguration API operation for AWS SecurityHub.

Updates configuration options for Security Hub.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation UpdateSecurityHubConfiguration for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • LimitExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateSecurityHubConfiguration

Example (Shared00)

To update Security Hub settings The following example updates Security Hub settings to turn on consolidated control findings, and to automatically enable new controls in enabled standards.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.UpdateSecurityHubConfigurationInput{
		AutoEnableControls:      aws.Bool(true),
		ControlFindingGenerator: aws.String("SECURITY_CONTROL"),
	}

	result, err := svc.UpdateSecurityHubConfiguration(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeLimitExceededException:
				fmt.Println(securityhub.ErrCodeLimitExceededException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) UpdateSecurityHubConfigurationRequest

func (c *SecurityHub) UpdateSecurityHubConfigurationRequest(input *UpdateSecurityHubConfigurationInput) (req *request.Request, output *UpdateSecurityHubConfigurationOutput)

UpdateSecurityHubConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateSecurityHubConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateSecurityHubConfiguration for more information on using the UpdateSecurityHubConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateSecurityHubConfigurationRequest method.
req, resp := client.UpdateSecurityHubConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateSecurityHubConfiguration

func (*SecurityHub) UpdateSecurityHubConfigurationWithContext

func (c *SecurityHub) UpdateSecurityHubConfigurationWithContext(ctx aws.Context, input *UpdateSecurityHubConfigurationInput, opts ...request.Option) (*UpdateSecurityHubConfigurationOutput, error)

UpdateSecurityHubConfigurationWithContext is the same as UpdateSecurityHubConfiguration with the addition of the ability to pass a context and additional request options.

See UpdateSecurityHubConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SecurityHub) UpdateStandardsControl

func (c *SecurityHub) UpdateStandardsControl(input *UpdateStandardsControlInput) (*UpdateStandardsControlOutput, error)

UpdateStandardsControl API operation for AWS SecurityHub.

Used to control whether an individual security standard control is enabled or disabled.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SecurityHub's API operation UpdateStandardsControl for usage and error information.

Returned Error Types:

  • InternalException Internal server error.

  • InvalidInputException The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • InvalidAccessException The account doesn't have permission to perform this action.

  • ResourceNotFoundException The request was rejected because we can't find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateStandardsControl

Example (Shared00)

To update the enablement status of a standard control The following example disables the specified control in the specified security standard.

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/securityhub"
)

func main() {
	svc := securityhub.New(session.New())
	input := &securityhub.UpdateStandardsControlInput{
		ControlStatus:       aws.String("DISABLED"),
		DisabledReason:      aws.String("Not applicable to my service"),
		StandardsControlArn: aws.String("arn:aws:securityhub:us-west-1:123456789012:control/pci-dss/v/3.2.1/PCI.AutoScaling.1"),
	}

	result, err := svc.UpdateStandardsControl(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case securityhub.ErrCodeInternalException:
				fmt.Println(securityhub.ErrCodeInternalException, aerr.Error())
			case securityhub.ErrCodeInvalidInputException:
				fmt.Println(securityhub.ErrCodeInvalidInputException, aerr.Error())
			case securityhub.ErrCodeInvalidAccessException:
				fmt.Println(securityhub.ErrCodeInvalidAccessException, aerr.Error())
			case securityhub.ErrCodeResourceNotFoundException:
				fmt.Println(securityhub.ErrCodeResourceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}
Output:

func (*SecurityHub) UpdateStandardsControlRequest

func (c *SecurityHub) UpdateStandardsControlRequest(input *UpdateStandardsControlInput) (req *request.Request, output *UpdateStandardsControlOutput)

UpdateStandardsControlRequest generates a "aws/request.Request" representing the client's request for the UpdateStandardsControl operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateStandardsControl for more information on using the UpdateStandardsControl API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateStandardsControlRequest method.
req, resp := client.UpdateStandardsControlRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/UpdateStandardsControl

func (*SecurityHub) UpdateStandardsControlWithContext

func (c *SecurityHub) UpdateStandardsControlWithContext(ctx aws.Context, input *UpdateStandardsControlInput, opts ...request.Option) (*UpdateStandardsControlOutput, error)

UpdateStandardsControlWithContext is the same as UpdateStandardsControl with the addition of the ability to pass a context and additional request options.

See UpdateStandardsControl for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type SensitiveDataDetections

type SensitiveDataDetections struct {

	// The total number of occurrences of sensitive data that were detected.
	Count *int64 `type:"long"`

	// Details about the sensitive data that was detected.
	Occurrences *Occurrences `type:"structure"`

	// The type of sensitive data that was detected. For example, the type might
	// indicate that the data is an email address.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

The list of detected instances of sensitive data.

func (SensitiveDataDetections) GoString

func (s SensitiveDataDetections) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SensitiveDataDetections) SetCount

SetCount sets the Count field's value.

func (*SensitiveDataDetections) SetOccurrences

SetOccurrences sets the Occurrences field's value.

func (*SensitiveDataDetections) SetType

SetType sets the Type field's value.

func (SensitiveDataDetections) String

func (s SensitiveDataDetections) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SensitiveDataResult

type SensitiveDataResult struct {

	// The category of sensitive data that was detected. For example, the category
	// can indicate that the sensitive data involved credentials, financial information,
	// or personal information.
	Category *string `type:"string"`

	// The list of detected instances of sensitive data.
	Detections []*SensitiveDataDetections `type:"list"`

	// The total number of occurrences of sensitive data.
	TotalCount *int64 `type:"long"`
	// contains filtered or unexported fields
}

Contains a detected instance of sensitive data that are based on built-in identifiers.

func (SensitiveDataResult) GoString

func (s SensitiveDataResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SensitiveDataResult) SetCategory

func (s *SensitiveDataResult) SetCategory(v string) *SensitiveDataResult

SetCategory sets the Category field's value.

func (*SensitiveDataResult) SetDetections

SetDetections sets the Detections field's value.

func (*SensitiveDataResult) SetTotalCount

func (s *SensitiveDataResult) SetTotalCount(v int64) *SensitiveDataResult

SetTotalCount sets the TotalCount field's value.

func (SensitiveDataResult) String

func (s SensitiveDataResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Severity

type Severity struct {

	// The severity value of the finding. The allowed values are the following.
	//
	//    * INFORMATIONAL - No issue was found.
	//
	//    * LOW - The issue does not require action on its own.
	//
	//    * MEDIUM - The issue must be addressed but not urgently.
	//
	//    * HIGH - The issue must be addressed as a priority.
	//
	//    * CRITICAL - The issue must be remediated immediately to avoid it escalating.
	//
	// If you provide Normalized and do not provide Label, then Label is set automatically
	// as follows.
	//
	//    * 0 - INFORMATIONAL
	//
	//    * 1–39 - LOW
	//
	//    * 40–69 - MEDIUM
	//
	//    * 70–89 - HIGH
	//
	//    * 90–100 - CRITICAL
	Label *string `type:"string" enum:"SeverityLabel"`

	// Deprecated. The normalized severity of a finding. This attribute is being
	// deprecated. Instead of providing Normalized, provide Label.
	//
	// If you provide Label and do not provide Normalized, then Normalized is set
	// automatically as follows.
	//
	//    * INFORMATIONAL - 0
	//
	//    * LOW - 1
	//
	//    * MEDIUM - 40
	//
	//    * HIGH - 70
	//
	//    * CRITICAL - 90
	Normalized *int64 `type:"integer"`

	// The native severity from the finding product that generated the finding.
	Original *string `type:"string"`

	// Deprecated. This attribute is being deprecated. Instead of providing Product,
	// provide Original.
	//
	// The native severity as defined by the Amazon Web Services service or integrated
	// partner product that generated the finding.
	Product *float64 `type:"double"`
	// contains filtered or unexported fields
}

The severity of the finding.

The finding provider can provide the initial severity. The finding provider can only update the severity if it hasn't been updated using BatchUpdateFindings.

The finding must have either Label or Normalized populated. If only one of these attributes is populated, then Security Hub automatically populates the other one. If neither attribute is populated, then the finding is invalid. Label is the preferred attribute.

func (Severity) GoString

func (s Severity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Severity) SetLabel

func (s *Severity) SetLabel(v string) *Severity

SetLabel sets the Label field's value.

func (*Severity) SetNormalized

func (s *Severity) SetNormalized(v int64) *Severity

SetNormalized sets the Normalized field's value.

func (*Severity) SetOriginal

func (s *Severity) SetOriginal(v string) *Severity

SetOriginal sets the Original field's value.

func (*Severity) SetProduct

func (s *Severity) SetProduct(v float64) *Severity

SetProduct sets the Product field's value.

func (Severity) String

func (s Severity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SeverityUpdate

type SeverityUpdate struct {

	// The severity value of the finding. The allowed values are the following.
	//
	//    * INFORMATIONAL - No issue was found.
	//
	//    * LOW - The issue does not require action on its own.
	//
	//    * MEDIUM - The issue must be addressed but not urgently.
	//
	//    * HIGH - The issue must be addressed as a priority.
	//
	//    * CRITICAL - The issue must be remediated immediately to avoid it escalating.
	Label *string `type:"string" enum:"SeverityLabel"`

	// The normalized severity for the finding. This attribute is to be deprecated
	// in favor of Label.
	//
	// If you provide Normalized and do not provide Label, Label is set automatically
	// as follows.
	//
	//    * 0 - INFORMATIONAL
	//
	//    * 1–39 - LOW
	//
	//    * 40–69 - MEDIUM
	//
	//    * 70–89 - HIGH
	//
	//    * 90–100 - CRITICAL
	Normalized *int64 `type:"integer"`

	// The native severity as defined by the Amazon Web Services service or integrated
	// partner product that generated the finding.
	Product *float64 `type:"double"`
	// contains filtered or unexported fields
}

Updates to the severity information for a finding.

func (SeverityUpdate) GoString

func (s SeverityUpdate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SeverityUpdate) SetLabel

func (s *SeverityUpdate) SetLabel(v string) *SeverityUpdate

SetLabel sets the Label field's value.

func (*SeverityUpdate) SetNormalized

func (s *SeverityUpdate) SetNormalized(v int64) *SeverityUpdate

SetNormalized sets the Normalized field's value.

func (*SeverityUpdate) SetProduct

func (s *SeverityUpdate) SetProduct(v float64) *SeverityUpdate

SetProduct sets the Product field's value.

func (SeverityUpdate) String

func (s SeverityUpdate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SoftwarePackage

type SoftwarePackage struct {

	// The architecture used for the software package.
	Architecture *string `type:"string"`

	// The epoch of the software package.
	Epoch *string `type:"string"`

	// The file system path to the package manager inventory file.
	FilePath *string `type:"string"`

	// The version of the software package in which the vulnerability has been resolved.
	FixedInVersion *string `type:"string"`

	// The name of the software package.
	Name *string `type:"string"`

	// The source of the package.
	PackageManager *string `type:"string"`

	// The release of the software package.
	Release *string `type:"string"`

	// Describes the actions a customer can take to resolve the vulnerability in
	// the software package.
	Remediation *string `type:"string"`

	// The Amazon Resource Name (ARN) of the source layer.
	SourceLayerArn *string `type:"string"`

	// The source layer hash of the vulnerable package.
	SourceLayerHash *string `type:"string"`

	// The version of the software package.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a software package.

func (SoftwarePackage) GoString

func (s SoftwarePackage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SoftwarePackage) SetArchitecture

func (s *SoftwarePackage) SetArchitecture(v string) *SoftwarePackage

SetArchitecture sets the Architecture field's value.

func (*SoftwarePackage) SetEpoch

func (s *SoftwarePackage) SetEpoch(v string) *SoftwarePackage

SetEpoch sets the Epoch field's value.

func (*SoftwarePackage) SetFilePath

func (s *SoftwarePackage) SetFilePath(v string) *SoftwarePackage

SetFilePath sets the FilePath field's value.

func (*SoftwarePackage) SetFixedInVersion added in v1.42.9

func (s *SoftwarePackage) SetFixedInVersion(v string) *SoftwarePackage

SetFixedInVersion sets the FixedInVersion field's value.

func (*SoftwarePackage) SetName

func (s *SoftwarePackage) SetName(v string) *SoftwarePackage

SetName sets the Name field's value.

func (*SoftwarePackage) SetPackageManager

func (s *SoftwarePackage) SetPackageManager(v string) *SoftwarePackage

SetPackageManager sets the PackageManager field's value.

func (*SoftwarePackage) SetRelease

func (s *SoftwarePackage) SetRelease(v string) *SoftwarePackage

SetRelease sets the Release field's value.

func (*SoftwarePackage) SetRemediation added in v1.42.9

func (s *SoftwarePackage) SetRemediation(v string) *SoftwarePackage

SetRemediation sets the Remediation field's value.

func (*SoftwarePackage) SetSourceLayerArn added in v1.42.9

func (s *SoftwarePackage) SetSourceLayerArn(v string) *SoftwarePackage

SetSourceLayerArn sets the SourceLayerArn field's value.

func (*SoftwarePackage) SetSourceLayerHash added in v1.42.9

func (s *SoftwarePackage) SetSourceLayerHash(v string) *SoftwarePackage

SetSourceLayerHash sets the SourceLayerHash field's value.

func (*SoftwarePackage) SetVersion

func (s *SoftwarePackage) SetVersion(v string) *SoftwarePackage

SetVersion sets the Version field's value.

func (SoftwarePackage) String

func (s SoftwarePackage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SortCriterion

type SortCriterion struct {

	// The finding attribute used to sort findings.
	Field *string `type:"string"`

	// The order used to sort findings.
	SortOrder *string `type:"string" enum:"SortOrder"`
	// contains filtered or unexported fields
}

A collection of finding attributes used to sort findings.

func (SortCriterion) GoString

func (s SortCriterion) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SortCriterion) SetField

func (s *SortCriterion) SetField(v string) *SortCriterion

SetField sets the Field field's value.

func (*SortCriterion) SetSortOrder

func (s *SortCriterion) SetSortOrder(v string) *SortCriterion

SetSortOrder sets the SortOrder field's value.

func (SortCriterion) String

func (s SortCriterion) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Standard

type Standard struct {

	// A description of the standard.
	Description *string `type:"string"`

	// Whether the standard is enabled by default. When Security Hub is enabled
	// from the console, if a standard is enabled by default, the check box for
	// that standard is selected by default.
	//
	// When Security Hub is enabled using the EnableSecurityHub API operation, the
	// standard is enabled by default unless EnableDefaultStandards is set to false.
	EnabledByDefault *bool `type:"boolean"`

	// The name of the standard.
	Name *string `type:"string"`

	// The ARN of a standard.
	StandardsArn *string `type:"string"`

	// Provides details about the management of a standard.
	StandardsManagedBy *StandardsManagedBy `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about a specific security standard.

func (Standard) GoString

func (s Standard) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Standard) SetDescription

func (s *Standard) SetDescription(v string) *Standard

SetDescription sets the Description field's value.

func (*Standard) SetEnabledByDefault

func (s *Standard) SetEnabledByDefault(v bool) *Standard

SetEnabledByDefault sets the EnabledByDefault field's value.

func (*Standard) SetName

func (s *Standard) SetName(v string) *Standard

SetName sets the Name field's value.

func (*Standard) SetStandardsArn

func (s *Standard) SetStandardsArn(v string) *Standard

SetStandardsArn sets the StandardsArn field's value.

func (*Standard) SetStandardsManagedBy added in v1.42.9

func (s *Standard) SetStandardsManagedBy(v *StandardsManagedBy) *Standard

SetStandardsManagedBy sets the StandardsManagedBy field's value.

func (Standard) String

func (s Standard) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StandardsControl

type StandardsControl struct {

	// The identifier of the security standard control.
	ControlId *string `type:"string"`

	// The current status of the security standard control. Indicates whether the
	// control is enabled or disabled. Security Hub does not check against disabled
	// controls.
	ControlStatus *string `type:"string" enum:"ControlStatus"`

	// The date and time that the status of the security standard control was most
	// recently updated.
	ControlStatusUpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The longer description of the security standard control. Provides information
	// about what the control is checking for.
	Description *string `type:"string"`

	// The reason provided for the most recent change in status for the control.
	DisabledReason *string `type:"string"`

	// The list of requirements that are related to this control.
	RelatedRequirements []*string `type:"list"`

	// A link to remediation information for the control in the Security Hub user
	// documentation.
	RemediationUrl *string `type:"string"`

	// The severity of findings generated from this security standard control.
	//
	// The finding severity is based on an assessment of how easy it would be to
	// compromise Amazon Web Services resources if the issue is detected.
	SeverityRating *string `type:"string" enum:"SeverityRating"`

	// The ARN of the security standard control.
	StandardsControlArn *string `type:"string"`

	// The title of the security standard control.
	Title *string `type:"string"`
	// contains filtered or unexported fields
}

Details for an individual security standard control.

func (StandardsControl) GoString

func (s StandardsControl) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StandardsControl) SetControlId

func (s *StandardsControl) SetControlId(v string) *StandardsControl

SetControlId sets the ControlId field's value.

func (*StandardsControl) SetControlStatus

func (s *StandardsControl) SetControlStatus(v string) *StandardsControl

SetControlStatus sets the ControlStatus field's value.

func (*StandardsControl) SetControlStatusUpdatedAt

func (s *StandardsControl) SetControlStatusUpdatedAt(v time.Time) *StandardsControl

SetControlStatusUpdatedAt sets the ControlStatusUpdatedAt field's value.

func (*StandardsControl) SetDescription

func (s *StandardsControl) SetDescription(v string) *StandardsControl

SetDescription sets the Description field's value.

func (*StandardsControl) SetDisabledReason

func (s *StandardsControl) SetDisabledReason(v string) *StandardsControl

SetDisabledReason sets the DisabledReason field's value.

func (*StandardsControl) SetRelatedRequirements

func (s *StandardsControl) SetRelatedRequirements(v []*string) *StandardsControl

SetRelatedRequirements sets the RelatedRequirements field's value.

func (*StandardsControl) SetRemediationUrl

func (s *StandardsControl) SetRemediationUrl(v string) *StandardsControl

SetRemediationUrl sets the RemediationUrl field's value.

func (*StandardsControl) SetSeverityRating

func (s *StandardsControl) SetSeverityRating(v string) *StandardsControl

SetSeverityRating sets the SeverityRating field's value.

func (*StandardsControl) SetStandardsControlArn

func (s *StandardsControl) SetStandardsControlArn(v string) *StandardsControl

SetStandardsControlArn sets the StandardsControlArn field's value.

func (*StandardsControl) SetTitle

func (s *StandardsControl) SetTitle(v string) *StandardsControl

SetTitle sets the Title field's value.

func (StandardsControl) String

func (s StandardsControl) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StandardsControlAssociationDetail added in v1.42.9

type StandardsControlAssociationDetail struct {

	// Specifies whether a control is enabled or disabled in a specified standard.
	//
	// AssociationStatus is a required field
	AssociationStatus *string `type:"string" required:"true" enum:"AssociationStatus"`

	// The requirement that underlies a control in the compliance framework related
	// to the standard.
	RelatedRequirements []*string `type:"list"`

	// The ARN of a security control across standards, such as arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1.
	// This parameter doesn't mention a specific standard.
	//
	// SecurityControlArn is a required field
	SecurityControlArn *string `type:"string" required:"true"`

	// The unique identifier of a security control across standards. Values for
	// this field typically consist of an Amazon Web Service name and a number,
	// such as APIGateway.3.
	//
	// SecurityControlId is a required field
	SecurityControlId *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of a security standard.
	//
	// StandardsArn is a required field
	StandardsArn *string `type:"string" required:"true"`

	// Provides the input parameter that Security Hub uses to call the UpdateStandardsControl
	// (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_UpdateStandardsControl.html)
	// API. This API can be used to enable or disable a control in a specified standard.
	StandardsControlArns []*string `type:"list"`

	// The description of a control. This typically summarizes how Security Hub
	// evaluates the control and the conditions under which it produces a failed
	// finding. This parameter may reference a specific standard.
	StandardsControlDescription *string `type:"string"`

	// The title of a control. This field may reference a specific standard.
	StandardsControlTitle *string `type:"string"`

	// The time at which the enablement status of the control in the specified standard
	// was last updated.
	UpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The reason for updating the enablement status of a control in a specified
	// standard.
	UpdatedReason *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about a control's enablement status in a specified standard.

func (StandardsControlAssociationDetail) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StandardsControlAssociationDetail) SetAssociationStatus added in v1.42.9

SetAssociationStatus sets the AssociationStatus field's value.

func (*StandardsControlAssociationDetail) SetRelatedRequirements added in v1.42.9

SetRelatedRequirements sets the RelatedRequirements field's value.

func (*StandardsControlAssociationDetail) SetSecurityControlArn added in v1.42.9

SetSecurityControlArn sets the SecurityControlArn field's value.

func (*StandardsControlAssociationDetail) SetSecurityControlId added in v1.42.9

SetSecurityControlId sets the SecurityControlId field's value.

func (*StandardsControlAssociationDetail) SetStandardsArn added in v1.42.9

SetStandardsArn sets the StandardsArn field's value.

func (*StandardsControlAssociationDetail) SetStandardsControlArns added in v1.42.9

SetStandardsControlArns sets the StandardsControlArns field's value.

func (*StandardsControlAssociationDetail) SetStandardsControlDescription added in v1.42.9

func (s *StandardsControlAssociationDetail) SetStandardsControlDescription(v string) *StandardsControlAssociationDetail

SetStandardsControlDescription sets the StandardsControlDescription field's value.

func (*StandardsControlAssociationDetail) SetStandardsControlTitle added in v1.42.9

SetStandardsControlTitle sets the StandardsControlTitle field's value.

func (*StandardsControlAssociationDetail) SetUpdatedAt added in v1.42.9

SetUpdatedAt sets the UpdatedAt field's value.

func (*StandardsControlAssociationDetail) SetUpdatedReason added in v1.42.9

SetUpdatedReason sets the UpdatedReason field's value.

func (StandardsControlAssociationDetail) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StandardsControlAssociationId added in v1.42.9

type StandardsControlAssociationId struct {

	// The unique identifier (identified with SecurityControlId, SecurityControlArn,
	// or a mix of both parameters) of a security control across standards.
	//
	// SecurityControlId is a required field
	SecurityControlId *string `type:"string" required:"true"`

	// The ARN of a standard.
	//
	// StandardsArn is a required field
	StandardsArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

An array with one or more objects that includes a security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) and the Amazon Resource Name (ARN) of a standard. The security control ID or ARN is the same across standards.

func (StandardsControlAssociationId) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StandardsControlAssociationId) SetSecurityControlId added in v1.42.9

SetSecurityControlId sets the SecurityControlId field's value.

func (*StandardsControlAssociationId) SetStandardsArn added in v1.42.9

SetStandardsArn sets the StandardsArn field's value.

func (StandardsControlAssociationId) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StandardsControlAssociationId) Validate added in v1.42.9

func (s *StandardsControlAssociationId) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StandardsControlAssociationSummary added in v1.42.9

type StandardsControlAssociationSummary struct {

	// The enablement status of a control in a specific standard.
	//
	// AssociationStatus is a required field
	AssociationStatus *string `type:"string" required:"true" enum:"AssociationStatus"`

	// The requirement that underlies this control in the compliance framework related
	// to the standard.
	RelatedRequirements []*string `type:"list"`

	// The ARN of a control, such as arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1.
	// This parameter doesn't mention a specific standard.
	//
	// SecurityControlArn is a required field
	SecurityControlArn *string `type:"string" required:"true"`

	// A unique standard-agnostic identifier for a control. Values for this field
	// typically consist of an Amazon Web Service and a number, such as APIGateway.5.
	// This field doesn't reference a specific standard.
	//
	// SecurityControlId is a required field
	SecurityControlId *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of a standard.
	//
	// StandardsArn is a required field
	StandardsArn *string `type:"string" required:"true"`

	// The description of a control. This typically summarizes how Security Hub
	// evaluates the control and the conditions under which it produces a failed
	// finding. The parameter may reference a specific standard.
	StandardsControlDescription *string `type:"string"`

	// The title of a control.
	StandardsControlTitle *string `type:"string"`

	// The last time that a control's enablement status in a specified standard
	// was updated.
	UpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The reason for updating the control's enablement status in a specified standard.
	UpdatedReason *string `type:"string"`
	// contains filtered or unexported fields
}

An array that provides the enablement status and other details for each control that applies to each enabled standard.

func (StandardsControlAssociationSummary) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StandardsControlAssociationSummary) SetAssociationStatus added in v1.42.9

SetAssociationStatus sets the AssociationStatus field's value.

func (*StandardsControlAssociationSummary) SetRelatedRequirements added in v1.42.9

SetRelatedRequirements sets the RelatedRequirements field's value.

func (*StandardsControlAssociationSummary) SetSecurityControlArn added in v1.42.9

SetSecurityControlArn sets the SecurityControlArn field's value.

func (*StandardsControlAssociationSummary) SetSecurityControlId added in v1.42.9

SetSecurityControlId sets the SecurityControlId field's value.

func (*StandardsControlAssociationSummary) SetStandardsArn added in v1.42.9

SetStandardsArn sets the StandardsArn field's value.

func (*StandardsControlAssociationSummary) SetStandardsControlDescription added in v1.42.9

SetStandardsControlDescription sets the StandardsControlDescription field's value.

func (*StandardsControlAssociationSummary) SetStandardsControlTitle added in v1.42.9

SetStandardsControlTitle sets the StandardsControlTitle field's value.

func (*StandardsControlAssociationSummary) SetUpdatedAt added in v1.42.9

SetUpdatedAt sets the UpdatedAt field's value.

func (*StandardsControlAssociationSummary) SetUpdatedReason added in v1.42.9

SetUpdatedReason sets the UpdatedReason field's value.

func (StandardsControlAssociationSummary) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StandardsControlAssociationUpdate added in v1.42.9

type StandardsControlAssociationUpdate struct {

	// The desired enablement status of the control in the standard.
	//
	// AssociationStatus is a required field
	AssociationStatus *string `type:"string" required:"true" enum:"AssociationStatus"`

	// The unique identifier for the security control whose enablement status you
	// want to update.
	//
	// SecurityControlId is a required field
	SecurityControlId *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the standard in which you want to update
	// the control's enablement status.
	//
	// StandardsArn is a required field
	StandardsArn *string `type:"string" required:"true"`

	// The reason for updating the control's enablement status in the standard.
	UpdatedReason *string `type:"string"`
	// contains filtered or unexported fields
}

An array of requested updates to the enablement status of controls in specified standards. The objects in the array include a security control ID, the Amazon Resource Name (ARN) of the standard, the requested enablement status, and the reason for updating the enablement status.

func (StandardsControlAssociationUpdate) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StandardsControlAssociationUpdate) SetAssociationStatus added in v1.42.9

SetAssociationStatus sets the AssociationStatus field's value.

func (*StandardsControlAssociationUpdate) SetSecurityControlId added in v1.42.9

SetSecurityControlId sets the SecurityControlId field's value.

func (*StandardsControlAssociationUpdate) SetStandardsArn added in v1.42.9

SetStandardsArn sets the StandardsArn field's value.

func (*StandardsControlAssociationUpdate) SetUpdatedReason added in v1.42.9

SetUpdatedReason sets the UpdatedReason field's value.

func (StandardsControlAssociationUpdate) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StandardsControlAssociationUpdate) Validate added in v1.42.9

Validate inspects the fields of the type to determine if they are valid.

type StandardsManagedBy added in v1.42.9

type StandardsManagedBy struct {

	// An identifier for the company that manages a specific security standard.
	// For existing standards, the value is equal to Amazon Web Services.
	Company *string `type:"string"`

	// An identifier for the product that manages a specific security standard.
	// For existing standards, the value is equal to the Amazon Web Services service
	// that manages the standard.
	Product *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the management of a security standard.

func (StandardsManagedBy) GoString added in v1.42.9

func (s StandardsManagedBy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StandardsManagedBy) SetCompany added in v1.42.9

func (s *StandardsManagedBy) SetCompany(v string) *StandardsManagedBy

SetCompany sets the Company field's value.

func (*StandardsManagedBy) SetProduct added in v1.42.9

func (s *StandardsManagedBy) SetProduct(v string) *StandardsManagedBy

SetProduct sets the Product field's value.

func (StandardsManagedBy) String added in v1.42.9

func (s StandardsManagedBy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StandardsStatusReason added in v1.42.9

type StandardsStatusReason struct {

	// The reason code that represents the reason for the current status of a standard
	// subscription.
	//
	// StatusReasonCode is a required field
	StatusReasonCode *string `type:"string" required:"true" enum:"StatusReasonCode"`
	// contains filtered or unexported fields
}

The reason for the current status of a standard subscription.

func (StandardsStatusReason) GoString added in v1.42.9

func (s StandardsStatusReason) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StandardsStatusReason) SetStatusReasonCode added in v1.42.9

func (s *StandardsStatusReason) SetStatusReasonCode(v string) *StandardsStatusReason

SetStatusReasonCode sets the StatusReasonCode field's value.

func (StandardsStatusReason) String added in v1.42.9

func (s StandardsStatusReason) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StandardsSubscription

type StandardsSubscription struct {

	// The ARN of a standard.
	//
	// StandardsArn is a required field
	StandardsArn *string `type:"string" required:"true"`

	// A key-value pair of input for the standard.
	//
	// StandardsInput is a required field
	StandardsInput map[string]*string `type:"map" required:"true"`

	// The status of the standard subscription.
	//
	// The status values are as follows:
	//
	//    * PENDING - Standard is in the process of being enabled.
	//
	//    * READY - Standard is enabled.
	//
	//    * INCOMPLETE - Standard could not be enabled completely. Some controls
	//    may not be available.
	//
	//    * DELETING - Standard is in the process of being disabled.
	//
	//    * FAILED - Standard could not be disabled.
	//
	// StandardsStatus is a required field
	StandardsStatus *string `type:"string" required:"true" enum:"StandardsStatus"`

	// The reason for the current status.
	StandardsStatusReason *StandardsStatusReason `type:"structure"`

	// The ARN of a resource that represents your subscription to a supported standard.
	//
	// StandardsSubscriptionArn is a required field
	StandardsSubscriptionArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A resource that represents your subscription to a supported standard.

func (StandardsSubscription) GoString

func (s StandardsSubscription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StandardsSubscription) SetStandardsArn

func (s *StandardsSubscription) SetStandardsArn(v string) *StandardsSubscription

SetStandardsArn sets the StandardsArn field's value.

func (*StandardsSubscription) SetStandardsInput

func (s *StandardsSubscription) SetStandardsInput(v map[string]*string) *StandardsSubscription

SetStandardsInput sets the StandardsInput field's value.

func (*StandardsSubscription) SetStandardsStatus

func (s *StandardsSubscription) SetStandardsStatus(v string) *StandardsSubscription

SetStandardsStatus sets the StandardsStatus field's value.

func (*StandardsSubscription) SetStandardsStatusReason added in v1.42.9

func (s *StandardsSubscription) SetStandardsStatusReason(v *StandardsStatusReason) *StandardsSubscription

SetStandardsStatusReason sets the StandardsStatusReason field's value.

func (*StandardsSubscription) SetStandardsSubscriptionArn

func (s *StandardsSubscription) SetStandardsSubscriptionArn(v string) *StandardsSubscription

SetStandardsSubscriptionArn sets the StandardsSubscriptionArn field's value.

func (StandardsSubscription) String

func (s StandardsSubscription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StandardsSubscriptionRequest

type StandardsSubscriptionRequest struct {

	// The ARN of the standard that you want to enable. To view the list of available
	// standards and their ARNs, use the DescribeStandards operation.
	//
	// StandardsArn is a required field
	StandardsArn *string `type:"string" required:"true"`

	// A key-value pair of input for the standard.
	StandardsInput map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

The standard that you want to enable.

func (StandardsSubscriptionRequest) GoString

func (s StandardsSubscriptionRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StandardsSubscriptionRequest) SetStandardsArn

SetStandardsArn sets the StandardsArn field's value.

func (*StandardsSubscriptionRequest) SetStandardsInput

SetStandardsInput sets the StandardsInput field's value.

func (StandardsSubscriptionRequest) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StandardsSubscriptionRequest) Validate

func (s *StandardsSubscriptionRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StatelessCustomActionDefinition added in v1.42.9

type StatelessCustomActionDefinition struct {

	// Information about metrics to publish to CloudWatch.
	PublishMetricAction *StatelessCustomPublishMetricAction `type:"structure"`
	// contains filtered or unexported fields
}

The definition of a custom action that can be used for stateless packet handling.

func (StatelessCustomActionDefinition) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatelessCustomActionDefinition) SetPublishMetricAction added in v1.42.9

SetPublishMetricAction sets the PublishMetricAction field's value.

func (StatelessCustomActionDefinition) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StatelessCustomPublishMetricAction added in v1.42.9

type StatelessCustomPublishMetricAction struct {

	// Defines CloudWatch dimension values to publish.
	Dimensions []*StatelessCustomPublishMetricActionDimension `type:"list"`
	// contains filtered or unexported fields
}

Information about metrics to publish to CloudWatch.

func (StatelessCustomPublishMetricAction) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatelessCustomPublishMetricAction) SetDimensions added in v1.42.9

SetDimensions sets the Dimensions field's value.

func (StatelessCustomPublishMetricAction) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StatelessCustomPublishMetricActionDimension added in v1.42.9

type StatelessCustomPublishMetricActionDimension struct {

	// The value to use for the custom metric dimension.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Defines a CloudWatch dimension value to publish.

func (StatelessCustomPublishMetricActionDimension) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatelessCustomPublishMetricActionDimension) SetValue added in v1.42.9

SetValue sets the Value field's value.

func (StatelessCustomPublishMetricActionDimension) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StatusReason

type StatusReason struct {

	// The corresponding description for the status reason code.
	Description *string `type:"string"`

	// A code that represents a reason for the control status. For the list of status
	// reason codes and their meanings, see Standards-related information in the
	// ASFF (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-results.html#securityhub-standards-results-asff)
	// in the Security Hub User Guide.
	//
	// ReasonCode is a required field
	ReasonCode *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides additional context for the value of Compliance.Status.

func (StatusReason) GoString

func (s StatusReason) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatusReason) SetDescription

func (s *StatusReason) SetDescription(v string) *StatusReason

SetDescription sets the Description field's value.

func (*StatusReason) SetReasonCode

func (s *StatusReason) SetReasonCode(v string) *StatusReason

SetReasonCode sets the ReasonCode field's value.

func (StatusReason) String

func (s StatusReason) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatusReason) Validate

func (s *StatusReason) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StringFilter

type StringFilter struct {

	// The condition to apply to a string value when filtering Security Hub findings.
	//
	// To search for values that have the filter value, use one of the following
	// comparison operators:
	//
	//    * To search for values that include the filter value, use CONTAINS. For
	//    example, the filter Title CONTAINS CloudFront matches findings that have
	//    a Title that includes the string CloudFront.
	//
	//    * To search for values that exactly match the filter value, use EQUALS.
	//    For example, the filter AwsAccountId EQUALS 123456789012 only matches
	//    findings that have an account ID of 123456789012.
	//
	//    * To search for values that start with the filter value, use PREFIX. For
	//    example, the filter ResourceRegion PREFIX us matches findings that have
	//    a ResourceRegion that starts with us. A ResourceRegion that starts with
	//    a different value, such as af, ap, or ca, doesn't match.
	//
	// CONTAINS, EQUALS, and PREFIX filters on the same field are joined by OR.
	// A finding matches if it matches any one of those filters. For example, the
	// filters Title CONTAINS CloudFront OR Title CONTAINS CloudWatch match a finding
	// that includes either CloudFront, CloudWatch, or both strings in the title.
	//
	// To search for values that don’t have the filter value, use one of the following
	// comparison operators:
	//
	//    * To search for values that exclude the filter value, use NOT_CONTAINS.
	//    For example, the filter Title NOT_CONTAINS CloudFront matches findings
	//    that have a Title that excludes the string CloudFront.
	//
	//    * To search for values other than the filter value, use NOT_EQUALS. For
	//    example, the filter AwsAccountId NOT_EQUALS 123456789012 only matches
	//    findings that have an account ID other than 123456789012.
	//
	//    * To search for values that don't start with the filter value, use PREFIX_NOT_EQUALS.
	//    For example, the filter ResourceRegion PREFIX_NOT_EQUALS us matches findings
	//    with a ResourceRegion that starts with a value other than us.
	//
	// NOT_CONTAINS, NOT_EQUALS, and PREFIX_NOT_EQUALS filters on the same field
	// are joined by AND. A finding matches only if it matches all of those filters.
	// For example, the filters Title NOT_CONTAINS CloudFront AND Title NOT_CONTAINS
	// CloudWatch match a finding that excludes both CloudFront and CloudWatch in
	// the title.
	//
	// You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the
	// same field. Similarly, you can't provide both an EQUALS filter and a NOT_EQUALS
	// or PREFIX_NOT_EQUALS filter on the same field. Combining filters in this
	// way returns an error. CONTAINS filters can only be used with other CONTAINS
	// filters. NOT_CONTAINS filters can only be used with other NOT_CONTAINS filters.
	//
	// You can combine PREFIX filters with NOT_EQUALS or PREFIX_NOT_EQUALS filters
	// for the same field. Security Hub first processes the PREFIX filters, and
	// then the NOT_EQUALS or PREFIX_NOT_EQUALS filters.
	//
	// For example, for the following filters, Security Hub first identifies findings
	// that have resource types that start with either AwsIam or AwsEc2. It then
	// excludes findings that have a resource type of AwsIamPolicy and findings
	// that have a resource type of AwsEc2NetworkInterface.
	//
	//    * ResourceType PREFIX AwsIam
	//
	//    * ResourceType PREFIX AwsEc2
	//
	//    * ResourceType NOT_EQUALS AwsIamPolicy
	//
	//    * ResourceType NOT_EQUALS AwsEc2NetworkInterface
	//
	// CONTAINS and NOT_CONTAINS operators can be used only with automation rules.
	// For more information, see Automation rules (https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html)
	// in the Security Hub User Guide.
	Comparison *string `type:"string" enum:"StringFilterComparison"`

	// The string filter value. Filter values are case sensitive. For example, the
	// product name for control-based findings is Security Hub. If you provide security
	// hub as the filter value, there's no match.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A string filter for filtering Security Hub findings.

func (StringFilter) GoString

func (s StringFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StringFilter) SetComparison

func (s *StringFilter) SetComparison(v string) *StringFilter

SetComparison sets the Comparison field's value.

func (*StringFilter) SetValue

func (s *StringFilter) SetValue(v string) *StringFilter

SetValue sets the Value field's value.

func (StringFilter) String

func (s StringFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput

type TagResourceInput struct {

	// The ARN of the resource to apply the tags to.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"`

	// The tags to add to the resource. You can add up to 50 tags at a time. The
	// tag keys can be no longer than 128 characters. The tag values can be no longer
	// than 256 characters.
	//
	// Tags is a required field
	Tags map[string]*string `min:"1" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Threat added in v1.42.9

type Threat struct {

	// Provides information about the file paths that were affected by the threat.
	FilePaths []*FilePaths `type:"list"`

	// This total number of items in which the threat has been detected.
	ItemCount *int64 `type:"integer"`

	// The name of the threat.
	Name *string `type:"string"`

	// The severity of the threat.
	Severity *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about the threat detected in a security finding and the file paths that were affected by the threat.

func (Threat) GoString added in v1.42.9

func (s Threat) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Threat) SetFilePaths added in v1.42.9

func (s *Threat) SetFilePaths(v []*FilePaths) *Threat

SetFilePaths sets the FilePaths field's value.

func (*Threat) SetItemCount added in v1.42.9

func (s *Threat) SetItemCount(v int64) *Threat

SetItemCount sets the ItemCount field's value.

func (*Threat) SetName added in v1.42.9

func (s *Threat) SetName(v string) *Threat

SetName sets the Name field's value.

func (*Threat) SetSeverity added in v1.42.9

func (s *Threat) SetSeverity(v string) *Threat

SetSeverity sets the Severity field's value.

func (Threat) String added in v1.42.9

func (s Threat) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThreatIntelIndicator

type ThreatIntelIndicator struct {

	// The category of a threat intelligence indicator.
	Category *string `type:"string" enum:"ThreatIntelIndicatorCategory"`

	// Indicates when the most recent instance of a threat intelligence indicator
	// was observed.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	LastObservedAt *string `type:"string"`

	// The source of the threat intelligence indicator.
	Source *string `type:"string"`

	// The URL to the page or site where you can get more information about the
	// threat intelligence indicator.
	SourceUrl *string `type:"string"`

	// The type of threat intelligence indicator.
	Type *string `type:"string" enum:"ThreatIntelIndicatorType"`

	// The value of a threat intelligence indicator.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Details about the threat intelligence related to a finding.

func (ThreatIntelIndicator) GoString

func (s ThreatIntelIndicator) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThreatIntelIndicator) SetCategory

SetCategory sets the Category field's value.

func (*ThreatIntelIndicator) SetLastObservedAt

func (s *ThreatIntelIndicator) SetLastObservedAt(v string) *ThreatIntelIndicator

SetLastObservedAt sets the LastObservedAt field's value.

func (*ThreatIntelIndicator) SetSource

SetSource sets the Source field's value.

func (*ThreatIntelIndicator) SetSourceUrl

func (s *ThreatIntelIndicator) SetSourceUrl(v string) *ThreatIntelIndicator

SetSourceUrl sets the SourceUrl field's value.

func (*ThreatIntelIndicator) SetType

SetType sets the Type field's value.

func (*ThreatIntelIndicator) SetValue

SetValue sets the Value field's value.

func (ThreatIntelIndicator) String

func (s ThreatIntelIndicator) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnprocessedAutomationRule added in v1.42.9

type UnprocessedAutomationRule struct {

	// The error code associated with the unprocessed automation rule.
	ErrorCode *int64 `type:"integer"`

	// An error message describing why a request didn't process a specific rule.
	ErrorMessage *string `type:"string"`

	// The Amazon Resource Name (ARN) for the unprocessed automation rule.
	RuleArn *string `type:"string"`
	// contains filtered or unexported fields
}

A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter tells you which automation rules the request didn't process and why.

func (UnprocessedAutomationRule) GoString added in v1.42.9

func (s UnprocessedAutomationRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnprocessedAutomationRule) SetErrorCode added in v1.42.9

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedAutomationRule) SetErrorMessage added in v1.42.9

SetErrorMessage sets the ErrorMessage field's value.

func (*UnprocessedAutomationRule) SetRuleArn added in v1.42.9

SetRuleArn sets the RuleArn field's value.

func (UnprocessedAutomationRule) String added in v1.42.9

func (s UnprocessedAutomationRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnprocessedSecurityControl added in v1.42.9

type UnprocessedSecurityControl struct {

	// The error code for the unprocessed security control.
	//
	// ErrorCode is a required field
	ErrorCode *string `type:"string" required:"true" enum:"UnprocessedErrorCode"`

	// The reason why the security control was unprocessed.
	ErrorReason *string `type:"string"`

	// The control (identified with SecurityControlId, SecurityControlArn, or a
	// mix of both parameters) for which a response couldn't be returned.
	//
	// SecurityControlId is a required field
	SecurityControlId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides details about a security control for which a response couldn't be returned.

func (UnprocessedSecurityControl) GoString added in v1.42.9

func (s UnprocessedSecurityControl) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnprocessedSecurityControl) SetErrorCode added in v1.42.9

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedSecurityControl) SetErrorReason added in v1.42.9

SetErrorReason sets the ErrorReason field's value.

func (*UnprocessedSecurityControl) SetSecurityControlId added in v1.42.9

func (s *UnprocessedSecurityControl) SetSecurityControlId(v string) *UnprocessedSecurityControl

SetSecurityControlId sets the SecurityControlId field's value.

func (UnprocessedSecurityControl) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnprocessedStandardsControlAssociation added in v1.42.9

type UnprocessedStandardsControlAssociation struct {

	// The error code for the unprocessed standard and control association.
	//
	// ErrorCode is a required field
	ErrorCode *string `type:"string" required:"true" enum:"UnprocessedErrorCode"`

	// The reason why the standard and control association was unprocessed.
	ErrorReason *string `type:"string"`

	// An array with one or more objects that includes a security control (identified
	// with SecurityControlId, SecurityControlArn, or a mix of both parameters)
	// and the Amazon Resource Name (ARN) of a standard. This parameter shows the
	// specific controls for which the enablement status couldn't be retrieved in
	// specified standards when calling BatchUpdateStandardsControlAssociations
	// (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html).
	//
	// StandardsControlAssociationId is a required field
	StandardsControlAssociationId *StandardsControlAssociationId `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides details about which control's enablement status couldn't be retrieved in a specified standard when calling BatchUpdateStandardsControlAssociations (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html). This parameter also provides details about why the request was unprocessed.

func (UnprocessedStandardsControlAssociation) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnprocessedStandardsControlAssociation) SetErrorCode added in v1.42.9

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedStandardsControlAssociation) SetErrorReason added in v1.42.9

SetErrorReason sets the ErrorReason field's value.

func (*UnprocessedStandardsControlAssociation) SetStandardsControlAssociationId added in v1.42.9

SetStandardsControlAssociationId sets the StandardsControlAssociationId field's value.

func (UnprocessedStandardsControlAssociation) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnprocessedStandardsControlAssociationUpdate added in v1.42.9

type UnprocessedStandardsControlAssociationUpdate struct {

	// The error code for the unprocessed update of the control's enablement status
	// in the specified standard.
	//
	// ErrorCode is a required field
	ErrorCode *string `type:"string" required:"true" enum:"UnprocessedErrorCode"`

	// The reason why a control's enablement status in the specified standard couldn't
	// be updated.
	ErrorReason *string `type:"string"`

	// An array of control and standard associations for which an update failed
	// when calling BatchUpdateStandardsControlAssociations (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html).
	//
	// StandardsControlAssociationUpdate is a required field
	StandardsControlAssociationUpdate *StandardsControlAssociationUpdate `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides details about which control's enablement status could not be updated in a specified standard when calling the BatchUpdateStandardsControlAssociations (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html) API. This parameter also provides details about why the request was unprocessed.

func (UnprocessedStandardsControlAssociationUpdate) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnprocessedStandardsControlAssociationUpdate) SetErrorCode added in v1.42.9

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedStandardsControlAssociationUpdate) SetErrorReason added in v1.42.9

SetErrorReason sets the ErrorReason field's value.

func (*UnprocessedStandardsControlAssociationUpdate) SetStandardsControlAssociationUpdate added in v1.42.9

SetStandardsControlAssociationUpdate sets the StandardsControlAssociationUpdate field's value.

func (UnprocessedStandardsControlAssociationUpdate) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput

type UntagResourceInput struct {

	// The ARN of the resource to remove the tags from.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"`

	// The tag keys associated with the tags to remove from the resource. You can
	// remove up to 50 tags at a time.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateActionTargetInput

type UpdateActionTargetInput struct {

	// The ARN of the custom action target to update.
	//
	// ActionTargetArn is a required field
	ActionTargetArn *string `location:"uri" locationName:"ActionTargetArn" type:"string" required:"true"`

	// The updated description for the custom action target.
	Description *string `type:"string"`

	// The updated name of the custom action target.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateActionTargetInput) GoString

func (s UpdateActionTargetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateActionTargetInput) SetActionTargetArn

func (s *UpdateActionTargetInput) SetActionTargetArn(v string) *UpdateActionTargetInput

SetActionTargetArn sets the ActionTargetArn field's value.

func (*UpdateActionTargetInput) SetDescription

SetDescription sets the Description field's value.

func (*UpdateActionTargetInput) SetName

SetName sets the Name field's value.

func (UpdateActionTargetInput) String

func (s UpdateActionTargetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateActionTargetInput) Validate

func (s *UpdateActionTargetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateActionTargetOutput

type UpdateActionTargetOutput struct {
	// contains filtered or unexported fields
}

func (UpdateActionTargetOutput) GoString

func (s UpdateActionTargetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateActionTargetOutput) String

func (s UpdateActionTargetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAutomationRulesRequestItem added in v1.42.9

type UpdateAutomationRulesRequestItem struct {

	// One or more actions to update finding fields if a finding matches the conditions
	// specified in Criteria.
	Actions []*AutomationRulesAction `min:"1" type:"list"`

	// A set of ASFF finding field attributes and corresponding expected values
	// that Security Hub uses to filter findings. If a rule is enabled and a finding
	// matches the conditions specified in this parameter, Security Hub applies
	// the rule action to the finding.
	Criteria *AutomationRulesFindingFilters `type:"structure"`

	// A description of the rule.
	Description *string `type:"string"`

	// Specifies whether a rule is the last to be applied with respect to a finding
	// that matches the rule criteria. This is useful when a finding matches the
	// criteria for multiple rules, and each rule has different actions. If a rule
	// is terminal, Security Hub applies the rule action to a finding that matches
	// the rule criteria and doesn't evaluate other rules for the finding. By default,
	// a rule isn't terminal.
	IsTerminal *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) for the rule.
	//
	// RuleArn is a required field
	RuleArn *string `type:"string" required:"true"`

	// The name of the rule.
	RuleName *string `type:"string"`

	// An integer ranging from 1 to 1000 that represents the order in which the
	// rule action is applied to findings. Security Hub applies rules with lower
	// values for this parameter first.
	RuleOrder *int64 `min:"1" type:"integer"`

	// Whether the rule is active after it is created. If this parameter is equal
	// to ENABLED, Security Hub starts applying the rule to findings and finding
	// updates after the rule is created. To change the value of this parameter
	// after creating a rule, use BatchUpdateAutomationRules (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html).
	RuleStatus *string `type:"string" enum:"RuleStatus"`
	// contains filtered or unexported fields
}

Specifies the parameters to update in an existing automation rule.

func (UpdateAutomationRulesRequestItem) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAutomationRulesRequestItem) SetActions added in v1.42.9

SetActions sets the Actions field's value.

func (*UpdateAutomationRulesRequestItem) SetCriteria added in v1.42.9

SetCriteria sets the Criteria field's value.

func (*UpdateAutomationRulesRequestItem) SetDescription added in v1.42.9

SetDescription sets the Description field's value.

func (*UpdateAutomationRulesRequestItem) SetIsTerminal added in v1.42.9

SetIsTerminal sets the IsTerminal field's value.

func (*UpdateAutomationRulesRequestItem) SetRuleArn added in v1.42.9

SetRuleArn sets the RuleArn field's value.

func (*UpdateAutomationRulesRequestItem) SetRuleName added in v1.42.9

SetRuleName sets the RuleName field's value.

func (*UpdateAutomationRulesRequestItem) SetRuleOrder added in v1.42.9

SetRuleOrder sets the RuleOrder field's value.

func (*UpdateAutomationRulesRequestItem) SetRuleStatus added in v1.42.9

SetRuleStatus sets the RuleStatus field's value.

func (UpdateAutomationRulesRequestItem) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAutomationRulesRequestItem) Validate added in v1.42.9

Validate inspects the fields of the type to determine if they are valid.

type UpdateFindingAggregatorInput

type UpdateFindingAggregatorInput struct {

	// The ARN of the finding aggregator. To obtain the ARN, use ListFindingAggregators.
	//
	// FindingAggregatorArn is a required field
	FindingAggregatorArn *string `type:"string" required:"true"`

	// Indicates whether to aggregate findings from all of the available Regions
	// in the current partition. Also determines whether to automatically aggregate
	// findings from new Regions as Security Hub supports them and you opt into
	// them.
	//
	// The selected option also determines how to use the Regions provided in the
	// Regions list.
	//
	// The options are as follows:
	//
	//    * ALL_REGIONS - Indicates to aggregate findings from all of the Regions
	//    where Security Hub is enabled. When you choose this option, Security Hub
	//    also automatically aggregates findings from new Regions as Security Hub
	//    supports them and you opt into them.
	//
	//    * ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from
	//    all of the Regions where Security Hub is enabled, except for the Regions
	//    listed in the Regions parameter. When you choose this option, Security
	//    Hub also automatically aggregates findings from new Regions as Security
	//    Hub supports them and you opt into them.
	//
	//    * SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions
	//    listed in the Regions parameter. Security Hub does not automatically aggregate
	//    findings from new Regions.
	//
	// RegionLinkingMode is a required field
	RegionLinkingMode *string `type:"string" required:"true"`

	// If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated
	// list of Regions that do not aggregate findings to the aggregation Region.
	//
	// If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated
	// list of Regions that do aggregate findings to the aggregation Region.
	Regions []*string `type:"list"`
	// contains filtered or unexported fields
}

func (UpdateFindingAggregatorInput) GoString

func (s UpdateFindingAggregatorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFindingAggregatorInput) SetFindingAggregatorArn

func (s *UpdateFindingAggregatorInput) SetFindingAggregatorArn(v string) *UpdateFindingAggregatorInput

SetFindingAggregatorArn sets the FindingAggregatorArn field's value.

func (*UpdateFindingAggregatorInput) SetRegionLinkingMode

SetRegionLinkingMode sets the RegionLinkingMode field's value.

func (*UpdateFindingAggregatorInput) SetRegions

SetRegions sets the Regions field's value.

func (UpdateFindingAggregatorInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFindingAggregatorInput) Validate

func (s *UpdateFindingAggregatorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFindingAggregatorOutput

type UpdateFindingAggregatorOutput struct {

	// The aggregation Region.
	FindingAggregationRegion *string `type:"string"`

	// The ARN of the finding aggregator.
	FindingAggregatorArn *string `type:"string"`

	// Indicates whether to link all Regions, all Regions except for a list of excluded
	// Regions, or a list of included Regions.
	RegionLinkingMode *string `type:"string"`

	// The list of excluded Regions or included Regions.
	Regions []*string `type:"list"`
	// contains filtered or unexported fields
}

func (UpdateFindingAggregatorOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFindingAggregatorOutput) SetFindingAggregationRegion

func (s *UpdateFindingAggregatorOutput) SetFindingAggregationRegion(v string) *UpdateFindingAggregatorOutput

SetFindingAggregationRegion sets the FindingAggregationRegion field's value.

func (*UpdateFindingAggregatorOutput) SetFindingAggregatorArn

SetFindingAggregatorArn sets the FindingAggregatorArn field's value.

func (*UpdateFindingAggregatorOutput) SetRegionLinkingMode

SetRegionLinkingMode sets the RegionLinkingMode field's value.

func (*UpdateFindingAggregatorOutput) SetRegions

SetRegions sets the Regions field's value.

func (UpdateFindingAggregatorOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateFindingsInput

type UpdateFindingsInput struct {

	// A collection of attributes that specify which findings you want to update.
	//
	// Filters is a required field
	Filters *AwsSecurityFindingFilters `type:"structure" required:"true"`

	// The updated note for the finding.
	Note *NoteUpdate `type:"structure"`

	// The updated record state for the finding.
	RecordState *string `type:"string" enum:"RecordState"`
	// contains filtered or unexported fields
}

func (UpdateFindingsInput) GoString

func (s UpdateFindingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFindingsInput) SetFilters

SetFilters sets the Filters field's value.

func (*UpdateFindingsInput) SetNote

SetNote sets the Note field's value.

func (*UpdateFindingsInput) SetRecordState

func (s *UpdateFindingsInput) SetRecordState(v string) *UpdateFindingsInput

SetRecordState sets the RecordState field's value.

func (UpdateFindingsInput) String

func (s UpdateFindingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFindingsInput) Validate

func (s *UpdateFindingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFindingsOutput

type UpdateFindingsOutput struct {
	// contains filtered or unexported fields
}

func (UpdateFindingsOutput) GoString

func (s UpdateFindingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateFindingsOutput) String

func (s UpdateFindingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateInsightInput

type UpdateInsightInput struct {

	// The updated filters that define this insight.
	Filters *AwsSecurityFindingFilters `type:"structure"`

	// The updated GroupBy attribute that defines this insight.
	GroupByAttribute *string `type:"string"`

	// The ARN of the insight that you want to update.
	//
	// InsightArn is a required field
	InsightArn *string `location:"uri" locationName:"InsightArn" type:"string" required:"true"`

	// The updated name for the insight.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateInsightInput) GoString

func (s UpdateInsightInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateInsightInput) SetFilters

SetFilters sets the Filters field's value.

func (*UpdateInsightInput) SetGroupByAttribute

func (s *UpdateInsightInput) SetGroupByAttribute(v string) *UpdateInsightInput

SetGroupByAttribute sets the GroupByAttribute field's value.

func (*UpdateInsightInput) SetInsightArn

func (s *UpdateInsightInput) SetInsightArn(v string) *UpdateInsightInput

SetInsightArn sets the InsightArn field's value.

func (*UpdateInsightInput) SetName

SetName sets the Name field's value.

func (UpdateInsightInput) String

func (s UpdateInsightInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateInsightInput) Validate

func (s *UpdateInsightInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateInsightOutput

type UpdateInsightOutput struct {
	// contains filtered or unexported fields
}

func (UpdateInsightOutput) GoString

func (s UpdateInsightOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateInsightOutput) String

func (s UpdateInsightOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateOrganizationConfigurationInput

type UpdateOrganizationConfigurationInput struct {

	// Whether to automatically enable Security Hub for new accounts in the organization.
	//
	// By default, this is false, and new accounts are not added automatically.
	//
	// To automatically enable Security Hub for new accounts, set this to true.
	//
	// AutoEnable is a required field
	AutoEnable *bool `type:"boolean" required:"true"`

	// Whether to automatically enable Security Hub default standards (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-enable-disable.html)
	// for new member accounts in the organization.
	//
	// By default, this parameter is equal to DEFAULT, and new member accounts are
	// automatically enabled with default Security Hub standards.
	//
	// To opt out of enabling default standards for new member accounts, set this
	// parameter equal to NONE.
	AutoEnableStandards *string `type:"string" enum:"AutoEnableStandards"`
	// contains filtered or unexported fields
}

func (UpdateOrganizationConfigurationInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateOrganizationConfigurationInput) SetAutoEnable

SetAutoEnable sets the AutoEnable field's value.

func (*UpdateOrganizationConfigurationInput) SetAutoEnableStandards added in v1.42.9

SetAutoEnableStandards sets the AutoEnableStandards field's value.

func (UpdateOrganizationConfigurationInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateOrganizationConfigurationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type UpdateOrganizationConfigurationOutput

type UpdateOrganizationConfigurationOutput struct {
	// contains filtered or unexported fields
}

func (UpdateOrganizationConfigurationOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateOrganizationConfigurationOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateSecurityHubConfigurationInput

type UpdateSecurityHubConfigurationInput struct {

	// Whether to automatically enable new controls when they are added to standards
	// that are enabled.
	//
	// By default, this is set to true, and new controls are enabled automatically.
	// To not automatically enable new controls, set this to false.
	AutoEnableControls *bool `type:"boolean"`

	// Updates whether the calling account has consolidated control findings turned
	// on. If the value for this field is set to SECURITY_CONTROL, Security Hub
	// generates a single finding for a control check even when the check applies
	// to multiple enabled standards.
	//
	// If the value for this field is set to STANDARD_CONTROL, Security Hub generates
	// separate findings for a control check when the check applies to multiple
	// enabled standards.
	//
	// For accounts that are part of an organization, this value can only be updated
	// in the administrator account.
	ControlFindingGenerator *string `type:"string" enum:"ControlFindingGenerator"`
	// contains filtered or unexported fields
}

func (UpdateSecurityHubConfigurationInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSecurityHubConfigurationInput) SetAutoEnableControls

SetAutoEnableControls sets the AutoEnableControls field's value.

func (*UpdateSecurityHubConfigurationInput) SetControlFindingGenerator added in v1.42.9

SetControlFindingGenerator sets the ControlFindingGenerator field's value.

func (UpdateSecurityHubConfigurationInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateSecurityHubConfigurationOutput

type UpdateSecurityHubConfigurationOutput struct {
	// contains filtered or unexported fields
}

func (UpdateSecurityHubConfigurationOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateSecurityHubConfigurationOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateStandardsControlInput

type UpdateStandardsControlInput struct {

	// The updated status of the security standard control.
	ControlStatus *string `type:"string" enum:"ControlStatus"`

	// A description of the reason why you are disabling a security standard control.
	// If you are disabling a control, then this is required.
	DisabledReason *string `type:"string"`

	// The ARN of the security standard control to enable or disable.
	//
	// StandardsControlArn is a required field
	StandardsControlArn *string `location:"uri" locationName:"StandardsControlArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateStandardsControlInput) GoString

func (s UpdateStandardsControlInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStandardsControlInput) SetControlStatus

SetControlStatus sets the ControlStatus field's value.

func (*UpdateStandardsControlInput) SetDisabledReason

SetDisabledReason sets the DisabledReason field's value.

func (*UpdateStandardsControlInput) SetStandardsControlArn

func (s *UpdateStandardsControlInput) SetStandardsControlArn(v string) *UpdateStandardsControlInput

SetStandardsControlArn sets the StandardsControlArn field's value.

func (UpdateStandardsControlInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStandardsControlInput) Validate

func (s *UpdateStandardsControlInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateStandardsControlOutput

type UpdateStandardsControlOutput struct {
	// contains filtered or unexported fields
}

func (UpdateStandardsControlOutput) GoString

func (s UpdateStandardsControlOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateStandardsControlOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VolumeMount added in v1.42.9

type VolumeMount struct {

	// The path in the container at which the volume should be mounted.
	MountPath *string `type:"string"`

	// The name of the volume.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the mounting of a volume in a container.

func (VolumeMount) GoString added in v1.42.9

func (s VolumeMount) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VolumeMount) SetMountPath added in v1.42.9

func (s *VolumeMount) SetMountPath(v string) *VolumeMount

SetMountPath sets the MountPath field's value.

func (*VolumeMount) SetName added in v1.42.9

func (s *VolumeMount) SetName(v string) *VolumeMount

SetName sets the Name field's value.

func (VolumeMount) String added in v1.42.9

func (s VolumeMount) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VpcInfoCidrBlockSetDetails added in v1.42.9

type VpcInfoCidrBlockSetDetails struct {

	// The IPv4 CIDR block for the VPC.
	CidrBlock *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the IPv4 CIDR blocks for the VPC.

func (VpcInfoCidrBlockSetDetails) GoString added in v1.42.9

func (s VpcInfoCidrBlockSetDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VpcInfoCidrBlockSetDetails) SetCidrBlock added in v1.42.9

SetCidrBlock sets the CidrBlock field's value.

func (VpcInfoCidrBlockSetDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VpcInfoIpv6CidrBlockSetDetails added in v1.42.9

type VpcInfoIpv6CidrBlockSetDetails struct {

	// The IPv6 CIDR block for the VPC.
	Ipv6CidrBlock *string `type:"string"`
	// contains filtered or unexported fields
}

Provides details about the IPv6 CIDR blocks for the VPC.

func (VpcInfoIpv6CidrBlockSetDetails) GoString added in v1.42.9

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VpcInfoIpv6CidrBlockSetDetails) SetIpv6CidrBlock added in v1.42.9

SetIpv6CidrBlock sets the Ipv6CidrBlock field's value.

func (VpcInfoIpv6CidrBlockSetDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VpcInfoPeeringOptionsDetails added in v1.42.9

type VpcInfoPeeringOptionsDetails struct {

	// Indicates whether a local VPC can resolve public DNS hostnames to private
	// IP addresses when queried from instances in a peer VPC.
	AllowDnsResolutionFromRemoteVpc *bool `type:"boolean"`

	// Indicates whether a local ClassicLink connection can communicate with the
	// peer VPC over the VPC peering connection.
	AllowEgressFromLocalClassicLinkToRemoteVpc *bool `type:"boolean"`

	// Indicates whether a local VPC can communicate with a ClassicLink connection
	// in the peer VPC over the VPC peering connection.
	AllowEgressFromLocalVpcToRemoteClassicLink *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Provides information about the VPC peering connection options for the accepter or requester VPC.

func (VpcInfoPeeringOptionsDetails) GoString added in v1.42.9

func (s VpcInfoPeeringOptionsDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VpcInfoPeeringOptionsDetails) SetAllowDnsResolutionFromRemoteVpc added in v1.42.9

func (s *VpcInfoPeeringOptionsDetails) SetAllowDnsResolutionFromRemoteVpc(v bool) *VpcInfoPeeringOptionsDetails

SetAllowDnsResolutionFromRemoteVpc sets the AllowDnsResolutionFromRemoteVpc field's value.

func (*VpcInfoPeeringOptionsDetails) SetAllowEgressFromLocalClassicLinkToRemoteVpc added in v1.42.9

func (s *VpcInfoPeeringOptionsDetails) SetAllowEgressFromLocalClassicLinkToRemoteVpc(v bool) *VpcInfoPeeringOptionsDetails

SetAllowEgressFromLocalClassicLinkToRemoteVpc sets the AllowEgressFromLocalClassicLinkToRemoteVpc field's value.

func (s *VpcInfoPeeringOptionsDetails) SetAllowEgressFromLocalVpcToRemoteClassicLink(v bool) *VpcInfoPeeringOptionsDetails

SetAllowEgressFromLocalVpcToRemoteClassicLink sets the AllowEgressFromLocalVpcToRemoteClassicLink field's value.

func (VpcInfoPeeringOptionsDetails) String added in v1.42.9

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Vulnerability

type Vulnerability struct {

	// CVSS scores from the advisory related to the vulnerability.
	Cvss []*Cvss `type:"list"`

	// Specifies if all vulnerable packages in a finding have a value for FixedInVersion
	// and Remediation. This field is evaluated for each vulnerability Id based
	// on the number of vulnerable packages that have a value for both FixedInVersion
	// and Remediation. Valid values are as follows:
	//
	//    * YES if all vulnerable packages have a value for both FixedInVersion
	//    and Remediation
	//
	//    * NO if no vulnerable packages have a value for FixedInVersion and Remediation
	//
	//    * PARTIAL otherwise
	FixAvailable *string `type:"string" enum:"VulnerabilityFixAvailable"`

	// The identifier of the vulnerability.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// A list of URLs that provide additional information about the vulnerability.
	ReferenceUrls []*string `type:"list"`

	// List of vulnerabilities that are related to this vulnerability.
	RelatedVulnerabilities []*string `type:"list"`

	// Information about the vendor that generates the vulnerability report.
	Vendor *VulnerabilityVendor `type:"structure"`

	// List of software packages that have the vulnerability.
	VulnerablePackages []*SoftwarePackage `type:"list"`
	// contains filtered or unexported fields
}

A vulnerability associated with a finding.

func (Vulnerability) GoString

func (s Vulnerability) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Vulnerability) SetCvss

func (s *Vulnerability) SetCvss(v []*Cvss) *Vulnerability

SetCvss sets the Cvss field's value.

func (*Vulnerability) SetFixAvailable added in v1.42.9

func (s *Vulnerability) SetFixAvailable(v string) *Vulnerability

SetFixAvailable sets the FixAvailable field's value.

func (*Vulnerability) SetId

func (s *Vulnerability) SetId(v string) *Vulnerability

SetId sets the Id field's value.

func (*Vulnerability) SetReferenceUrls

func (s *Vulnerability) SetReferenceUrls(v []*string) *Vulnerability

SetReferenceUrls sets the ReferenceUrls field's value.

func (*Vulnerability) SetRelatedVulnerabilities

func (s *Vulnerability) SetRelatedVulnerabilities(v []*string) *Vulnerability

SetRelatedVulnerabilities sets the RelatedVulnerabilities field's value.

func (*Vulnerability) SetVendor

SetVendor sets the Vendor field's value.

func (*Vulnerability) SetVulnerablePackages

func (s *Vulnerability) SetVulnerablePackages(v []*SoftwarePackage) *Vulnerability

SetVulnerablePackages sets the VulnerablePackages field's value.

func (Vulnerability) String

func (s Vulnerability) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Vulnerability) Validate

func (s *Vulnerability) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type VulnerabilityVendor

type VulnerabilityVendor struct {

	// The name of the vendor.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The URL of the vulnerability advisory.
	Url *string `type:"string"`

	// Indicates when the vulnerability advisory was created.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	VendorCreatedAt *string `type:"string"`

	// The severity that the vendor assigned to the vulnerability.
	VendorSeverity *string `type:"string"`

	// Indicates when the vulnerability advisory was last updated.
	//
	// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
	// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
	// contain spaces, and date and time should be separated by T. For example,
	// 2020-03-22T13:22:13.933Z.
	VendorUpdatedAt *string `type:"string"`
	// contains filtered or unexported fields
}

A vendor that generates a vulnerability report.

func (VulnerabilityVendor) GoString

func (s VulnerabilityVendor) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VulnerabilityVendor) SetName

SetName sets the Name field's value.

func (*VulnerabilityVendor) SetUrl

SetUrl sets the Url field's value.

func (*VulnerabilityVendor) SetVendorCreatedAt

func (s *VulnerabilityVendor) SetVendorCreatedAt(v string) *VulnerabilityVendor

SetVendorCreatedAt sets the VendorCreatedAt field's value.

func (*VulnerabilityVendor) SetVendorSeverity

func (s *VulnerabilityVendor) SetVendorSeverity(v string) *VulnerabilityVendor

SetVendorSeverity sets the VendorSeverity field's value.

func (*VulnerabilityVendor) SetVendorUpdatedAt

func (s *VulnerabilityVendor) SetVendorUpdatedAt(v string) *VulnerabilityVendor

SetVendorUpdatedAt sets the VendorUpdatedAt field's value.

func (VulnerabilityVendor) String

func (s VulnerabilityVendor) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VulnerabilityVendor) Validate

func (s *VulnerabilityVendor) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WafAction

type WafAction struct {

	// Specifies how you want WAF to respond to requests that match the settings
	// in a rule.
	//
	// Valid settings include the following:
	//
	//    * ALLOW - WAF allows requests
	//
	//    * BLOCK - WAF blocks requests
	//
	//    * COUNT - WAF increments a counter of the requests that match all of the
	//    conditions in the rule. WAF then continues to inspect the web request
	//    based on the remaining rules in the web ACL. You can't specify COUNT for
	//    the default action for a web ACL.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Details about the action that CloudFront or WAF takes when a web request matches the conditions in the rule.

func (WafAction) GoString

func (s WafAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WafAction) SetType

func (s *WafAction) SetType(v string) *WafAction

SetType sets the Type field's value.

func (WafAction) String

func (s WafAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WafExcludedRule

type WafExcludedRule struct {

	// The unique identifier for the rule to exclude from the rule group.
	RuleId *string `type:"string"`
	// contains filtered or unexported fields
}

Details about a rule to exclude from a rule group.

func (WafExcludedRule) GoString

func (s WafExcludedRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WafExcludedRule) SetRuleId

func (s *WafExcludedRule) SetRuleId(v string) *WafExcludedRule

SetRuleId sets the RuleId field's value.

func (WafExcludedRule) String

func (s WafExcludedRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WafOverrideAction

type WafOverrideAction struct {

	// COUNT overrides the action specified by the individual rule within a RuleGroup .
	//
	// If set to NONE, the rule's action takes place.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Details about an override action for a rule.

func (WafOverrideAction) GoString

func (s WafOverrideAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WafOverrideAction) SetType

SetType sets the Type field's value.

func (WafOverrideAction) String

func (s WafOverrideAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Workflow

type Workflow struct {

	// The status of the investigation into the finding. The workflow status is
	// specific to an individual finding. It does not affect the generation of new
	// findings. For example, setting the workflow status to SUPPRESSED or RESOLVED
	// does not prevent a new finding for the same issue.
	//
	// The allowed values are the following.
	//
	//    * NEW - The initial state of a finding, before it is reviewed. Security
	//    Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in
	//    the following cases: RecordState changes from ARCHIVED to ACTIVE. ComplianceStatus
	//    changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.
	//
	//    * NOTIFIED - Indicates that you notified the resource owner about the
	//    security issue. Used when the initial reviewer is not the resource owner,
	//    and needs intervention from the resource owner.
	//
	//    * SUPPRESSED - Indicates that you reviewed the finding and do not believe
	//    that any action is needed. The finding is no longer updated.
	//
	//    * RESOLVED - The finding was reviewed and remediated and is now considered
	//    resolved.
	Status *string `type:"string" enum:"WorkflowStatus"`
	// contains filtered or unexported fields
}

Provides information about the status of the investigation into a finding.

func (Workflow) GoString

func (s Workflow) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Workflow) SetStatus

func (s *Workflow) SetStatus(v string) *Workflow

SetStatus sets the Status field's value.

func (Workflow) String

func (s Workflow) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkflowUpdate

type WorkflowUpdate struct {

	// The status of the investigation into the finding. The workflow status is
	// specific to an individual finding. It does not affect the generation of new
	// findings. For example, setting the workflow status to SUPPRESSED or RESOLVED
	// does not prevent a new finding for the same issue.
	//
	// The allowed values are the following.
	//
	//    * NEW - The initial state of a finding, before it is reviewed. Security
	//    Hub also resets WorkFlowStatus from NOTIFIED or RESOLVED to NEW in the
	//    following cases: The record state changes from ARCHIVED to ACTIVE. The
	//    compliance status changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.
	//
	//    * NOTIFIED - Indicates that you notified the resource owner about the
	//    security issue. Used when the initial reviewer is not the resource owner,
	//    and needs intervention from the resource owner.
	//
	//    * RESOLVED - The finding was reviewed and remediated and is now considered
	//    resolved.
	//
	//    * SUPPRESSED - Indicates that you reviewed the finding and do not believe
	//    that any action is needed. The finding is no longer updated.
	Status *string `type:"string" enum:"WorkflowStatus"`
	// contains filtered or unexported fields
}

Used to update information about the investigation into the finding.

func (WorkflowUpdate) GoString

func (s WorkflowUpdate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkflowUpdate) SetStatus

func (s *WorkflowUpdate) SetStatus(v string) *WorkflowUpdate

SetStatus sets the Status field's value.

func (WorkflowUpdate) String

func (s WorkflowUpdate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package securityhubiface provides an interface to enable mocking the AWS SecurityHub service client for testing your code.
Package securityhubiface provides an interface to enable mocking the AWS SecurityHub service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL